public final class Policy extends GeneratedMessageV3 implements PolicyOrBuilder
Data for an IAM policy.
Protobuf type google.iam.v2.Policy
Static Fields
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER
Field Value
MANAGING_AUTHORITY_FIELD_NUMBER
public static final int MANAGING_AUTHORITY_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER
Field Value
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Policy getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Policy.Builder newBuilder()
Returns
newBuilder(Policy prototype)
public static Policy.Builder newBuilder(Policy prototype)
Parameter
| Name | Description |
prototype | Policy
|
Returns
public static Policy parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Policy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Policy parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Policy parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Policy parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Policy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Policy parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Policy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Policy parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Policy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Policy> parser()
Returns
Methods
containsAnnotations(String key)
public 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;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAnnotations()
public Map<String,String> getAnnotations()
Returns
getAnnotationsCount()
public 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;
getAnnotationsMap()
public 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;
getAnnotationsOrDefault(String key, String defaultValue)
public 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;
getAnnotationsOrThrow(String key)
public 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;
getCreateTime()
public Timestamp getCreateTime()
Output only. The time when the Policy was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time when the Policy was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Policy getDefaultInstanceForType()
Returns
getDeleteTime()
public 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];
getDeleteTimeOrBuilder()
public 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];
getDisplayName()
public String getDisplayName()
A user-specified description of the Policy. This value can be up to 63
characters.
string display_name = 4;
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
A user-specified description of the Policy. This value can be up to 63
characters.
string display_name = 4;
| Type | Description |
ByteString | The bytes for displayName.
|
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;
| Type | Description |
String | The etag.
|
getEtagBytes()
public 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;
getKind()
Output only. The kind of the Policy. Always contains the value DenyPolicy.
string kind = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
String | The kind.
|
getKindBytes()
public ByteString getKindBytes()
Output only. The kind of the Policy. Always contains the value DenyPolicy.
string kind = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getManagingAuthority()
public 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];
| Type | Description |
String | The managingAuthority.
|
getManagingAuthorityBytes()
public 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];
| Type | Description |
ByteString | The bytes for managingAuthority.
|
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];
| Type | Description |
String | The name.
|
getNameBytes()
public 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];
getParserForType()
public Parser<Policy> getParserForType()
Returns
Overrides
getRules(int index)
public 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;
getRulesCount()
public 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;
getRulesList()
public 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;
getRulesOrBuilder(int index)
public 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;
getRulesOrBuilderList()
public 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;
| Type | Description |
List<? extends com.google.iam.v2.PolicyRuleOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUid()
Immutable. The globally unique ID of the Policy. Assigned automatically when the
Policy is created.
string uid = 2 [(.google.api.field_behavior) = IMMUTABLE];
getUidBytes()
public 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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The time when the Policy was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time when the Policy was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. The time when the Policy was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
boolean | Whether the createTime field is set.
|
hasDeleteTime()
public 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];
| Type | Description |
boolean | Whether the deleteTime field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The time when the Policy was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Policy.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Policy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Policy.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
