Interface DeploymentOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Deployment, Deployment.Builder

@Generated public interface DeploymentOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • hasTerraformBlueprint

      boolean hasTerraformBlueprint()
       A blueprint described using Terraform's HashiCorp Configuration Language
       as a root module.
       
      .google.cloud.config.v1.TerraformBlueprint terraform_blueprint = 6;
      Returns:
      Whether the terraformBlueprint field is set.
    • getTerraformBlueprint

      TerraformBlueprint getTerraformBlueprint()
       A blueprint described using Terraform's HashiCorp Configuration Language
       as a root module.
       
      .google.cloud.config.v1.TerraformBlueprint terraform_blueprint = 6;
      Returns:
      The terraformBlueprint.
    • getTerraformBlueprintOrBuilder

      TerraformBlueprintOrBuilder getTerraformBlueprintOrBuilder()
       A blueprint described using Terraform's HashiCorp Configuration Language
       as a root module.
       
      .google.cloud.config.v1.TerraformBlueprint terraform_blueprint = 6;
    • getName

      String getName()
       Identifier. Resource name of the deployment.
       Format: `projects/{project}/locations/{location}/deployments/{deployment}`
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.
    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. Resource name of the deployment.
       Format: `projects/{project}/locations/{location}/deployments/{deployment}`
       
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.
    • hasCreateTime

      boolean hasCreateTime()
       Output only. Time when the deployment was created.
       
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.
    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Time when the deployment was created.
       
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Time when the deployment was created.
       
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. Time when the deployment was last modified.
       
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.
    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. Time when the deployment was last modified.
       
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.
    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Time when the deployment was last modified.
       
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getLabelsCount

      int getLabelsCount()
       Optional. User-defined metadata for the deployment.
       
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
    • containsLabels

      boolean containsLabels(String key)
       Optional. User-defined metadata for the deployment.
       
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
    • getLabels

      Deprecated.
      Use getLabelsMap() instead.
    • getLabelsMap

      Map<String,String> getLabelsMap()
       Optional. User-defined metadata for the deployment.
       
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Optional. User-defined metadata for the deployment.
       
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Optional. User-defined metadata for the deployment.
       
      map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
    • getStateValue

      int getStateValue()
       Output only. Current state of the deployment.
       
      .google.cloud.config.v1.Deployment.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.
    • getState

      Deployment.State getState()
       Output only. Current state of the deployment.
       
      .google.cloud.config.v1.Deployment.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.
    • getLatestRevision

      String getLatestRevision()
       Output only. Revision name that was most recently applied.
       Format: `projects/{project}/locations/{location}/deployments/{deployment}/
       revisions/{revision}`
       
      string latest_revision = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The latestRevision.
    • getLatestRevisionBytes

      com.google.protobuf.ByteString getLatestRevisionBytes()
       Output only. Revision name that was most recently applied.
       Format: `projects/{project}/locations/{location}/deployments/{deployment}/
       revisions/{revision}`
       
      string latest_revision = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for latestRevision.
    • getStateDetail

      String getStateDetail()
       Output only. Additional information regarding the current state.
       
      string state_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The stateDetail.
    • getStateDetailBytes

      com.google.protobuf.ByteString getStateDetailBytes()
       Output only. Additional information regarding the current state.
       
      string state_detail = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for stateDetail.
    • getErrorCodeValue

      int getErrorCodeValue()
       Output only. Error code describing errors that may have occurred.
       
      .google.cloud.config.v1.Deployment.ErrorCode error_code = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for errorCode.
    • getErrorCode

      Deployment.ErrorCode getErrorCode()
       Output only. Error code describing errors that may have occurred.
       
      .google.cloud.config.v1.Deployment.ErrorCode error_code = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The errorCode.
    • hasDeleteResults

      boolean hasDeleteResults()
       Output only. Location of artifacts from a DeleteDeployment operation.
       
      .google.cloud.config.v1.ApplyResults delete_results = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the deleteResults field is set.
    • getDeleteResults

      ApplyResults getDeleteResults()
       Output only. Location of artifacts from a DeleteDeployment operation.
       
      .google.cloud.config.v1.ApplyResults delete_results = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The deleteResults.
    • getDeleteResultsOrBuilder

      ApplyResultsOrBuilder getDeleteResultsOrBuilder()
       Output only. Location of artifacts from a DeleteDeployment operation.
       
      .google.cloud.config.v1.ApplyResults delete_results = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getDeleteBuild

      String getDeleteBuild()
       Output only. Cloud Build instance UUID associated with deleting this
       deployment.
       
      string delete_build = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The deleteBuild.
    • getDeleteBuildBytes

      com.google.protobuf.ByteString getDeleteBuildBytes()
       Output only. Cloud Build instance UUID associated with deleting this
       deployment.
       
      string delete_build = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for deleteBuild.
    • getDeleteLogs

      String getDeleteLogs()
       Output only. Location of Cloud Build logs in Google Cloud Storage,
       populated when deleting this deployment. Format: `gs://{bucket}/{object}`.
       
      string delete_logs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The deleteLogs.
    • getDeleteLogsBytes

      com.google.protobuf.ByteString getDeleteLogsBytes()
       Output only. Location of Cloud Build logs in Google Cloud Storage,
       populated when deleting this deployment. Format: `gs://{bucket}/{object}`.
       
      string delete_logs = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for deleteLogs.
    • getTfErrorsList

      List<TerraformError> getTfErrorsList()
       Output only. Errors encountered when deleting this deployment.
       Errors are truncated to 10 entries, see `delete_results` and `error_logs`
       for full details.
       
      repeated .google.cloud.config.v1.TerraformError tf_errors = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getTfErrors

      TerraformError getTfErrors(int index)
       Output only. Errors encountered when deleting this deployment.
       Errors are truncated to 10 entries, see `delete_results` and `error_logs`
       for full details.
       
      repeated .google.cloud.config.v1.TerraformError tf_errors = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getTfErrorsCount

      int getTfErrorsCount()
       Output only. Errors encountered when deleting this deployment.
       Errors are truncated to 10 entries, see `delete_results` and `error_logs`
       for full details.
       
      repeated .google.cloud.config.v1.TerraformError tf_errors = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getTfErrorsOrBuilderList

      List<? extends TerraformErrorOrBuilder> getTfErrorsOrBuilderList()
       Output only. Errors encountered when deleting this deployment.
       Errors are truncated to 10 entries, see `delete_results` and `error_logs`
       for full details.
       
      repeated .google.cloud.config.v1.TerraformError tf_errors = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getTfErrorsOrBuilder

      TerraformErrorOrBuilder getTfErrorsOrBuilder(int index)
       Output only. Errors encountered when deleting this deployment.
       Errors are truncated to 10 entries, see `delete_results` and `error_logs`
       for full details.
       
      repeated .google.cloud.config.v1.TerraformError tf_errors = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getErrorLogs

      String getErrorLogs()
       Output only. Location of Terraform error logs in Google Cloud Storage.
       Format: `gs://{bucket}/{object}`.
       
      string error_logs = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The errorLogs.
    • getErrorLogsBytes

      com.google.protobuf.ByteString getErrorLogsBytes()
       Output only. Location of Terraform error logs in Google Cloud Storage.
       Format: `gs://{bucket}/{object}`.
       
      string error_logs = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for errorLogs.
    • hasArtifactsGcsBucket

      boolean hasArtifactsGcsBucket()
       Optional. User-defined location of Cloud Build logs and artifacts in Google
       Cloud Storage. Format: `gs://{bucket}/{folder}`
      
       A default bucket will be bootstrapped if the field is not set or empty.
       Default bucket format: `gs://<project number>-<region>-blueprint-config`
       Constraints:
       - The bucket needs to be in the same project as the deployment
       - The path cannot be within the path of `gcs_source`
       - The field cannot be updated, including changing its presence
       
      optional string artifacts_gcs_bucket = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the artifactsGcsBucket field is set.
    • getArtifactsGcsBucket

      String getArtifactsGcsBucket()
       Optional. User-defined location of Cloud Build logs and artifacts in Google
       Cloud Storage. Format: `gs://{bucket}/{folder}`
      
       A default bucket will be bootstrapped if the field is not set or empty.
       Default bucket format: `gs://<project number>-<region>-blueprint-config`
       Constraints:
       - The bucket needs to be in the same project as the deployment
       - The path cannot be within the path of `gcs_source`
       - The field cannot be updated, including changing its presence
       
      optional string artifacts_gcs_bucket = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The artifactsGcsBucket.
    • getArtifactsGcsBucketBytes

      com.google.protobuf.ByteString getArtifactsGcsBucketBytes()
       Optional. User-defined location of Cloud Build logs and artifacts in Google
       Cloud Storage. Format: `gs://{bucket}/{folder}`
      
       A default bucket will be bootstrapped if the field is not set or empty.
       Default bucket format: `gs://<project number>-<region>-blueprint-config`
       Constraints:
       - The bucket needs to be in the same project as the deployment
       - The path cannot be within the path of `gcs_source`
       - The field cannot be updated, including changing its presence
       
      optional string artifacts_gcs_bucket = 15 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for artifactsGcsBucket.
    • hasServiceAccount

      boolean hasServiceAccount()
       Required. User-specified Service Account (SA) credentials to be used when
       actuating resources.
       Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
       
      optional string service_account = 16 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      Whether the serviceAccount field is set.
    • getServiceAccount

      String getServiceAccount()
       Required. User-specified Service Account (SA) credentials to be used when
       actuating resources.
       Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
       
      optional string service_account = 16 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The serviceAccount.
    • getServiceAccountBytes

      com.google.protobuf.ByteString getServiceAccountBytes()
       Required. User-specified Service Account (SA) credentials to be used when
       actuating resources.
       Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
       
      optional string service_account = 16 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for serviceAccount.
    • hasImportExistingResources

      boolean hasImportExistingResources()
       By default, Infra Manager will return a failure when
       Terraform encounters a 409 code (resource conflict error) during actuation.
       If this flag is set to true, Infra Manager will instead
       attempt to automatically import the resource into the Terraform state (for
       supported resource types) and continue actuation.
      
       Not all resource types are supported, refer to documentation.
       
      optional bool import_existing_resources = 17;
      Returns:
      Whether the importExistingResources field is set.
    • getImportExistingResources

      boolean getImportExistingResources()
       By default, Infra Manager will return a failure when
       Terraform encounters a 409 code (resource conflict error) during actuation.
       If this flag is set to true, Infra Manager will instead
       attempt to automatically import the resource into the Terraform state (for
       supported resource types) and continue actuation.
      
       Not all resource types are supported, refer to documentation.
       
      optional bool import_existing_resources = 17;
      Returns:
      The importExistingResources.
    • hasWorkerPool

      boolean hasWorkerPool()
       Optional. The user-specified Cloud Build worker pool resource in which the
       Cloud Build job will execute. Format:
       `projects/{project}/locations/{location}/workerPools/{workerPoolId}`.
       If this field is unspecified, the default Cloud Build worker pool will be
       used.
       
      optional string worker_pool = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      Whether the workerPool field is set.
    • getWorkerPool

      String getWorkerPool()
       Optional. The user-specified Cloud Build worker pool resource in which the
       Cloud Build job will execute. Format:
       `projects/{project}/locations/{location}/workerPools/{workerPoolId}`.
       If this field is unspecified, the default Cloud Build worker pool will be
       used.
       
      optional string worker_pool = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The workerPool.
    • getWorkerPoolBytes

      com.google.protobuf.ByteString getWorkerPoolBytes()
       Optional. The user-specified Cloud Build worker pool resource in which the
       Cloud Build job will execute. Format:
       `projects/{project}/locations/{location}/workerPools/{workerPoolId}`.
       If this field is unspecified, the default Cloud Build worker pool will be
       used.
       
      optional string worker_pool = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for workerPool.
    • getLockStateValue

      int getLockStateValue()
       Output only. Current lock state of the deployment.
       
      .google.cloud.config.v1.Deployment.LockState lock_state = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for lockState.
    • getLockState

      Deployment.LockState getLockState()
       Output only. Current lock state of the deployment.
       
      .google.cloud.config.v1.Deployment.LockState lock_state = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The lockState.
    • hasTfVersionConstraint

      boolean hasTfVersionConstraint()
       Optional. The user-specified Terraform version constraint.
       Example: "=1.3.10".
       
      optional string tf_version_constraint = 21 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the tfVersionConstraint field is set.
    • getTfVersionConstraint

      String getTfVersionConstraint()
       Optional. The user-specified Terraform version constraint.
       Example: "=1.3.10".
       
      optional string tf_version_constraint = 21 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The tfVersionConstraint.
    • getTfVersionConstraintBytes

      com.google.protobuf.ByteString getTfVersionConstraintBytes()
       Optional. The user-specified Terraform version constraint.
       Example: "=1.3.10".
       
      optional string tf_version_constraint = 21 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for tfVersionConstraint.
    • getTfVersion

      String getTfVersion()
       Output only. The current Terraform version set on the deployment.
       It is in the format of "Major.Minor.Patch", for example, "1.3.10".
       
      string tf_version = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The tfVersion.
    • getTfVersionBytes

      com.google.protobuf.ByteString getTfVersionBytes()
       Output only. The current Terraform version set on the deployment.
       It is in the format of "Major.Minor.Patch", for example, "1.3.10".
       
      string tf_version = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for tfVersion.
    • getQuotaValidationValue

      int getQuotaValidationValue()
       Optional. Input to control quota checks for resources in terraform
       configuration files. There are limited resources on which quota validation
       applies.
       
      .google.cloud.config.v1.QuotaValidation quota_validation = 23 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for quotaValidation.
    • getQuotaValidation

      QuotaValidation getQuotaValidation()
       Optional. Input to control quota checks for resources in terraform
       configuration files. There are limited resources on which quota validation
       applies.
       
      .google.cloud.config.v1.QuotaValidation quota_validation = 23 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The quotaValidation.
    • getAnnotationsCount

      int getAnnotationsCount()
       Optional. Arbitrary key-value metadata storage e.g. to help client tools
       identify deployments during automation. See
       https://google.aip.dev/148#annotations for details on format and size
       limitations.
       
      map<string, string> annotations = 24 [(.google.api.field_behavior) = OPTIONAL];
    • containsAnnotations

      boolean containsAnnotations(String key)
       Optional. Arbitrary key-value metadata storage e.g. to help client tools
       identify deployments during automation. See
       https://google.aip.dev/148#annotations for details on format and size
       limitations.
       
      map<string, string> annotations = 24 [(.google.api.field_behavior) = OPTIONAL];
    • getAnnotations

      @Deprecated Map<String,String> getAnnotations()
      Deprecated.
      Use getAnnotationsMap() instead.
    • getAnnotationsMap

      Map<String,String> getAnnotationsMap()
       Optional. Arbitrary key-value metadata storage e.g. to help client tools
       identify deployments during automation. See
       https://google.aip.dev/148#annotations for details on format and size
       limitations.
       
      map<string, string> annotations = 24 [(.google.api.field_behavior) = OPTIONAL];
    • getAnnotationsOrDefault

      String getAnnotationsOrDefault(String key, String defaultValue)
       Optional. Arbitrary key-value metadata storage e.g. to help client tools
       identify deployments during automation. See
       https://google.aip.dev/148#annotations for details on format and size
       limitations.
       
      map<string, string> annotations = 24 [(.google.api.field_behavior) = OPTIONAL];
    • getAnnotationsOrThrow

      String getAnnotationsOrThrow(String key)
       Optional. Arbitrary key-value metadata storage e.g. to help client tools
       identify deployments during automation. See
       https://google.aip.dev/148#annotations for details on format and size
       limitations.
       
      map<string, string> annotations = 24 [(.google.api.field_behavior) = OPTIONAL];
    • hasProviderConfig

      boolean hasProviderConfig()
       Optional. This field specifies the provider configurations.
       
      .google.cloud.config.v1.ProviderConfig provider_config = 25 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the providerConfig field is set.
    • getProviderConfig

      ProviderConfig getProviderConfig()
       Optional. This field specifies the provider configurations.
       
      .google.cloud.config.v1.ProviderConfig provider_config = 25 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The providerConfig.
    • getProviderConfigOrBuilder

      ProviderConfigOrBuilder getProviderConfigOrBuilder()
       Optional. This field specifies the provider configurations.
       
      .google.cloud.config.v1.ProviderConfig provider_config = 25 [(.google.api.field_behavior) = OPTIONAL];
    • getBlueprintCase

      Deployment.BlueprintCase getBlueprintCase()