public final class DeployPolicy extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SELECTORS_FIELD_NUMBER
public static final int SELECTORS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SUSPENDED_FIELD_NUMBER
public static final int SUSPENDED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static DeployPolicy getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DeployPolicy.Builder newBuilder()
newBuilder(DeployPolicy prototype)
public static DeployPolicy.Builder newBuilder(DeployPolicy prototype)
public static DeployPolicy parseDelimitedFrom(InputStream input)
public static DeployPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DeployPolicy parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DeployPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DeployPolicy parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DeployPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DeployPolicy parseFrom(CodedInputStream input)
public static DeployPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DeployPolicy parseFrom(InputStream input)
public static DeployPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DeployPolicy parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DeployPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DeployPolicy> parser()
Methods
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
|
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:
map<string, string> labels = 5;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAnnotations() (deprecated)
public Map<String,String> getAnnotations()
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;
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;
| 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.
|
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];
getDefaultInstanceForType()
public DeployPolicy getDefaultInstanceForType()
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.
|
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()
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:
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:
map<string, string> labels = 5;
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:
map<string, string> labels = 5;
| 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:
map<string, string> labels = 5;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
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.
|
getParserForType()
public Parser<DeployPolicy> getParserForType()
Overrides
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
|
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];
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
|
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
|
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];
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
|
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> |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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()
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.
|
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];
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
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.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DeployPolicy.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DeployPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public DeployPolicy.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
