Package com.google.iam.v2
Interface PolicyOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Policy,Policy.Builder
@Generated
public interface PolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleanA key-value map to store arbitrary metadata for the `Policy`.Deprecated.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.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.A 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.Immutable.com.google.protobuf.ByteStringImmutable.getName()Immutable.com.google.protobuf.ByteStringImmutable.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`.getUid()Immutable.com.google.protobuf.ByteStringImmutable.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOutput only.booleanOutput only.booleanOutput only.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
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:
- The name.
-
getNameBytes
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];- Returns:
- The bytes for name.
-
getUid
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:
- The uid.
-
getUidBytes
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];- Returns:
- The bytes for uid.
-
getKind
String getKind()Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`.
string kind = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The kind.
-
getKindBytes
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];- Returns:
- The bytes for kind.
-
getDisplayName
String getDisplayName()A user-specified description of the `Policy`. This value can be up to 63 characters.
string display_name = 4;- Returns:
- The displayName.
-
getDisplayNameBytes
com.google.protobuf.ByteString getDisplayNameBytes()A user-specified description of the `Policy`. This value can be up to 63 characters.
string display_name = 4;- Returns:
- The bytes for displayName.
-
getAnnotationsCount
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; -
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; -
getAnnotations
Deprecated.UsegetAnnotationsMap()instead. -
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
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
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; -
getEtag
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:
- The etag.
-
getEtagBytes
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;- Returns:
- The bytes for etag.
-
hasCreateTime
boolean hasCreateTime()Output only. The time when the `Policy` was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
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];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
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]; -
hasUpdateTime
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:
- Whether the updateTime field is set.
-
getUpdateTime
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];- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
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]; -
hasDeleteTime
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:
- Whether the deleteTime field is set.
-
getDeleteTime
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];- Returns:
- The deleteTime.
-
getDeleteTimeOrBuilder
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]; -
getRulesList
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; -
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.v2.PolicyRule rules = 10; -
getRulesCount
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; -
getRulesOrBuilderList
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; -
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.v2.PolicyRule rules = 10; -
getManagingAuthority
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:
- The managingAuthority.
-
getManagingAuthorityBytes
com.google.protobuf.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:
- The bytes for managingAuthority.
-