Package com.google.cloud.deploy.v1

Interface ReleaseOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Release, Release.Builder
    public interface ReleaseOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Optional. Name of the `Release`. Format is projects/{project}/
 locations/{location}/deliveryPipelines/{deliveryPipeline}/
 releases/[a-z][a-z0-9\-]{0,62}.
        string name = 1 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Optional. Name of the `Release`. Format is projects/{project}/
 locations/{location}/deliveryPipelines/{deliveryPipeline}/
 releases/[a-z][a-z0-9\-]{0,62}.
        string name = 1 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for name.

      • getUid

        String getUid()
         Output only. Unique identifier of the `Release`.
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The uid.

      • getUidBytes

        com.google.protobuf.ByteString getUidBytes()
         Output only. Unique identifier of the `Release`.
        string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for uid.

      • getDescription

        String getDescription()
         Description of the `Release`. Max length is 255 characters.
        string description = 3;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         Description of the `Release`. Max length is 255 characters.
        string description = 3;
        Returns:
        The bytes for description.

      • getAnnotationsCount

        int getAnnotationsCount()
         User annotations. These attributes can only be set and used by the
 user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations
 for more details such as format and size limitations.
        map<string, string> annotations = 4;

      • containsAnnotations

        boolean containsAnnotations​(String key)
         User annotations. These attributes can only be set and used by the
 user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations
 for more details such as format and size limitations.
        map<string, string> annotations = 4;

      • getAnnotationsMap

        Map<String,​String> getAnnotationsMap()
         User annotations. These attributes can only be set and used by the
 user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations
 for more details such as format and size limitations.
        map<string, string> annotations = 4;

      • getAnnotationsOrDefault

        String getAnnotationsOrDefault​(String key,
                               String defaultValue)
         User annotations. These attributes can only be set and used by the
 user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations
 for more details such as format and size limitations.
        map<string, string> annotations = 4;

      • getAnnotationsOrThrow

        String getAnnotationsOrThrow​(String key)
         User annotations. These attributes can only be set and used by the
 user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations
 for more details such as format and size limitations.
        map<string, string> annotations = 4;

      • getLabelsCount

        int getLabelsCount()
         Labels are attributes that can be set and used by both the
 user and by 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.
        map<string, string> labels = 5;

      • containsLabels

        boolean containsLabels​(String key)
         Labels are attributes that can be set and used by both the
 user and by 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.
        map<string, string> labels = 5;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Labels are attributes that can be set and used by both the
 user and by 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.
        map<string, string> labels = 5;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Labels are attributes that can be set and used by both the
 user and by 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.
        map<string, string> labels = 5;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Labels are attributes that can be set and used by both the
 user and by 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.
        map<string, string> labels = 5;

      • getAbandoned

        boolean getAbandoned()
         Output only. Indicates whether this is an abandoned release.
        bool abandoned = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The abandoned.

      • hasCreateTime

        boolean hasCreateTime()
         Output only. Time at which the `Release` was created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. Time at which the `Release` was created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Time at which the `Release` was created.
        .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasRenderStartTime

        boolean hasRenderStartTime()
         Output only. Time at which the render began.
        .google.protobuf.Timestamp render_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the renderStartTime field is set.

      • getRenderStartTime

        com.google.protobuf.Timestamp getRenderStartTime()
         Output only. Time at which the render began.
        .google.protobuf.Timestamp render_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The renderStartTime.

      • getRenderStartTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getRenderStartTimeOrBuilder()
         Output only. Time at which the render began.
        .google.protobuf.Timestamp render_start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasRenderEndTime

        boolean hasRenderEndTime()
         Output only. Time at which the render completed.
        .google.protobuf.Timestamp render_end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the renderEndTime field is set.

      • getRenderEndTime

        com.google.protobuf.Timestamp getRenderEndTime()
         Output only. Time at which the render completed.
        .google.protobuf.Timestamp render_end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The renderEndTime.

      • getRenderEndTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getRenderEndTimeOrBuilder()
         Output only. Time at which the render completed.
        .google.protobuf.Timestamp render_end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getSkaffoldConfigUri

        String getSkaffoldConfigUri()
         Cloud Storage URI of tar.gz archive containing Skaffold configuration.
        string skaffold_config_uri = 17;
        Returns:
        The skaffoldConfigUri.

      • getSkaffoldConfigUriBytes

        com.google.protobuf.ByteString getSkaffoldConfigUriBytes()
         Cloud Storage URI of tar.gz archive containing Skaffold configuration.
        string skaffold_config_uri = 17;
        Returns:
        The bytes for skaffoldConfigUri.

      • getSkaffoldConfigPath

        String getSkaffoldConfigPath()
         Filepath of the Skaffold config inside of the config URI.
        string skaffold_config_path = 9;
        Returns:
        The skaffoldConfigPath.

      • getSkaffoldConfigPathBytes

        com.google.protobuf.ByteString getSkaffoldConfigPathBytes()
         Filepath of the Skaffold config inside of the config URI.
        string skaffold_config_path = 9;
        Returns:
        The bytes for skaffoldConfigPath.

      • getBuildArtifactsList

        List<BuildArtifact> getBuildArtifactsList()
         List of artifacts to pass through to Skaffold command.
        repeated .google.cloud.deploy.v1.BuildArtifact build_artifacts = 10;

      • getBuildArtifacts

        BuildArtifact getBuildArtifacts​(int index)
         List of artifacts to pass through to Skaffold command.
        repeated .google.cloud.deploy.v1.BuildArtifact build_artifacts = 10;

      • getBuildArtifactsCount

        int getBuildArtifactsCount()
         List of artifacts to pass through to Skaffold command.
        repeated .google.cloud.deploy.v1.BuildArtifact build_artifacts = 10;

      • getBuildArtifactsOrBuilderList

        List<? extends BuildArtifactOrBuilder> getBuildArtifactsOrBuilderList()
         List of artifacts to pass through to Skaffold command.
        repeated .google.cloud.deploy.v1.BuildArtifact build_artifacts = 10;

      • getBuildArtifactsOrBuilder

        BuildArtifactOrBuilder getBuildArtifactsOrBuilder​(int index)
         List of artifacts to pass through to Skaffold command.
        repeated .google.cloud.deploy.v1.BuildArtifact build_artifacts = 10;

      • hasDeliveryPipelineSnapshot

        boolean hasDeliveryPipelineSnapshot()
         Output only. Snapshot of the parent pipeline taken at release creation
 time.
        .google.cloud.deploy.v1.DeliveryPipeline delivery_pipeline_snapshot = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the deliveryPipelineSnapshot field is set.

      • getDeliveryPipelineSnapshot

        DeliveryPipeline getDeliveryPipelineSnapshot()
         Output only. Snapshot of the parent pipeline taken at release creation
 time.
        .google.cloud.deploy.v1.DeliveryPipeline delivery_pipeline_snapshot = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The deliveryPipelineSnapshot.

      • getDeliveryPipelineSnapshotOrBuilder

        DeliveryPipelineOrBuilder getDeliveryPipelineSnapshotOrBuilder()
         Output only. Snapshot of the parent pipeline taken at release creation
 time.
        .google.cloud.deploy.v1.DeliveryPipeline delivery_pipeline_snapshot = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getTargetSnapshotsList

        List<Target> getTargetSnapshotsList()
         Output only. Snapshot of the targets taken at release creation time.
        repeated .google.cloud.deploy.v1.Target target_snapshots = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getTargetSnapshots

        Target getTargetSnapshots​(int index)
         Output only. Snapshot of the targets taken at release creation time.
        repeated .google.cloud.deploy.v1.Target target_snapshots = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getTargetSnapshotsCount

        int getTargetSnapshotsCount()
         Output only. Snapshot of the targets taken at release creation time.
        repeated .google.cloud.deploy.v1.Target target_snapshots = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getTargetSnapshotsOrBuilderList

        List<? extends TargetOrBuilder> getTargetSnapshotsOrBuilderList()
         Output only. Snapshot of the targets taken at release creation time.
        repeated .google.cloud.deploy.v1.Target target_snapshots = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getTargetSnapshotsOrBuilder

        TargetOrBuilder getTargetSnapshotsOrBuilder​(int index)
         Output only. Snapshot of the targets taken at release creation time.
        repeated .google.cloud.deploy.v1.Target target_snapshots = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getRenderStateValue

        int getRenderStateValue()
         Output only. Current state of the render operation.
        .google.cloud.deploy.v1.Release.RenderState render_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for renderState.

      • getRenderState

        Release.RenderState getRenderState()
         Output only. Current state of the render operation.
        .google.cloud.deploy.v1.Release.RenderState render_state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The renderState.

      • getEtag

        String getEtag()
         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.
        string etag = 16;
        Returns:
        The etag.

      • getEtagBytes

        com.google.protobuf.ByteString getEtagBytes()
         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.
        string etag = 16;
        Returns:
        The bytes for etag.

      • getSkaffoldVersion

        String getSkaffoldVersion()
         The Skaffold version to use when operating on this release, such as
 "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set
 of versions.

 If unset, the most recent supported Skaffold version will be used.
        string skaffold_version = 19;
        Returns:
        The skaffoldVersion.

      • getSkaffoldVersionBytes

        com.google.protobuf.ByteString getSkaffoldVersionBytes()
         The Skaffold version to use when operating on this release, such as
 "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set
 of versions.

 If unset, the most recent supported Skaffold version will be used.
        string skaffold_version = 19;
        Returns:
        The bytes for skaffoldVersion.

      • getTargetArtifactsCount

        int getTargetArtifactsCount()
         Output only. Map from target ID to the target artifacts created
 during the render operation.
        map<string, .google.cloud.deploy.v1.TargetArtifact> target_artifacts = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • containsTargetArtifacts

        boolean containsTargetArtifacts​(String key)
         Output only. Map from target ID to the target artifacts created
 during the render operation.
        map<string, .google.cloud.deploy.v1.TargetArtifact> target_artifacts = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getTargetArtifactsMap

        Map<String,​TargetArtifact> getTargetArtifactsMap()
         Output only. Map from target ID to the target artifacts created
 during the render operation.
        map<string, .google.cloud.deploy.v1.TargetArtifact> target_artifacts = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getTargetArtifactsOrDefault

        TargetArtifact getTargetArtifactsOrDefault​(String key,
                                           TargetArtifact defaultValue)
         Output only. Map from target ID to the target artifacts created
 during the render operation.
        map<string, .google.cloud.deploy.v1.TargetArtifact> target_artifacts = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getTargetArtifactsOrThrow

        TargetArtifact getTargetArtifactsOrThrow​(String key)
         Output only. Map from target ID to the target artifacts created
 during the render operation.
        map<string, .google.cloud.deploy.v1.TargetArtifact> target_artifacts = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getTargetRendersCount

        int getTargetRendersCount()
         Output only. Map from target ID to details of the render operation for that
 target.
        map<string, .google.cloud.deploy.v1.Release.TargetRender> target_renders = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • containsTargetRenders

        boolean containsTargetRenders​(String key)
         Output only. Map from target ID to details of the render operation for that
 target.
        map<string, .google.cloud.deploy.v1.Release.TargetRender> target_renders = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getTargetRendersMap

        Map<String,​Release.TargetRender> getTargetRendersMap()
         Output only. Map from target ID to details of the render operation for that
 target.
        map<string, .google.cloud.deploy.v1.Release.TargetRender> target_renders = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getTargetRendersOrDefault

        Release.TargetRender getTargetRendersOrDefault​(String key,
                                               Release.TargetRender defaultValue)
         Output only. Map from target ID to details of the render operation for that
 target.
        map<string, .google.cloud.deploy.v1.Release.TargetRender> target_renders = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getTargetRendersOrThrow

        Release.TargetRender getTargetRendersOrThrow​(String key)
         Output only. Map from target ID to details of the render operation for that
 target.
        map<string, .google.cloud.deploy.v1.Release.TargetRender> target_renders = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasCondition

        boolean hasCondition()
         Output only. Information around the state of the Release.
        .google.cloud.deploy.v1.Release.ReleaseCondition condition = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the condition field is set.

      • getCondition

        Release.ReleaseCondition getCondition()
         Output only. Information around the state of the Release.
        .google.cloud.deploy.v1.Release.ReleaseCondition condition = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The condition.

      • getConditionOrBuilder

        Release.ReleaseConditionOrBuilder getConditionOrBuilder()
         Output only. Information around the state of the Release.
        .google.cloud.deploy.v1.Release.ReleaseCondition condition = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getDeployParametersCount

        int getDeployParametersCount()
         Optional. The deploy parameters to use for all targets in this release.
        map<string, string> deploy_parameters = 25 [(.google.api.field_behavior) = OPTIONAL];

      • containsDeployParameters

        boolean containsDeployParameters​(String key)
         Optional. The deploy parameters to use for all targets in this release.
        map<string, string> deploy_parameters = 25 [(.google.api.field_behavior) = OPTIONAL];

      • getDeployParametersMap

        Map<String,​String> getDeployParametersMap()
         Optional. The deploy parameters to use for all targets in this release.
        map<string, string> deploy_parameters = 25 [(.google.api.field_behavior) = OPTIONAL];

      • getDeployParametersOrDefault

        String getDeployParametersOrDefault​(String key,
                                    String defaultValue)
         Optional. The deploy parameters to use for all targets in this release.
        map<string, string> deploy_parameters = 25 [(.google.api.field_behavior) = OPTIONAL];

      • getDeployParametersOrThrow

        String getDeployParametersOrThrow​(String key)
         Optional. The deploy parameters to use for all targets in this release.
        map<string, string> deploy_parameters = 25 [(.google.api.field_behavior) = OPTIONAL];