Package com.google.cloud.deploy.v1

Interface DeployPolicyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DeployPolicy, DeployPolicy.Builder
@Generated public interface DeployPolicyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Output only. Name of the `DeployPolicy`. Format is
 `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
 The `deployPolicy` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. Name of the `DeployPolicy`. Format is
 `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.
 The `deployPolicy` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for name.

    • getUid

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

    • getUidBytes

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

    • getDescription

      String getDescription()
       Optional. Description of the `DeployPolicy`. Max length is 255 characters.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description of the `DeployPolicy`. Max length is 255 characters.
      string description = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for description.

    • getAnnotationsCount

      int getAnnotationsCount()
       Optional. User annotations. These attributes can only be set and used by
 the user, and not by Cloud Deploy. Annotations must meet the following
 constraints:

 * Annotations are key/value pairs.
 * Valid annotation keys have two segments: an optional prefix and name,
 separated by a slash (`/`).
 * The name segment is required and must be 63 characters or less,
 beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with
 dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.
 * The prefix is optional. If specified, the prefix must be a DNS subdomain:
 a series of DNS labels separated by dots(`.`), not longer than 253
 characters in total, followed by a slash (`/`).

 See
 https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set
 for more details.
      map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];

    • containsAnnotations

      boolean containsAnnotations(String key)
       Optional. User annotations. These attributes can only be set and used by
 the user, and not by Cloud Deploy. Annotations must meet the following
 constraints:

 * Annotations are key/value pairs.
 * Valid annotation keys have two segments: an optional prefix and name,
 separated by a slash (`/`).
 * The name segment is required and must be 63 characters or less,
 beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with
 dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.
 * The prefix is optional. If specified, the prefix must be a DNS subdomain:
 a series of DNS labels separated by dots(`.`), not longer than 253
 characters in total, followed by a slash (`/`).

 See
 https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set
 for more details.
      map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotations

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

    • getAnnotationsMap

      Map<String,String> getAnnotationsMap()
       Optional. User annotations. These attributes can only be set and used by
 the user, and not by Cloud Deploy. Annotations must meet the following
 constraints:

 * Annotations are key/value pairs.
 * Valid annotation keys have two segments: an optional prefix and name,
 separated by a slash (`/`).
 * The name segment is required and must be 63 characters or less,
 beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with
 dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.
 * The prefix is optional. If specified, the prefix must be a DNS subdomain:
 a series of DNS labels separated by dots(`.`), not longer than 253
 characters in total, followed by a slash (`/`).

 See
 https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set
 for more details.
      map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotationsOrDefault

      String getAnnotationsOrDefault(String key, String defaultValue)
       Optional. User annotations. These attributes can only be set and used by
 the user, and not by Cloud Deploy. Annotations must meet the following
 constraints:

 * Annotations are key/value pairs.
 * Valid annotation keys have two segments: an optional prefix and name,
 separated by a slash (`/`).
 * The name segment is required and must be 63 characters or less,
 beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with
 dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.
 * The prefix is optional. If specified, the prefix must be a DNS subdomain:
 a series of DNS labels separated by dots(`.`), not longer than 253
 characters in total, followed by a slash (`/`).

 See
 https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set
 for more details.
      map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getAnnotationsOrThrow

      String getAnnotationsOrThrow(String key)
       Optional. User annotations. These attributes can only be set and used by
 the user, and not by Cloud Deploy. Annotations must meet the following
 constraints:

 * Annotations are key/value pairs.
 * Valid annotation keys have two segments: an optional prefix and name,
 separated by a slash (`/`).
 * The name segment is required and must be 63 characters or less,
 beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with
 dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between.
 * The prefix is optional. If specified, the prefix must be a DNS subdomain:
 a series of DNS labels separated by dots(`.`), not longer than 253
 characters in total, followed by a slash (`/`).

 See
 https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set
 for more details.
      map<string, string> annotations = 4 [(.google.api.field_behavior) = OPTIONAL];

    • 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;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • 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;

    • hasCreateTime

      boolean hasCreateTime()
       Output only. Time at which the deploy policy 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 deploy policy 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 deploy policy was created.
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. Most recent time at which the deploy policy was updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. Most recent time at which the deploy policy was updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Most recent time at which the deploy policy was updated.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getSuspended

      boolean getSuspended()
       Optional. When suspended, the policy will not prevent actions from
 occurring, even if the action violates the policy.
      bool suspended = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The suspended.

    • getSelectorsList

      List<DeployPolicyResourceSelector> getSelectorsList()
       Required. Selected resources to which the policy will be applied. At least
 one selector is required. If one selector matches the resource the policy
 applies. For example, if there are two selectors and the action being
 attempted matches one of them, the policy will apply to that action.
      repeated .google.cloud.deploy.v1.DeployPolicyResourceSelector selectors = 12 [(.google.api.field_behavior) = REQUIRED];

    • getSelectors

      DeployPolicyResourceSelector getSelectors(int index)
       Required. Selected resources to which the policy will be applied. At least
 one selector is required. If one selector matches the resource the policy
 applies. For example, if there are two selectors and the action being
 attempted matches one of them, the policy will apply to that action.
      repeated .google.cloud.deploy.v1.DeployPolicyResourceSelector selectors = 12 [(.google.api.field_behavior) = REQUIRED];

    • getSelectorsCount

      int getSelectorsCount()
       Required. Selected resources to which the policy will be applied. At least
 one selector is required. If one selector matches the resource the policy
 applies. For example, if there are two selectors and the action being
 attempted matches one of them, the policy will apply to that action.
      repeated .google.cloud.deploy.v1.DeployPolicyResourceSelector selectors = 12 [(.google.api.field_behavior) = REQUIRED];

    • getSelectorsOrBuilderList

      List<? extends DeployPolicyResourceSelectorOrBuilder> getSelectorsOrBuilderList()
       Required. Selected resources to which the policy will be applied. At least
 one selector is required. If one selector matches the resource the policy
 applies. For example, if there are two selectors and the action being
 attempted matches one of them, the policy will apply to that action.
      repeated .google.cloud.deploy.v1.DeployPolicyResourceSelector selectors = 12 [(.google.api.field_behavior) = REQUIRED];

    • getSelectorsOrBuilder

      DeployPolicyResourceSelectorOrBuilder getSelectorsOrBuilder(int index)
       Required. Selected resources to which the policy will be applied. At least
 one selector is required. If one selector matches the resource the policy
 applies. For example, if there are two selectors and the action being
 attempted matches one of them, the policy will apply to that action.
      repeated .google.cloud.deploy.v1.DeployPolicyResourceSelector selectors = 12 [(.google.api.field_behavior) = REQUIRED];

    • getRulesList

      List<PolicyRule> getRulesList()
       Required. Rules to apply. At least one rule must be present.
      repeated .google.cloud.deploy.v1.PolicyRule rules = 10 [(.google.api.field_behavior) = REQUIRED];

    • getRules

      PolicyRule getRules(int index)
       Required. Rules to apply. At least one rule must be present.
      repeated .google.cloud.deploy.v1.PolicyRule rules = 10 [(.google.api.field_behavior) = REQUIRED];

    • getRulesCount

      int getRulesCount()
       Required. Rules to apply. At least one rule must be present.
      repeated .google.cloud.deploy.v1.PolicyRule rules = 10 [(.google.api.field_behavior) = REQUIRED];

    • getRulesOrBuilderList

      List<? extends PolicyRuleOrBuilder> getRulesOrBuilderList()
       Required. Rules to apply. At least one rule must be present.
      repeated .google.cloud.deploy.v1.PolicyRule rules = 10 [(.google.api.field_behavior) = REQUIRED];

    • getRulesOrBuilder

      PolicyRuleOrBuilder getRulesOrBuilder(int index)
       Required. Rules to apply. At least one rule must be present.
      repeated .google.cloud.deploy.v1.PolicyRule rules = 10 [(.google.api.field_behavior) = REQUIRED];

    • getEtag

      String getEtag()
       The weak etag of the `DeployPolicy` resource.
 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 = 11;
      Returns:
      The etag.

    • getEtagBytes

      com.google.protobuf.ByteString getEtagBytes()
       The weak etag of the `DeployPolicy` resource.
 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 = 11;
      Returns:
      The bytes for etag.