public interface PolicyOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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() (deprecated)
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. |
getManagingAuthority()
public abstract String getManagingAuthority()Immutable. Specifies that this policy is managed by an authority and can only be modified by that authority. Usage is restricted.
string managing_authority = 11 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
String |
The managingAuthority. |
getManagingAuthorityBytes()
public abstract ByteString getManagingAuthorityBytes()Immutable. Specifies that this policy is managed by an authority and can only be modified by that authority. Usage is restricted.
string managing_authority = 11 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for managingAuthority. |
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.v2.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.v2.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.v2.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.v2.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.v2.PolicyRule rules = 10;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.iam.v2.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. |