Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

getRollout

Gets details of a single Rollout.

Using getRollout

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRollout(args: GetRolloutArgs, opts?: InvokeOptions): Promise<GetRolloutResult>
function getRolloutOutput(args: GetRolloutOutputArgs, opts?: InvokeOptions): Output<GetRolloutResult>

def get_rollout(delivery_pipeline_id: Optional[str] = None,
                location: Optional[str] = None,
                project: Optional[str] = None,
                release_id: Optional[str] = None,
                rollout_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetRolloutResult
def get_rollout_output(delivery_pipeline_id: Optional[pulumi.Input[str]] = None,
                location: Optional[pulumi.Input[str]] = None,
                project: Optional[pulumi.Input[str]] = None,
                release_id: Optional[pulumi.Input[str]] = None,
                rollout_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetRolloutResult]

func LookupRollout(ctx *Context, args *LookupRolloutArgs, opts ...InvokeOption) (*LookupRolloutResult, error)
func LookupRolloutOutput(ctx *Context, args *LookupRolloutOutputArgs, opts ...InvokeOption) LookupRolloutResultOutput

> Note: This function is named LookupRollout in the Go SDK.

public static class GetRollout 
{
    public static Task<GetRolloutResult> InvokeAsync(GetRolloutArgs args, InvokeOptions? opts = null)
    public static Output<GetRolloutResult> Invoke(GetRolloutInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetRolloutResult> getRollout(GetRolloutArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:clouddeploy/v1:getRollout
  arguments:
    # arguments dictionary

The following arguments are supported:

DeliveryPipelineId string
Location string
ReleaseId string
RolloutId string
Project string

DeliveryPipelineId string
Location string
ReleaseId string
RolloutId string
Project string

deliveryPipelineId String
location String
releaseId String
rolloutId String
project String

deliveryPipelineId string
location string
releaseId string
rolloutId string
project string

delivery_pipeline_id str
location str
release_id str
rollout_id str
project str

deliveryPipelineId String
location String
releaseId String
rolloutId String
project String

getRollout Result

The following output properties are available:

Annotations Dictionary<string, string>: User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
ApprovalState string: Approval state of the Rollout.
ApproveTime string: Time at which the Rollout was approved.
CreateTime string: Time at which the Rollout was created.
DeployEndTime string: Time at which the Rollout finished deploying.
DeployFailureCause string: The reason this rollout failed. This will always be unspecified while the rollout is in progress.
DeployStartTime string: Time at which the Rollout started deploying.
DeployingBuild string: The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}.
Description string: Description of the Rollout for user purposes. Max length is 255 characters.
EnqueueTime string: Time at which the Rollout was enqueued.
Etag string: This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
FailureReason string: Additional information about the rollout failure, if available.
Labels Dictionary<string, string>: Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
Metadata Pulumi.GoogleNative.CloudDeploy.V1.Outputs.MetadataResponse: Metadata contains information about the rollout.
Name string: Optional. Name of the Rollout. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
Phases List<Pulumi.GoogleNative.CloudDeploy.V1.Outputs.PhaseResponse>: The phases that represent the workflows of this Rollout.
State string: Current state of the Rollout.
TargetId string: The ID of Target to which this Rollout is deploying.
Uid string: Unique identifier of the Rollout.

Annotations map[string]string: User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
ApprovalState string: Approval state of the Rollout.
ApproveTime string: Time at which the Rollout was approved.
CreateTime string: Time at which the Rollout was created.
DeployEndTime string: Time at which the Rollout finished deploying.
DeployFailureCause string: The reason this rollout failed. This will always be unspecified while the rollout is in progress.
DeployStartTime string: Time at which the Rollout started deploying.
DeployingBuild string: The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}.
Description string: Description of the Rollout for user purposes. Max length is 255 characters.
EnqueueTime string: Time at which the Rollout was enqueued.
Etag string: This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
FailureReason string: Additional information about the rollout failure, if available.
Labels map[string]string: Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
Metadata MetadataResponse: Metadata contains information about the rollout.
Name string: Optional. Name of the Rollout. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
Phases []PhaseResponse: The phases that represent the workflows of this Rollout.
State string: Current state of the Rollout.
TargetId string: The ID of Target to which this Rollout is deploying.
Uid string: Unique identifier of the Rollout.

annotations Map<String,String>: User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
approvalState String: Approval state of the Rollout.
approveTime String: Time at which the Rollout was approved.
createTime String: Time at which the Rollout was created.
deployEndTime String: Time at which the Rollout finished deploying.
deployFailureCause String: The reason this rollout failed. This will always be unspecified while the rollout is in progress.
deployStartTime String: Time at which the Rollout started deploying.
deployingBuild String: The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}.
description String: Description of the Rollout for user purposes. Max length is 255 characters.
enqueueTime String: Time at which the Rollout was enqueued.
etag String: This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
failureReason String: Additional information about the rollout failure, if available.
labels Map<String,String>: Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
metadata MetadataResponse: Metadata contains information about the rollout.
name String: Optional. Name of the Rollout. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
phases List<PhaseResponse>: The phases that represent the workflows of this Rollout.
state String: Current state of the Rollout.
targetId String: The ID of Target to which this Rollout is deploying.
uid String: Unique identifier of the Rollout.

annotations {[key: string]: string}: User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
approvalState string: Approval state of the Rollout.
approveTime string: Time at which the Rollout was approved.
createTime string: Time at which the Rollout was created.
deployEndTime string: Time at which the Rollout finished deploying.
deployFailureCause string: The reason this rollout failed. This will always be unspecified while the rollout is in progress.
deployStartTime string: Time at which the Rollout started deploying.
deployingBuild string: The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}.
description string: Description of the Rollout for user purposes. Max length is 255 characters.
enqueueTime string: Time at which the Rollout was enqueued.
etag string: This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
failureReason string: Additional information about the rollout failure, if available.
labels {[key: string]: string}: Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
metadata MetadataResponse: Metadata contains information about the rollout.
name string: Optional. Name of the Rollout. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
phases PhaseResponse[]: The phases that represent the workflows of this Rollout.
state string: Current state of the Rollout.
targetId string: The ID of Target to which this Rollout is deploying.
uid string: Unique identifier of the Rollout.

annotations Mapping[str, str]: User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
approval_state str: Approval state of the Rollout.
approve_time str: Time at which the Rollout was approved.
create_time str: Time at which the Rollout was created.
deploy_end_time str: Time at which the Rollout finished deploying.
deploy_failure_cause str: The reason this rollout failed. This will always be unspecified while the rollout is in progress.
deploy_start_time str: Time at which the Rollout started deploying.
deploying_build str: The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}.
description str: Description of the Rollout for user purposes. Max length is 255 characters.
enqueue_time str: Time at which the Rollout was enqueued.
etag str: This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
failure_reason str: Additional information about the rollout failure, if available.
labels Mapping[str, str]: Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
metadata MetadataResponse: Metadata contains information about the rollout.
name str: Optional. Name of the Rollout. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
phases Sequence[PhaseResponse]: The phases that represent the workflows of this Rollout.
state str: Current state of the Rollout.
target_id str: The ID of Target to which this Rollout is deploying.
uid str: Unique identifier of the Rollout.

annotations Map<String>: User annotations. These attributes can only be set and used by the user, and not by Google Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations.
approvalState String: Approval state of the Rollout.
approveTime String: Time at which the Rollout was approved.
createTime String: Time at which the Rollout was created.
deployEndTime String: Time at which the Rollout finished deploying.
deployFailureCause String: The reason this rollout failed. This will always be unspecified while the rollout is in progress.
deployStartTime String: Time at which the Rollout started deploying.
deployingBuild String: The resource name of the Cloud Build Build object that is used to deploy the Rollout. Format is projects/{project}/locations/{location}/builds/{build}.
description String: Description of the Rollout for user purposes. Max length is 255 characters.
enqueueTime String: Time at which the Rollout was enqueued.
etag String: This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
failureReason String: Additional information about the rollout failure, if available.
labels Map<String>: Labels are attributes that can be set and used by both the user and by Google Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.
metadata Property Map: Metadata contains information about the rollout.
name String: Optional. Name of the Rollout. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.
phases List<Property Map>: The phases that represent the workflows of this Rollout.
state String: Current state of the Rollout.
targetId String: The ID of Target to which this Rollout is deploying.
uid String: Unique identifier of the Rollout.

Supporting Types

CloudRunMetadataResponse

Revision string: The Cloud Run Revision id associated with a Rollout.
Service string: The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.
ServiceUrls List<string>: The Cloud Run Service urls that are associated with a Rollout.

Revision string: The Cloud Run Revision id associated with a Rollout.
Service string: The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.
ServiceUrls []string: The Cloud Run Service urls that are associated with a Rollout.

revision String: The Cloud Run Revision id associated with a Rollout.
service String: The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.
serviceUrls List<String>: The Cloud Run Service urls that are associated with a Rollout.

revision string: The Cloud Run Revision id associated with a Rollout.
service string: The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.
serviceUrls string[]: The Cloud Run Service urls that are associated with a Rollout.

revision str: The Cloud Run Revision id associated with a Rollout.
service str: The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.
service_urls Sequence[str]: The Cloud Run Service urls that are associated with a Rollout.

revision String: The Cloud Run Revision id associated with a Rollout.
service String: The name of the Cloud Run Service that is associated with a Rollout. Format is projects/{project}/locations/{location}/services/{service}.
serviceUrls List<String>: The Cloud Run Service urls that are associated with a Rollout.

DeploymentJobsResponse

DeployJob Pulumi.GoogleNative.CloudDeploy.V1.Inputs.JobResponse: The deploy Job. This is the first job run in the phase.
VerifyJob Pulumi.GoogleNative.CloudDeploy.V1.Inputs.JobResponse: The verify Job. Runs after a deploy if the deploy succeeds.

DeployJob JobResponse: The deploy Job. This is the first job run in the phase.
VerifyJob JobResponse: The verify Job. Runs after a deploy if the deploy succeeds.

deployJob JobResponse: The deploy Job. This is the first job run in the phase.
verifyJob JobResponse: The verify Job. Runs after a deploy if the deploy succeeds.

deployJob JobResponse: The deploy Job. This is the first job run in the phase.
verifyJob JobResponse: The verify Job. Runs after a deploy if the deploy succeeds.

deploy_job JobResponse: The deploy Job. This is the first job run in the phase.
verify_job JobResponse: The verify Job. Runs after a deploy if the deploy succeeds.

deployJob Property Map: The deploy Job. This is the first job run in the phase.
verifyJob Property Map: The verify Job. Runs after a deploy if the deploy succeeds.

JobResponse

DeployJob Pulumi.GoogleNative.CloudDeploy.V1.Inputs.DeployJobResponse: A deploy Job.
JobRun string: The name of the JobRun responsible for the most recent invocation of this Job.
State string: The current state of the Job.
VerifyJob Pulumi.GoogleNative.CloudDeploy.V1.Inputs.VerifyJobResponse: A verify Job.

DeployJob DeployJobResponse: A deploy Job.
JobRun string: The name of the JobRun responsible for the most recent invocation of this Job.
State string: The current state of the Job.
VerifyJob VerifyJobResponse: A verify Job.

deployJob DeployJobResponse: A deploy Job.
jobRun String: The name of the JobRun responsible for the most recent invocation of this Job.
state String: The current state of the Job.
verifyJob VerifyJobResponse: A verify Job.

deployJob DeployJobResponse: A deploy Job.
jobRun string: The name of the JobRun responsible for the most recent invocation of this Job.
state string: The current state of the Job.
verifyJob VerifyJobResponse: A verify Job.

deploy_job DeployJobResponse: A deploy Job.
job_run str: The name of the JobRun responsible for the most recent invocation of this Job.
state str: The current state of the Job.
verify_job VerifyJobResponse: A verify Job.

deployJob Property Map: A deploy Job.
jobRun String: The name of the JobRun responsible for the most recent invocation of this Job.
state String: The current state of the Job.
verifyJob Property Map: A verify Job.

MetadataResponse

CloudRun Pulumi.GoogleNative.CloudDeploy.V1.Inputs.CloudRunMetadataResponse: The name of the Cloud Run Service that is associated with a Rollout.

CloudRun CloudRunMetadataResponse: The name of the Cloud Run Service that is associated with a Rollout.

cloudRun CloudRunMetadataResponse: The name of the Cloud Run Service that is associated with a Rollout.

cloudRun CloudRunMetadataResponse: The name of the Cloud Run Service that is associated with a Rollout.

cloud_run CloudRunMetadataResponse: The name of the Cloud Run Service that is associated with a Rollout.

cloudRun Property Map: The name of the Cloud Run Service that is associated with a Rollout.

PhaseResponse

DeploymentJobs Pulumi.GoogleNative.CloudDeploy.V1.Inputs.DeploymentJobsResponse: Deployment job composition.
State string: Current state of the Phase.

DeploymentJobs DeploymentJobsResponse: Deployment job composition.
State string: Current state of the Phase.

deploymentJobs DeploymentJobsResponse: Deployment job composition.
state String: Current state of the Phase.

deploymentJobs DeploymentJobsResponse: Deployment job composition.
state string: Current state of the Phase.

deployment_jobs DeploymentJobsResponse: Deployment job composition.
state str: Current state of the Phase.

deploymentJobs Property Map: Deployment job composition.
state String: Current state of the Phase.

Package Details

Repository: https://github.com/pulumi/pulumi-google-native
License: Apache-2.0