Class DeployPolicy.Builder (1.51.0) 

public static final class DeployPolicy.Builder extends GeneratedMessageV3.Builder<DeployPolicy.Builder> implements DeployPolicyOrBuilder

A DeployPolicy resource in the Cloud Deploy API.

A DeployPolicy inhibits manual or automation-driven actions within a Delivery Pipeline or Target.

Protobuf type google.cloud.deploy.v1.DeployPolicy

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DeployPolicy.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllRules(Iterable<? extends PolicyRule> values)

public DeployPolicy.Builder addAllRules(Iterable<? extends PolicyRule> values)

Required. Rules to apply. At least one rule must be present.

repeated .google.cloud.deploy.v1.PolicyRule rules = 10 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Iterable<? extends com.google.cloud.deploy.v1.PolicyRule>
Returns
Type Description
DeployPolicy.Builder

addAllSelectors(Iterable<? extends DeployPolicyResourceSelector> values)

public DeployPolicy.Builder addAllSelectors(Iterable<? extends DeployPolicyResourceSelector> values)

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.deploy.v1.DeployPolicyResourceSelector>
Returns
Type Description
DeployPolicy.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DeployPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DeployPolicy.Builder
Overrides

addRules(PolicyRule value)

public DeployPolicy.Builder addRules(PolicyRule value)

Required. Rules to apply. At least one rule must be present.

repeated .google.cloud.deploy.v1.PolicyRule rules = 10 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value PolicyRule
Returns
Type Description
DeployPolicy.Builder

addRules(PolicyRule.Builder builderForValue)

public DeployPolicy.Builder addRules(PolicyRule.Builder builderForValue)

Required. Rules to apply. At least one rule must be present.

repeated .google.cloud.deploy.v1.PolicyRule rules = 10 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue PolicyRule.Builder
Returns
Type Description
DeployPolicy.Builder

addRules(int index, PolicyRule value)

public DeployPolicy.Builder addRules(int index, PolicyRule value)

Required. Rules to apply. At least one rule must be present.

repeated .google.cloud.deploy.v1.PolicyRule rules = 10 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value PolicyRule
Returns
Type Description
DeployPolicy.Builder

addRules(int index, PolicyRule.Builder builderForValue)

public DeployPolicy.Builder addRules(int index, PolicyRule.Builder builderForValue)

Required. Rules to apply. At least one rule must be present.

repeated .google.cloud.deploy.v1.PolicyRule rules = 10 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue PolicyRule.Builder
Returns
Type Description
DeployPolicy.Builder

addRulesBuilder()

public PolicyRule.Builder addRulesBuilder()

Required. Rules to apply. At least one rule must be present.

repeated .google.cloud.deploy.v1.PolicyRule rules = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PolicyRule.Builder

addRulesBuilder(int index)

public PolicyRule.Builder addRulesBuilder(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];

Parameter
Name Description
index int
Returns
Type Description
PolicyRule.Builder

addSelectors(DeployPolicyResourceSelector value)

public DeployPolicy.Builder addSelectors(DeployPolicyResourceSelector value)

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

Parameter
Name Description
value DeployPolicyResourceSelector
Returns
Type Description
DeployPolicy.Builder

addSelectors(DeployPolicyResourceSelector.Builder builderForValue)

public DeployPolicy.Builder addSelectors(DeployPolicyResourceSelector.Builder builderForValue)

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

Parameter
Name Description
builderForValue DeployPolicyResourceSelector.Builder
Returns
Type Description
DeployPolicy.Builder

addSelectors(int index, DeployPolicyResourceSelector value)

public DeployPolicy.Builder addSelectors(int index, DeployPolicyResourceSelector value)

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

Parameters
Name Description
index int
value DeployPolicyResourceSelector
Returns
Type Description
DeployPolicy.Builder

addSelectors(int index, DeployPolicyResourceSelector.Builder builderForValue)

public DeployPolicy.Builder addSelectors(int index, DeployPolicyResourceSelector.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue DeployPolicyResourceSelector.Builder
Returns
Type Description
DeployPolicy.Builder

addSelectorsBuilder()

public DeployPolicyResourceSelector.Builder addSelectorsBuilder()

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

Returns
Type Description
DeployPolicyResourceSelector.Builder

addSelectorsBuilder(int index)

public DeployPolicyResourceSelector.Builder addSelectorsBuilder(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];

Parameter
Name Description
index int
Returns
Type Description
DeployPolicyResourceSelector.Builder

build()

public DeployPolicy build()
Returns
Type Description
DeployPolicy

buildPartial()

public DeployPolicy buildPartial()
Returns
Type Description
DeployPolicy

clear()

public DeployPolicy.Builder clear()
Returns
Type Description
DeployPolicy.Builder
Overrides

clearAnnotations()

public DeployPolicy.Builder clearAnnotations()
Returns
Type Description
DeployPolicy.Builder

clearCreateTime()

public DeployPolicy.Builder clearCreateTime()

Output only. Time at which the deploy policy was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DeployPolicy.Builder

clearDescription()

public DeployPolicy.Builder clearDescription()

Description of the DeployPolicy. Max length is 255 characters.

string description = 3;

Returns
Type Description
DeployPolicy.Builder

This builder for chaining.

clearEtag()

public DeployPolicy.Builder clearEtag()

The weak etag of the Automation 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
Type Description
DeployPolicy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DeployPolicy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DeployPolicy.Builder
Overrides

clearLabels()

public DeployPolicy.Builder clearLabels()
Returns
Type Description
DeployPolicy.Builder

clearName()

public DeployPolicy.Builder clearName()

Output only. Name of the DeployPolicy. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}. The deployPolicy component must match a-z?

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DeployPolicy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DeployPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DeployPolicy.Builder
Overrides

clearRules()

public DeployPolicy.Builder clearRules()

Required. Rules to apply. At least one rule must be present.

repeated .google.cloud.deploy.v1.PolicyRule rules = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DeployPolicy.Builder

clearSelectors()

public DeployPolicy.Builder clearSelectors()

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

Returns
Type Description
DeployPolicy.Builder

clearSuspended()

public DeployPolicy.Builder clearSuspended()

When suspended, the policy will not prevent actions from occurring, even if the action violates the policy.

bool suspended = 8;

Returns
Type Description
DeployPolicy.Builder

This builder for chaining.

clearUid()

public DeployPolicy.Builder clearUid()

Output only. Unique identifier of the DeployPolicy.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DeployPolicy.Builder

This builder for chaining.

clearUpdateTime()

public DeployPolicy.Builder clearUpdateTime()

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
Type Description
DeployPolicy.Builder

clone()

public DeployPolicy.Builder clone()
Returns
Type Description
DeployPolicy.Builder
Overrides

containsAnnotations(String key)

public boolean containsAnnotations(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsLabels(String key)

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

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

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;

Returns
Type Description
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

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;

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
String

getCreateTime()

public 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
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Time at which the deploy policy was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time at which the deploy policy was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public DeployPolicy getDefaultInstanceForType()
Returns
Type Description
DeployPolicy

getDescription()

public String getDescription()

Description of the DeployPolicy. Max length is 255 characters.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the DeployPolicy. Max length is 255 characters.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEtag()

public String getEtag()

The weak etag of the Automation 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
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

The weak etag of the Automation 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
Type Description
ByteString

The bytes for etag.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

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

Returns
Type Description
int

getLabelsMap()

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

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

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

Parameter
Name Description
key String
Returns
Type Description
String

getMutableAnnotations() (deprecated)

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Output only. Name of the DeployPolicy. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}. The deployPolicy component must match a-z?

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Name of the DeployPolicy. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}. The deployPolicy component must match a-z?

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getRules(int index)

public 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];

Parameter
Name Description
index int
Returns
Type Description
PolicyRule

getRulesBuilder(int index)

public PolicyRule.Builder getRulesBuilder(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];

Parameter
Name Description
index int
Returns
Type Description
PolicyRule.Builder

getRulesBuilderList()

public List<PolicyRule.Builder> getRulesBuilderList()

Required. Rules to apply. At least one rule must be present.

repeated .google.cloud.deploy.v1.PolicyRule rules = 10 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<Builder>

getRulesCount()

public 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];

Returns
Type Description
int

getRulesList()

public 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];

Returns
Type Description
List<PolicyRule>

getRulesOrBuilder(int index)

public 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];

Parameter
Name Description
index int
Returns
Type Description
PolicyRuleOrBuilder

getRulesOrBuilderList()

public 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];

Returns
Type Description
List<? extends com.google.cloud.deploy.v1.PolicyRuleOrBuilder>

getSelectors(int index)

public 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];

Parameter
Name Description
index int
Returns
Type Description
DeployPolicyResourceSelector

getSelectorsBuilder(int index)

public DeployPolicyResourceSelector.Builder getSelectorsBuilder(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];

Parameter
Name Description
index int
Returns
Type Description
DeployPolicyResourceSelector.Builder

getSelectorsBuilderList()

public List<DeployPolicyResourceSelector.Builder> getSelectorsBuilderList()

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

Returns
Type Description
List<Builder>

getSelectorsCount()

public 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];

Returns
Type Description
int

getSelectorsList()

public 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];

Returns
Type Description
List<DeployPolicyResourceSelector>

getSelectorsOrBuilder(int index)

public 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];

Parameter
Name Description
index int
Returns
Type Description
DeployPolicyResourceSelectorOrBuilder

getSelectorsOrBuilderList()

public 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];

Returns
Type Description
List<? extends com.google.cloud.deploy.v1.DeployPolicyResourceSelectorOrBuilder>

getSuspended()

public boolean getSuspended()

When suspended, the policy will not prevent actions from occurring, even if the action violates the policy.

bool suspended = 8;

Returns
Type Description
boolean

The suspended.

getUid()

public String getUid()

Output only. Unique identifier of the DeployPolicy.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. Unique identifier of the DeployPolicy.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public 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
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Type Description
Builder

getUpdateTimeOrBuilder()

public 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];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public 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
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public 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
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public DeployPolicy.Builder mergeCreateTime(Timestamp value)

Output only. Time at which the deploy policy was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DeployPolicy.Builder

mergeFrom(DeployPolicy other)

public DeployPolicy.Builder mergeFrom(DeployPolicy other)
Parameter
Name Description
other DeployPolicy
Returns
Type Description
DeployPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DeployPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DeployPolicy.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DeployPolicy.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DeployPolicy.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DeployPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DeployPolicy.Builder
Overrides

mergeUpdateTime(Timestamp value)

public DeployPolicy.Builder mergeUpdateTime(Timestamp value)

Output only. Most recent time at which the deploy policy was updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DeployPolicy.Builder

putAllAnnotations(Map<String,String> values)

public DeployPolicy.Builder putAllAnnotations(Map<String,String> values)

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;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
DeployPolicy.Builder

putAllLabels(Map<String,String> values)

public DeployPolicy.Builder putAllLabels(Map<String,String> values)

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;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
DeployPolicy.Builder

putAnnotations(String key, String value)

public DeployPolicy.Builder putAnnotations(String key, String value)

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;

Parameters
Name Description
key String
value String
Returns
Type Description
DeployPolicy.Builder

putLabels(String key, String value)

public DeployPolicy.Builder putLabels(String key, String value)

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;

Parameters
Name Description
key String
value String
Returns
Type Description
DeployPolicy.Builder

removeAnnotations(String key)

public DeployPolicy.Builder removeAnnotations(String key)

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;

Parameter
Name Description
key String
Returns
Type Description
DeployPolicy.Builder

removeLabels(String key)

public DeployPolicy.Builder removeLabels(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;

Parameter
Name Description
key String
Returns
Type Description
DeployPolicy.Builder

removeRules(int index)

public DeployPolicy.Builder removeRules(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];

Parameter
Name Description
index int
Returns
Type Description
DeployPolicy.Builder

removeSelectors(int index)

public DeployPolicy.Builder removeSelectors(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];

Parameter
Name Description
index int
Returns
Type Description
DeployPolicy.Builder

setCreateTime(Timestamp value)

public DeployPolicy.Builder setCreateTime(Timestamp value)

Output only. Time at which the deploy policy was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DeployPolicy.Builder

setCreateTime(Timestamp.Builder builderForValue)

public DeployPolicy.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time at which the deploy policy was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DeployPolicy.Builder

setDescription(String value)

public DeployPolicy.Builder setDescription(String value)

Description of the DeployPolicy. Max length is 255 characters.

string description = 3;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
DeployPolicy.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public DeployPolicy.Builder setDescriptionBytes(ByteString value)

Description of the DeployPolicy. Max length is 255 characters.

string description = 3;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
DeployPolicy.Builder

This builder for chaining.

setEtag(String value)

public DeployPolicy.Builder setEtag(String value)

The weak etag of the Automation 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;

Parameter
Name Description
value String

The etag to set.
Returns
Type Description
DeployPolicy.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public DeployPolicy.Builder setEtagBytes(ByteString value)

The weak etag of the Automation 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;

Parameter
Name Description
value ByteString

The bytes for etag to set.
Returns
Type Description
DeployPolicy.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public DeployPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DeployPolicy.Builder
Overrides

setName(String value)

public DeployPolicy.Builder setName(String value)

Output only. Name of the DeployPolicy. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}. The deployPolicy component must match a-z?

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
DeployPolicy.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DeployPolicy.Builder setNameBytes(ByteString value)

Output only. Name of the DeployPolicy. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}. The deployPolicy component must match a-z?

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
DeployPolicy.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public DeployPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DeployPolicy.Builder
Overrides

setRules(int index, PolicyRule value)

public DeployPolicy.Builder setRules(int index, PolicyRule value)

Required. Rules to apply. At least one rule must be present.

repeated .google.cloud.deploy.v1.PolicyRule rules = 10 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
value PolicyRule
Returns
Type Description
DeployPolicy.Builder

setRules(int index, PolicyRule.Builder builderForValue)

public DeployPolicy.Builder setRules(int index, PolicyRule.Builder builderForValue)

Required. Rules to apply. At least one rule must be present.

repeated .google.cloud.deploy.v1.PolicyRule rules = 10 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
index int
builderForValue PolicyRule.Builder
Returns
Type Description
DeployPolicy.Builder

setSelectors(int index, DeployPolicyResourceSelector value)

public DeployPolicy.Builder setSelectors(int index, DeployPolicyResourceSelector value)

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

Parameters
Name Description
index int
value DeployPolicyResourceSelector
Returns
Type Description
DeployPolicy.Builder

setSelectors(int index, DeployPolicyResourceSelector.Builder builderForValue)

public DeployPolicy.Builder setSelectors(int index, DeployPolicyResourceSelector.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue DeployPolicyResourceSelector.Builder
Returns
Type Description
DeployPolicy.Builder

setSuspended(boolean value)

public DeployPolicy.Builder setSuspended(boolean value)

When suspended, the policy will not prevent actions from occurring, even if the action violates the policy.

bool suspended = 8;

Parameter
Name Description
value boolean

The suspended to set.
Returns
Type Description
DeployPolicy.Builder

This builder for chaining.

setUid(String value)

public DeployPolicy.Builder setUid(String value)

Output only. Unique identifier of the DeployPolicy.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The uid to set.
Returns
Type Description
DeployPolicy.Builder

This builder for chaining.

setUidBytes(ByteString value)

public DeployPolicy.Builder setUidBytes(ByteString value)

Output only. Unique identifier of the DeployPolicy.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for uid to set.
Returns
Type Description
DeployPolicy.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DeployPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DeployPolicy.Builder
Overrides

setUpdateTime(Timestamp value)

public DeployPolicy.Builder setUpdateTime(Timestamp value)

Output only. Most recent time at which the deploy policy was updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
DeployPolicy.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public DeployPolicy.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. Most recent time at which the deploy policy was updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
DeployPolicy.Builder