Google Native

v0.26.0 published on Friday, Sep 16, 2022 by Pulumi

getDeliveryPipeline

Gets details of a single DeliveryPipeline.

Using getDeliveryPipeline

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 getDeliveryPipeline(args: GetDeliveryPipelineArgs, opts?: InvokeOptions): Promise<GetDeliveryPipelineResult>
function getDeliveryPipelineOutput(args: GetDeliveryPipelineOutputArgs, opts?: InvokeOptions): Output<GetDeliveryPipelineResult>
def get_delivery_pipeline(delivery_pipeline_id: Optional[str] = None,
                          location: Optional[str] = None,
                          project: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDeliveryPipelineResult
def get_delivery_pipeline_output(delivery_pipeline_id: Optional[pulumi.Input[str]] = None,
                          location: Optional[pulumi.Input[str]] = None,
                          project: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetDeliveryPipelineResult]
func LookupDeliveryPipeline(ctx *Context, args *LookupDeliveryPipelineArgs, opts ...InvokeOption) (*LookupDeliveryPipelineResult, error)
func LookupDeliveryPipelineOutput(ctx *Context, args *LookupDeliveryPipelineOutputArgs, opts ...InvokeOption) LookupDeliveryPipelineResultOutput

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

public static class GetDeliveryPipeline 
{
    public static Task<GetDeliveryPipelineResult> InvokeAsync(GetDeliveryPipelineArgs args, InvokeOptions? opts = null)
    public static Output<GetDeliveryPipelineResult> Invoke(GetDeliveryPipelineInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDeliveryPipelineResult> getDeliveryPipeline(GetDeliveryPipelineArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: google-native:clouddeploy/v1:getDeliveryPipeline
  Arguments:
    # Arguments dictionary

The following arguments are supported:

getDeliveryPipeline 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.

Condition Pulumi.GoogleNative.CloudDeploy.V1.Outputs.PipelineConditionResponse

Information around the state of the Delivery Pipeline.

CreateTime string

Time at which the pipeline was created.

Description string

Description of the DeliveryPipeline. Max length is 255 characters.

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.

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 DeliveryPipeline. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}.

SerialPipeline Pulumi.GoogleNative.CloudDeploy.V1.Outputs.SerialPipelineResponse

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

Suspended bool

When suspended, no new releases or rollouts can be created, but in-progress ones will complete.

Uid string

Unique identifier of the DeliveryPipeline.

UpdateTime string

Most recent time at which the pipeline was updated.

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.

Condition PipelineConditionResponse

Information around the state of the Delivery Pipeline.

CreateTime string

Time at which the pipeline was created.

Description string

Description of the DeliveryPipeline. Max length is 255 characters.

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.

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 DeliveryPipeline. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}.

SerialPipeline SerialPipelineResponse

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

Suspended bool

When suspended, no new releases or rollouts can be created, but in-progress ones will complete.

Uid string

Unique identifier of the DeliveryPipeline.

UpdateTime string

Most recent time at which the pipeline was updated.

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.

condition PipelineConditionResponse

Information around the state of the Delivery Pipeline.

createTime String

Time at which the pipeline was created.

description String

Description of the DeliveryPipeline. Max length is 255 characters.

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.

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 DeliveryPipeline. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}.

serialPipeline SerialPipelineResponse

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

suspended Boolean

When suspended, no new releases or rollouts can be created, but in-progress ones will complete.

uid String

Unique identifier of the DeliveryPipeline.

updateTime String

Most recent time at which the pipeline was updated.

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.

condition PipelineConditionResponse

Information around the state of the Delivery Pipeline.

createTime string

Time at which the pipeline was created.

description string

Description of the DeliveryPipeline. Max length is 255 characters.

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.

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 DeliveryPipeline. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}.

serialPipeline SerialPipelineResponse

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

suspended boolean

When suspended, no new releases or rollouts can be created, but in-progress ones will complete.

uid string

Unique identifier of the DeliveryPipeline.

updateTime string

Most recent time at which the pipeline was updated.

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.

condition PipelineConditionResponse

Information around the state of the Delivery Pipeline.

create_time str

Time at which the pipeline was created.

description str

Description of the DeliveryPipeline. Max length is 255 characters.

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.

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 DeliveryPipeline. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}.

serial_pipeline SerialPipelineResponse

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

suspended bool

When suspended, no new releases or rollouts can be created, but in-progress ones will complete.

uid str

Unique identifier of the DeliveryPipeline.

update_time str

Most recent time at which the pipeline was updated.

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.

condition Property Map

Information around the state of the Delivery Pipeline.

createTime String

Time at which the pipeline was created.

description String

Description of the DeliveryPipeline. Max length is 255 characters.

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.

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.

name String

Optional. Name of the DeliveryPipeline. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}.

serialPipeline Property Map

SerialPipeline defines a sequential set of stages for a DeliveryPipeline.

suspended Boolean

When suspended, no new releases or rollouts can be created, but in-progress ones will complete.

uid String

Unique identifier of the DeliveryPipeline.

updateTime String

Most recent time at which the pipeline was updated.

Supporting Types

PipelineConditionResponse

PipelineReadyCondition PipelineReadyConditionResponse

Details around the Pipeline's overall status.

TargetsPresentCondition TargetsPresentConditionResponse

Detalis around targets enumerated in the pipeline.

pipelineReadyCondition PipelineReadyConditionResponse

Details around the Pipeline's overall status.

targetsPresentCondition TargetsPresentConditionResponse

Detalis around targets enumerated in the pipeline.

pipelineReadyCondition PipelineReadyConditionResponse

Details around the Pipeline's overall status.

targetsPresentCondition TargetsPresentConditionResponse

Detalis around targets enumerated in the pipeline.

pipeline_ready_condition PipelineReadyConditionResponse

Details around the Pipeline's overall status.

targets_present_condition TargetsPresentConditionResponse

Detalis around targets enumerated in the pipeline.

pipelineReadyCondition Property Map

Details around the Pipeline's overall status.

targetsPresentCondition Property Map

Detalis around targets enumerated in the pipeline.

PipelineReadyConditionResponse

Status bool

True if the Pipeline is in a valid state. Otherwise at least one condition in PipelineCondition is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.

UpdateTime string

Last time the condition was updated.

Status bool

True if the Pipeline is in a valid state. Otherwise at least one condition in PipelineCondition is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.

UpdateTime string

Last time the condition was updated.

status Boolean

True if the Pipeline is in a valid state. Otherwise at least one condition in PipelineCondition is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.

updateTime String

Last time the condition was updated.

status boolean

True if the Pipeline is in a valid state. Otherwise at least one condition in PipelineCondition is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.

updateTime string

Last time the condition was updated.

status bool

True if the Pipeline is in a valid state. Otherwise at least one condition in PipelineCondition is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.

update_time str

Last time the condition was updated.

status Boolean

True if the Pipeline is in a valid state. Otherwise at least one condition in PipelineCondition is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline.

updateTime String

Last time the condition was updated.

SerialPipelineResponse

Stages List<Pulumi.GoogleNative.CloudDeploy.V1.Inputs.StageResponse>

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

Stages []StageResponse

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

stages List<StageResponse>

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

stages StageResponse[]

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

stages Sequence[StageResponse]

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

stages List<Property Map>

Each stage specifies configuration for a Target. The ordering of this list defines the promotion flow.

StageResponse

Profiles List<string>

Skaffold profiles to use when rendering the manifest for this stage's Target.

Strategy Pulumi.GoogleNative.CloudDeploy.V1.Inputs.StrategyResponse

Optional. The strategy to use for a Rollout to this stage.

TargetId string

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

Profiles []string

Skaffold profiles to use when rendering the manifest for this stage's Target.

Strategy StrategyResponse

Optional. The strategy to use for a Rollout to this stage.

TargetId string

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

profiles List<String>

Skaffold profiles to use when rendering the manifest for this stage's Target.

strategy StrategyResponse

Optional. The strategy to use for a Rollout to this stage.

targetId String

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

profiles string[]

Skaffold profiles to use when rendering the manifest for this stage's Target.

strategy StrategyResponse

Optional. The strategy to use for a Rollout to this stage.

targetId string

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

profiles Sequence[str]

Skaffold profiles to use when rendering the manifest for this stage's Target.

strategy StrategyResponse

Optional. The strategy to use for a Rollout to this stage.

target_id str

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

profiles List<String>

Skaffold profiles to use when rendering the manifest for this stage's Target.

strategy Property Map

Optional. The strategy to use for a Rollout to this stage.

targetId String

The target_id to which this stage points. This field refers exclusively to the last segment of a target name. For example, this field would just be my-target (rather than projects/project/locations/location/targets/my-target). The location of the Target is inferred to be the same as the location of the DeliveryPipeline that contains this Stage.

StandardResponse

Verify bool

Whether to verify a deployment.

Verify bool

Whether to verify a deployment.

verify Boolean

Whether to verify a deployment.

verify boolean

Whether to verify a deployment.

verify bool

Whether to verify a deployment.

verify Boolean

Whether to verify a deployment.

StrategyResponse

Standard Pulumi.GoogleNative.CloudDeploy.V1.Inputs.StandardResponse

Standard deployment strategy executes a single deploy and allows verifying the deployment.

Standard StandardResponse

Standard deployment strategy executes a single deploy and allows verifying the deployment.

standard StandardResponse

Standard deployment strategy executes a single deploy and allows verifying the deployment.

standard StandardResponse

Standard deployment strategy executes a single deploy and allows verifying the deployment.

standard StandardResponse

Standard deployment strategy executes a single deploy and allows verifying the deployment.

standard Property Map

Standard deployment strategy executes a single deploy and allows verifying the deployment.

TargetsPresentConditionResponse

MissingTargets List<string>

The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.

Status bool

True if there aren't any missing Targets.

UpdateTime string

Last time the condition was updated.

MissingTargets []string

The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.

Status bool

True if there aren't any missing Targets.

UpdateTime string

Last time the condition was updated.

missingTargets List<String>

The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.

status Boolean

True if there aren't any missing Targets.

updateTime String

Last time the condition was updated.

missingTargets string[]

The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.

status boolean

True if there aren't any missing Targets.

updateTime string

Last time the condition was updated.

missing_targets Sequence[str]

The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.

status bool

True if there aren't any missing Targets.

update_time str

Last time the condition was updated.

missingTargets List<String>

The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}.

status Boolean

True if there aren't any missing Targets.

updateTime String

Last time the condition was updated.

Package Details

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