Interface PolicyOrBuilder (1.6.20)

Version 1.6.20

• 1.44.0 (latest)
• 1.43.0
• 1.41.0
• 1.40.1
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.1
• 1.33.0
• 1.32.1
• 1.31.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.1
• 1.19.0
• 1.18.1
• 1.17.1
• 1.16.1
• 1.10.0
• 1.9.3
• 1.8.0
• 1.7.0
• 1.6.23
• 1.5.1
• 1.4.1
• 1.3.4
• 1.2.12

public interface PolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract boolean containsAnnotations(String key)

A key-value map to store arbitrary metadata for the Policy. Keys can be up to 63 characters. Values can be up to 255 characters.

map<string, string> annotations = 5;

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

getAnnotations()

public abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns

Type	Description
Map<String,String>

getAnnotationsCount()

public abstract int getAnnotationsCount()

A key-value map to store arbitrary metadata for the Policy. Keys can be up to 63 characters. Values can be up to 255 characters.

map<string, string> annotations = 5;

Returns

Type	Description
int

getAnnotationsMap()

public abstract Map<String,String> getAnnotationsMap()

A key-value map to store arbitrary metadata for the Policy. Keys can be up to 63 characters. Values can be up to 255 characters.

map<string, string> annotations = 5;

Returns

Type	Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public abstract String getAnnotationsOrDefault(String key, String defaultValue)

A key-value map to store arbitrary metadata for the Policy. Keys can be up to 63 characters. Values can be up to 255 characters.

map<string, string> annotations = 5;

Parameters

Name	Description
key	String
defaultValue	String

Returns

Type	Description
String

getAnnotationsOrThrow(String key)

public abstract String getAnnotationsOrThrow(String key)

A key-value map to store arbitrary metadata for the Policy. Keys can be up to 63 characters. Values can be up to 255 characters.

map<string, string> annotations = 5;

Parameter

Name	Description
key	String

Returns

Type	Description
String

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The time when the Policy was created.

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

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the Policy was created.

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

Returns

Type	Description
TimestampOrBuilder

getDeleteTime()

public abstract Timestamp getDeleteTime()

Output only. The time when the Policy was deleted. Empty if the policy is not deleted.

.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Timestamp	The deleteTime.

getDeleteTimeOrBuilder()

public abstract TimestampOrBuilder getDeleteTimeOrBuilder()

Output only. The time when the Policy was deleted. Empty if the policy is not deleted.

.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

A user-specified description of the Policy. This value can be up to 63 characters.

string display_name = 4;

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

A user-specified description of the Policy. This value can be up to 63 characters.

string display_name = 4;

Returns

Type	Description
ByteString	The bytes for displayName.

getEtag()

public abstract String getEtag()

An opaque tag that identifies the current version of the Policy. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another. If this field is present in a [CreatePolicy][] request, the value is ignored.

string etag = 6;

Returns

Type	Description
String	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

An opaque tag that identifies the current version of the Policy. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another. If this field is present in a [CreatePolicy][] request, the value is ignored.

string etag = 6;

Returns

Type	Description
ByteString	The bytes for etag.

getKind()

public abstract String getKind()

Output only. The kind of the Policy. Always contains the value DenyPolicy.

string kind = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
String	The kind.

getKindBytes()

public abstract ByteString getKindBytes()

Output only. The kind of the Policy. Always contains the value DenyPolicy.

string kind = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
ByteString	The bytes for kind.

getName()

public abstract String getName()

Immutable. The resource name of the Policy, which must be unique. Format: policies/{attachment_point}/denypolicies/{policy_id} The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, /, must be written as %2F. For example, policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy. For organizations and folders, use the numeric ID in the full resource name. For projects, requests can use the alphanumeric or the numeric ID. Responses always contain the numeric ID.

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

Returns

Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Immutable. The resource name of the Policy, which must be unique. Format: policies/{attachment_point}/denypolicies/{policy_id} The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, /, must be written as %2F. For example, policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy. For organizations and folders, use the numeric ID in the full resource name. For projects, requests can use the alphanumeric or the numeric ID. Responses always contain the numeric ID.

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

Returns

Type	Description
ByteString	The bytes for name.

getRules(int index)

public abstract PolicyRule getRules(int index)

A list of rules that specify the behavior of the Policy. All of the rules should be of the kind specified in the Policy.

repeated .google.iam.v2beta.PolicyRule rules = 10;

Parameter

Name	Description
index	int

Returns

Type	Description
PolicyRule

getRulesCount()

public abstract int getRulesCount()

A list of rules that specify the behavior of the Policy. All of the rules should be of the kind specified in the Policy.

repeated .google.iam.v2beta.PolicyRule rules = 10;

Returns

Type	Description
int

getRulesList()

public abstract List<PolicyRule> getRulesList()

A list of rules that specify the behavior of the Policy. All of the rules should be of the kind specified in the Policy.

repeated .google.iam.v2beta.PolicyRule rules = 10;

Returns

Type	Description
List<PolicyRule>

getRulesOrBuilder(int index)

public abstract PolicyRuleOrBuilder getRulesOrBuilder(int index)

A list of rules that specify the behavior of the Policy. All of the rules should be of the kind specified in the Policy.

repeated .google.iam.v2beta.PolicyRule rules = 10;

Parameter

Name	Description
index	int

Returns

Type	Description
PolicyRuleOrBuilder

getRulesOrBuilderList()

public abstract List<? extends PolicyRuleOrBuilder> getRulesOrBuilderList()

A list of rules that specify the behavior of the Policy. All of the rules should be of the kind specified in the Policy.

repeated .google.iam.v2beta.PolicyRule rules = 10;

Returns

Type	Description
List<? extends com.google.iam.v2beta.PolicyRuleOrBuilder>

getUid()

public abstract String getUid()

Immutable. The globally unique ID of the Policy. Assigned automatically when the Policy is created.

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

Returns

Type	Description
String	The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Immutable. The globally unique ID of the Policy. Assigned automatically when the Policy is created.

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

Returns

Type	Description
ByteString	The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The time when the Policy was last updated.

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

Returns

Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time when the Policy was last updated.

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

Returns

Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The time when the Policy was created.

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

Returns

Type	Description
boolean	Whether the createTime field is set.

hasDeleteTime()

public abstract boolean hasDeleteTime()

Output only. The time when the Policy was deleted. Empty if the policy is not deleted.

.google.protobuf.Timestamp delete_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the deleteTime field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The time when the Policy was last updated.

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

Returns

Type	Description
boolean	Whether the updateTime field is set.