Interface AccessPolicyOrBuilder (1.67.0)

1.67.0 (latest) 1.65.0 1.62.0 1.61.0 1.60.1 1.59.1 1.58.2 1.57.0 1.56.3 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 interface AccessPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAnnotations(String key)

public abstract 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 abstract Map<String,String> getAnnotations()

Use #getAnnotationsMap() instead.

Returns
Type	Description
Map<String,String>

getAnnotationsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getCreateTimeOrBuilder()

public abstract 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

getDetails()

public abstract 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.

getDetailsOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getUpdateTimeOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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.