Package com.google.iam.v2beta
Class Policy
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.iam.v2beta.Policy
- All Implemented Interfaces:
PolicyOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class Policy
extends com.google.protobuf.GeneratedMessage
implements PolicyOrBuilder
Data for an IAM policy.Protobuf type
google.iam.v2beta.Policy- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanA key-value map to store arbitrary metadata for the `Policy`.booleanDeprecated.intA key-value map to store arbitrary metadata for the `Policy`.A key-value map to store arbitrary metadata for the `Policy`.getAnnotationsOrDefault(String key, String defaultValue) A key-value map to store arbitrary metadata for the `Policy`.A key-value map to store arbitrary metadata for the `Policy`.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.static Policycom.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.static final com.google.protobuf.Descriptors.DescriptorA user-specified description of the `Policy`.com.google.protobuf.ByteStringA user-specified description of the `Policy`.getEtag()An opaque tag that identifies the current version of the `Policy`.com.google.protobuf.ByteStringAn opaque tag that identifies the current version of the `Policy`.getKind()Output only.com.google.protobuf.ByteStringOutput only.getName()Immutable.com.google.protobuf.ByteStringImmutable.com.google.protobuf.Parser<Policy>getRules(int index) A list of rules that specify the behavior of the `Policy`.intA list of rules that specify the behavior of the `Policy`.A list of rules that specify the behavior of the `Policy`.getRulesOrBuilder(int index) A list of rules that specify the behavior of the `Policy`.List<? extends PolicyRuleOrBuilder>A list of rules that specify the behavior of the `Policy`.intgetUid()Immutable.com.google.protobuf.ByteStringImmutable.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOutput only.booleanOutput only.inthashCode()booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic Policy.Builderstatic Policy.BuildernewBuilder(Policy prototype) protected Policy.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static PolicyparseDelimitedFrom(InputStream input) static PolicyparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PolicyparseFrom(byte[] data) static PolicyparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PolicyparseFrom(com.google.protobuf.ByteString data) static PolicyparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PolicyparseFrom(com.google.protobuf.CodedInputStream input) static PolicyparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PolicyparseFrom(InputStream input) static PolicyparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PolicyparseFrom(ByteBuffer data) static PolicyparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Policy>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER- See Also:
-
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER- See Also:
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER- See Also:
-
ANNOTATIONS_FIELD_NUMBER
public static final int ANNOTATIONS_FIELD_NUMBER- See Also:
-
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER- See Also:
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER- See Also:
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER- See Also:
-
DELETE_TIME_FIELD_NUMBER
public static final int DELETE_TIME_FIELD_NUMBER- See Also:
-
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
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];- Specified by:
getNamein interfacePolicyOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.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];- Specified by:
getNameBytesin interfacePolicyOrBuilder- Returns:
- The bytes for name.
-
getUid
Immutable. The globally unique ID of the `Policy`. Assigned automatically when the `Policy` is created.
string uid = 2 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getUidin interfacePolicyOrBuilder- Returns:
- The uid.
-
getUidBytes
public com.google.protobuf.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];- Specified by:
getUidBytesin interfacePolicyOrBuilder- Returns:
- The bytes for uid.
-
getKind
Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`.
string kind = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getKindin interfacePolicyOrBuilder- Returns:
- The kind.
-
getKindBytes
public com.google.protobuf.ByteString getKindBytes()Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`.
string kind = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getKindBytesin interfacePolicyOrBuilder- Returns:
- The bytes for kind.
-
getDisplayName
A user-specified description of the `Policy`. This value can be up to 63 characters.
string display_name = 4;- Specified by:
getDisplayNamein interfacePolicyOrBuilder- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.ByteString getDisplayNameBytes()A user-specified description of the `Policy`. This value can be up to 63 characters.
string display_name = 4;- Specified by:
getDisplayNameBytesin interfacePolicyOrBuilder- Returns:
- The bytes for displayName.
-
getAnnotationsCount
public int getAnnotationsCount()Description copied from interface:PolicyOrBuilderA 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;- Specified by:
getAnnotationsCountin interfacePolicyOrBuilder
-
containsAnnotations
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;- Specified by:
containsAnnotationsin interfacePolicyOrBuilder
-
getAnnotations
Deprecated.UsegetAnnotationsMap()instead.- Specified by:
getAnnotationsin interfacePolicyOrBuilder
-
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;- Specified by:
getAnnotationsMapin interfacePolicyOrBuilder
-
getAnnotationsOrDefault
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;- Specified by:
getAnnotationsOrDefaultin interfacePolicyOrBuilder
-
getAnnotationsOrThrow
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;- Specified by:
getAnnotationsOrThrowin interfacePolicyOrBuilder
-
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;- Specified by:
getEtagin interfacePolicyOrBuilder- Returns:
- The etag.
-
getEtagBytes
public com.google.protobuf.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;- Specified by:
getEtagBytesin interfacePolicyOrBuilder- Returns:
- The bytes for etag.
-
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];- Specified by:
hasCreateTimein interfacePolicyOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.Timestamp getCreateTime()Output only. The time when the `Policy` was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimein interfacePolicyOrBuilder- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. The time when the `Policy` was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimeOrBuilderin interfacePolicyOrBuilder
-
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];- Specified by:
hasUpdateTimein interfacePolicyOrBuilder- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.Timestamp getUpdateTime()Output only. The time when the `Policy` was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimein interfacePolicyOrBuilder- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The time when the `Policy` was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimeOrBuilderin interfacePolicyOrBuilder
-
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];- Specified by:
hasDeleteTimein interfacePolicyOrBuilder- Returns:
- Whether the deleteTime field is set.
-
getDeleteTime
public com.google.protobuf.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];- Specified by:
getDeleteTimein interfacePolicyOrBuilder- Returns:
- The deleteTime.
-
getDeleteTimeOrBuilder
public com.google.protobuf.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];- Specified by:
getDeleteTimeOrBuilderin interfacePolicyOrBuilder
-
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;- Specified by:
getRulesListin interfacePolicyOrBuilder
-
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;- Specified by:
getRulesOrBuilderListin interfacePolicyOrBuilder
-
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.v2beta.PolicyRule rules = 10;- Specified by:
getRulesCountin interfacePolicyOrBuilder
-
getRules
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;- Specified by:
getRulesin interfacePolicyOrBuilder
-
getRulesOrBuilder
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;- Specified by:
getRulesOrBuilderin interfacePolicyOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Policy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Policy parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Policy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Policy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Policy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Policy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Policy parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Policy parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Policy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Policy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-