- 1.56.0 (latest)
- 1.55.0
- 1.54.2
- 1.53.0
- 1.52.0
- 1.51.0
- 1.49.1
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.1
- 1.44.0
- 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
final
class
Policy
extends
GeneratedMessageV3
implements
PolicyOrBuilder
Data for an IAM policy.
Protobuf type google.iam.v2.Policy
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PolicyImplements
PolicyOrBuilderStatic Fields
ANNOTATIONS_FIELD_NUMBER
public
static
final
int
ANNOTATIONS_FIELD_NUMBER
CREATE_TIME_FIELD_NUMBER
public
static
final
int
CREATE_TIME_FIELD_NUMBER
DELETE_TIME_FIELD_NUMBER
public
static
final
int
DELETE_TIME_FIELD_NUMBER
DISPLAY_NAME_FIELD_NUMBER
public
static
final
int
DISPLAY_NAME_FIELD_NUMBER
ETAG_FIELD_NUMBER
public
static
final
int
ETAG_FIELD_NUMBER
KIND_FIELD_NUMBER
public
static
final
int
KIND_FIELD_NUMBER
MANAGING_AUTHORITY_FIELD_NUMBER
public
static
final
int
MANAGING_AUTHORITY_FIELD_NUMBER
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
RULES_FIELD_NUMBER
public
static
final
int
RULES_FIELD_NUMBER
UID_FIELD_NUMBER
public
static
final
int
UID_FIELD_NUMBER
UPDATE_TIME_FIELD_NUMBER
public
static
final
int
UPDATE_TIME_FIELD_NUMBER
Static Methods
getDefaultInstance()
public
static
Policy
getDefaultInstance
()
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
newBuilder()
public
static
Policy
.
Builder
newBuilder
()
newBuilder(Policy prototype)
public
static
Policy
.
Builder
newBuilder
(
Policy
prototype
)
parseDelimitedFrom(InputStream input)
public
static
Policy
parseDelimitedFrom
(
InputStream
input
)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Policy
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(byte[] data)
public
static
Policy
parseFrom
(
byte
[]
data
)
data
byte
[]
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Policy
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteString data)
public
static
Policy
parseFrom
(
ByteString
data
)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Policy
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(CodedInputStream input)
public
static
Policy
parseFrom
(
CodedInputStream
input
)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Policy
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(InputStream input)
public
static
Policy
parseFrom
(
InputStream
input
)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Policy
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteBuffer data)
public
static
Policy
parseFrom
(
ByteBuffer
data
)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Policy
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
parser()
public
static
Parser<Policy>
parser
()
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
)
getAnnotations()
public
Map<String
,
String
>
getAnnotations
()
Use #getAnnotationsMap() instead.
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
()
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;
getDisplayNameBytes()
public
ByteString
getDisplayNameBytes
()
A user-specified description of the Policy
. This value can be up to 63
characters.
string display_name = 4;
getEtag()
public
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;
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()
public
String
getKind
()
Output only. The kind of the Policy
. Always contains the value DenyPolicy
.
string kind = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
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];
getName()
public
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];
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
()
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;
getSerializedSize()
public
int
getSerializedSize
()
getUid()
public
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];
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];
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];
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];
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];
hashCode()
public
int
hashCode
()
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
internalGetMapField(int number)
protected
MapField
internalGetMapField
(
int
number
)
isInitialized()
public
final
boolean
isInitialized
()
newBuilderForType()
public
Policy
.
Builder
newBuilderForType
()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Policy
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
toBuilder()
public
Policy
.
Builder
toBuilder
()
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
