Google Native
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:
- Delivery
Pipeline stringId - Location string
- Release
Id string - Rollout
Id string - Project string
- Delivery
Pipeline stringId - Location string
- Release
Id string - Rollout
Id string - Project string
- delivery
Pipeline StringId - location String
- release
Id String - rollout
Id String - project String
- delivery
Pipeline stringId - location string
- release
Id string - rollout
Id string - project string
- delivery_
pipeline_ strid - location str
- release_
id str - rollout_
id str - project str
- delivery
Pipeline StringId - location String
- release
Id String - rollout
Id 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.
- Approval
State string Approval state of the
Rollout
.- Approve
Time string Time at which the
Rollout
was approved.- Create
Time string Time at which the
Rollout
was created.- Deploy
End stringTime Time at which the
Rollout
finished deploying.- Deploy
Failure stringCause The reason this deploy failed. This will always be unspecified while the deploy in progress.
- Deploy
Start stringTime Time at which the
Rollout
started deploying.- Deploying
Build string The resource name of the Cloud Build
Build
object that is used to deploy the Rollout. Format isprojects/{project}/locations/{location}/builds/{build}
.- Description string
Description of the
Rollout
for user purposes. Max length is 255 characters.- Enqueue
Time 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.
- Failure
Reason string Reason the build failed. Empty if the build succeeded.
- 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.
- Name string
Optional. Name of the
Rollout
. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.- State string
Current state of the
Rollout
.- Target
Id 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.
- Approval
State string Approval state of the
Rollout
.- Approve
Time string Time at which the
Rollout
was approved.- Create
Time string Time at which the
Rollout
was created.- Deploy
End stringTime Time at which the
Rollout
finished deploying.- Deploy
Failure stringCause The reason this deploy failed. This will always be unspecified while the deploy in progress.
- Deploy
Start stringTime Time at which the
Rollout
started deploying.- Deploying
Build string The resource name of the Cloud Build
Build
object that is used to deploy the Rollout. Format isprojects/{project}/locations/{location}/builds/{build}
.- Description string
Description of the
Rollout
for user purposes. Max length is 255 characters.- Enqueue
Time 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.
- Failure
Reason string Reason the build failed. Empty if the build succeeded.
- 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.
- Name string
Optional. Name of the
Rollout
. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.- State string
Current state of the
Rollout
.- Target
Id string The ID of Target to which this
Rollout
is deploying.- Uid string
Unique identifier of the
Rollout
.
- annotations
Map
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 String Approval state of the
Rollout
.- approve
Time String Time at which the
Rollout
was approved.- create
Time String Time at which the
Rollout
was created.- deploy
End StringTime Time at which the
Rollout
finished deploying.- deploy
Failure StringCause The reason this deploy failed. This will always be unspecified while the deploy in progress.
- deploy
Start StringTime Time at which the
Rollout
started deploying.- deploying
Build String The resource name of the Cloud Build
Build
object that is used to deploy the Rollout. Format isprojects/{project}/locations/{location}/builds/{build}
.- description String
Description of the
Rollout
for user purposes. Max length is 255 characters.- enqueue
Time 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.
- failure
Reason String Reason the build failed. Empty if the build succeeded.
- labels
Map
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.
- name String
Optional. Name of the
Rollout
. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.- state String
Current state of the
Rollout
.- target
Id 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.
- approval
State string Approval state of the
Rollout
.- approve
Time string Time at which the
Rollout
was approved.- create
Time string Time at which the
Rollout
was created.- deploy
End stringTime Time at which the
Rollout
finished deploying.- deploy
Failure stringCause The reason this deploy failed. This will always be unspecified while the deploy in progress.
- deploy
Start stringTime Time at which the
Rollout
started deploying.- deploying
Build string The resource name of the Cloud Build
Build
object that is used to deploy the Rollout. Format isprojects/{project}/locations/{location}/builds/{build}
.- description string
Description of the
Rollout
for user purposes. Max length is 255 characters.- enqueue
Time 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.
- failure
Reason string Reason the build failed. Empty if the build succeeded.
- 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.
- name string
Optional. Name of the
Rollout
. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.- state string
Current state of the
Rollout
.- target
Id 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_ strtime Time at which the
Rollout
finished deploying.- deploy_
failure_ strcause The reason this deploy failed. This will always be unspecified while the deploy in progress.
- deploy_
start_ strtime 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 isprojects/{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 Reason the build failed. Empty if the build succeeded.
- 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.
- name str
Optional. Name of the
Rollout
. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.- 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
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 String Approval state of the
Rollout
.- approve
Time String Time at which the
Rollout
was approved.- create
Time String Time at which the
Rollout
was created.- deploy
End StringTime Time at which the
Rollout
finished deploying.- deploy
Failure StringCause The reason this deploy failed. This will always be unspecified while the deploy in progress.
- deploy
Start StringTime Time at which the
Rollout
started deploying.- deploying
Build String The resource name of the Cloud Build
Build
object that is used to deploy the Rollout. Format isprojects/{project}/locations/{location}/builds/{build}
.- description String
Description of the
Rollout
for user purposes. Max length is 255 characters.- enqueue
Time 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.
- failure
Reason String Reason the build failed. Empty if the build succeeded.
- labels
Map
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.
- name String
Optional. Name of the
Rollout
. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}.- state String
Current state of the
Rollout
.- target
Id String The ID of Target to which this
Rollout
is deploying.- uid String
Unique identifier of the
Rollout
.
Package Details
- Repository
- https://github.com/pulumi/pulumi-google-native
- License
- Apache-2.0