Class AccessPolicy.Builder (1.67.0)

public static final class AccessPolicy.Builder extends GeneratedMessage.Builder<AccessPolicy.Builder> implements AccessPolicyOrBuilder

An IAM access policy resource.

Protobuf type google.iam.v3beta.AccessPolicy

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public AccessPolicy build()
Returns
Type Description
AccessPolicy

buildPartial()

public AccessPolicy buildPartial()
Returns
Type Description
AccessPolicy

clear()

public AccessPolicy.Builder clear()
Returns
Type Description
AccessPolicy.Builder
Overrides

clearAnnotations()

public AccessPolicy.Builder clearAnnotations()
Returns
Type Description
AccessPolicy.Builder

clearCreateTime()

public AccessPolicy.Builder clearCreateTime()

Output only. The time when the access policy was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AccessPolicy.Builder

clearDetails()

public AccessPolicy.Builder clearDetails()

Optional. The details for the access policy.

.google.iam.v3beta.AccessPolicyDetails details = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AccessPolicy.Builder

clearDisplayName()

public AccessPolicy.Builder clearDisplayName()

Optional. The description of the access policy. Must be less than or equal to 63 characters.

string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AccessPolicy.Builder

This builder for chaining.

clearEtag()

public AccessPolicy.Builder clearEtag()

Optional. The etag for the access policy. If this is provided on update, it must match the server's etag.

string etag = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AccessPolicy.Builder

This builder for chaining.

clearName()

public AccessPolicy.Builder clearName()

Identifier. The resource name of the access policy.

The following formats are supported:

  • projects/{project_id}/locations/{location}/accessPolicies/{policy_id}
  • projects/{project_number}/locations/{location}/accessPolicies/{policy_id}
  • folders/{folder_id}/locations/{location}/accessPolicies/{policy_id}
  • organizations/{organization_id}/locations/{location}/accessPolicies/{policy_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
AccessPolicy.Builder

This builder for chaining.

clearUid()

public AccessPolicy.Builder clearUid()

Output only. The globally unique ID of the access policy.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
AccessPolicy.Builder

This builder for chaining.

clearUpdateTime()

public AccessPolicy.Builder clearUpdateTime()

Output only. The time when the access policy was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AccessPolicy.Builder

containsAnnotations(String key)

public boolean containsAnnotations(String key)

Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getAnnotations() (deprecated)

public Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type Description
Map<String,String>

getAnnotationsCount()

public int getAnnotationsCount()

Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAnnotationsMap()

public Map<String,String> getAnnotationsMap()

Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getAnnotationsOrDefault(String key, String defaultValue)

public String getAnnotationsOrDefault(String key, String defaultValue)

Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getAnnotationsOrThrow(String key)

public String getAnnotationsOrThrow(String key)

Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the access policy was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the access policy was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the access policy was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public AccessPolicy getDefaultInstanceForType()
Returns
Type Description
AccessPolicy

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDetails()

public AccessPolicyDetails getDetails()

Optional. The details for the access policy.

.google.iam.v3beta.AccessPolicyDetails details = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AccessPolicyDetails

The details.

getDetailsBuilder()

public AccessPolicyDetails.Builder getDetailsBuilder()

Optional. The details for the access policy.

.google.iam.v3beta.AccessPolicyDetails details = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AccessPolicyDetails.Builder

getDetailsOrBuilder()

public AccessPolicyDetailsOrBuilder getDetailsOrBuilder()

Optional. The details for the access policy.

.google.iam.v3beta.AccessPolicyDetails details = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AccessPolicyDetailsOrBuilder

getDisplayName()

public String getDisplayName()

Optional. The description of the access policy. Must be less than or equal to 63 characters.

string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The description of the access policy. Must be less than or equal to 63 characters.

string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getEtag()

public String getEtag()

Optional. The etag for the access policy. If this is provided on update, it must match the server's etag.

string etag = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Optional. The etag for the access policy. If this is provided on update, it must match the server's etag.

string etag = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for etag.

getMutableAnnotations() (deprecated)

public Map<String,String> getMutableAnnotations()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Identifier. The resource name of the access policy.

The following formats are supported:

  • projects/{project_id}/locations/{location}/accessPolicies/{policy_id}
  • projects/{project_number}/locations/{location}/accessPolicies/{policy_id}
  • folders/{folder_id}/locations/{location}/accessPolicies/{policy_id}
  • organizations/{organization_id}/locations/{location}/accessPolicies/{policy_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the access policy.

The following formats are supported:

  • projects/{project_id}/locations/{location}/accessPolicies/{policy_id}
  • projects/{project_number}/locations/{location}/accessPolicies/{policy_id}
  • folders/{folder_id}/locations/{location}/accessPolicies/{policy_id}
  • organizations/{organization_id}/locations/{location}/accessPolicies/{policy_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getUid()

public String getUid()

Output only. The globally unique ID of the access policy.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. The globally unique ID of the access policy.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time when the access policy was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The time when the access policy was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time when the access policy was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the access policy was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDetails()

public boolean hasDetails()

Optional. The details for the access policy.

.google.iam.v3beta.AccessPolicyDetails details = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the details field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time when the access policy was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public AccessPolicy.Builder mergeCreateTime(Timestamp value)

Output only. The time when the access policy was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
AccessPolicy.Builder

mergeDetails(AccessPolicyDetails value)

public AccessPolicy.Builder mergeDetails(AccessPolicyDetails value)

Optional. The details for the access policy.

.google.iam.v3beta.AccessPolicyDetails details = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AccessPolicyDetails
Returns
Type Description
AccessPolicy.Builder

mergeFrom(AccessPolicy other)

public AccessPolicy.Builder mergeFrom(AccessPolicy other)
Parameter
Name Description
other AccessPolicy
Returns
Type Description
AccessPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AccessPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AccessPolicy.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AccessPolicy.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AccessPolicy.Builder
Overrides

mergeUpdateTime(Timestamp value)

public AccessPolicy.Builder mergeUpdateTime(Timestamp value)

Output only. The time when the access policy was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
AccessPolicy.Builder

putAllAnnotations(Map<String,String> values)

public AccessPolicy.Builder putAllAnnotations(Map<String,String> values)

Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Map<String,String>
Returns
Type Description
AccessPolicy.Builder

putAnnotations(String key, String value)

public AccessPolicy.Builder putAnnotations(String key, String value)

Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
value String
Returns
Type Description
AccessPolicy.Builder

removeAnnotations(String key)

public AccessPolicy.Builder removeAnnotations(String key)

Optional. User defined annotations. See https://google.aip.dev/148#annotations for more details such as format and size limitations

map<string, string> annotations = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
AccessPolicy.Builder

setCreateTime(Timestamp value)

public AccessPolicy.Builder setCreateTime(Timestamp value)

Output only. The time when the access policy was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
AccessPolicy.Builder

setCreateTime(Timestamp.Builder builderForValue)

public AccessPolicy.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time when the access policy was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AccessPolicy.Builder

setDetails(AccessPolicyDetails value)

public AccessPolicy.Builder setDetails(AccessPolicyDetails value)

Optional. The details for the access policy.

.google.iam.v3beta.AccessPolicyDetails details = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AccessPolicyDetails
Returns
Type Description
AccessPolicy.Builder

setDetails(AccessPolicyDetails.Builder builderForValue)

public AccessPolicy.Builder setDetails(AccessPolicyDetails.Builder builderForValue)

Optional. The details for the access policy.

.google.iam.v3beta.AccessPolicyDetails details = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue AccessPolicyDetails.Builder
Returns
Type Description
AccessPolicy.Builder

setDisplayName(String value)

public AccessPolicy.Builder setDisplayName(String value)

Optional. The description of the access policy. Must be less than or equal to 63 characters.

string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
AccessPolicy.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public AccessPolicy.Builder setDisplayNameBytes(ByteString value)

Optional. The description of the access policy. Must be less than or equal to 63 characters.

string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
AccessPolicy.Builder

This builder for chaining.

setEtag(String value)

public AccessPolicy.Builder setEtag(String value)

Optional. The etag for the access policy. If this is provided on update, it must match the server's etag.

string etag = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
AccessPolicy.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public AccessPolicy.Builder setEtagBytes(ByteString value)

Optional. The etag for the access policy. If this is provided on update, it must match the server's etag.

string etag = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
AccessPolicy.Builder

This builder for chaining.

setName(String value)

public AccessPolicy.Builder setName(String value)

Identifier. The resource name of the access policy.

The following formats are supported:

  • projects/{project_id}/locations/{location}/accessPolicies/{policy_id}
  • projects/{project_number}/locations/{location}/accessPolicies/{policy_id}
  • folders/{folder_id}/locations/{location}/accessPolicies/{policy_id}
  • organizations/{organization_id}/locations/{location}/accessPolicies/{policy_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
AccessPolicy.Builder

This builder for chaining.

setNameBytes(ByteString value)

public AccessPolicy.Builder setNameBytes(ByteString value)

Identifier. The resource name of the access policy.

The following formats are supported:

  • projects/{project_id}/locations/{location}/accessPolicies/{policy_id}
  • projects/{project_number}/locations/{location}/accessPolicies/{policy_id}
  • folders/{folder_id}/locations/{location}/accessPolicies/{policy_id}
  • organizations/{organization_id}/locations/{location}/accessPolicies/{policy_id}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
AccessPolicy.Builder

This builder for chaining.

setUid(String value)

public AccessPolicy.Builder setUid(String value)

Output only. The globally unique ID of the access policy.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Parameter
Name Description
value String

The uid to set.

Returns
Type Description
AccessPolicy.Builder

This builder for chaining.

setUidBytes(ByteString value)

public AccessPolicy.Builder setUidBytes(ByteString value)

Output only. The globally unique ID of the access policy.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }

Parameter
Name Description
value ByteString

The bytes for uid to set.

Returns
Type Description
AccessPolicy.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public AccessPolicy.Builder setUpdateTime(Timestamp value)

Output only. The time when the access policy was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
AccessPolicy.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public AccessPolicy.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time when the access policy was most recently updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AccessPolicy.Builder