Class CreateAccessPolicyRequest.Builder (1.67.0)

public static final class CreateAccessPolicyRequest.Builder extends GeneratedMessage.Builder<CreateAccessPolicyRequest.Builder> implements CreateAccessPolicyRequestOrBuilder

Request message for CreateAccessPolicy method.

Protobuf type google.iam.v3beta.CreateAccessPolicyRequest

Static Methods

getDescriptor()

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

Methods

build()

public CreateAccessPolicyRequest build()
Returns
Type Description
CreateAccessPolicyRequest

buildPartial()

public CreateAccessPolicyRequest buildPartial()
Returns
Type Description
CreateAccessPolicyRequest

clear()

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

clearAccessPolicy()

public CreateAccessPolicyRequest.Builder clearAccessPolicy()

Required. The access policy to create.

.google.iam.v3beta.AccessPolicy access_policy = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateAccessPolicyRequest.Builder

clearAccessPolicyId()

public CreateAccessPolicyRequest.Builder clearAccessPolicyId()

Required. The ID to use for the access policy, which will become the final component of the access policy's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

This value must be unique among all access policies with the same parent.

string access_policy_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateAccessPolicyRequest.Builder

This builder for chaining.

clearParent()

public CreateAccessPolicyRequest.Builder clearParent()

Required. The parent resource where this access policy will be created.

Format: projects/{project_id}/locations/{location} projects/{project_number}/locations/{location} folders/{folder_id}/locations/{location} organizations/{organization_id}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
CreateAccessPolicyRequest.Builder

This builder for chaining.

clearValidateOnly()

public CreateAccessPolicyRequest.Builder clearValidateOnly()

Optional. If set, validate the request and preview the creation, but do not actually post it.

bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CreateAccessPolicyRequest.Builder

This builder for chaining.

getAccessPolicy()

public AccessPolicy getAccessPolicy()

Required. The access policy to create.

.google.iam.v3beta.AccessPolicy access_policy = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AccessPolicy

The accessPolicy.

getAccessPolicyBuilder()

public AccessPolicy.Builder getAccessPolicyBuilder()

Required. The access policy to create.

.google.iam.v3beta.AccessPolicy access_policy = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AccessPolicy.Builder

getAccessPolicyId()

public String getAccessPolicyId()

Required. The ID to use for the access policy, which will become the final component of the access policy's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

This value must be unique among all access policies with the same parent.

string access_policy_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The accessPolicyId.

getAccessPolicyIdBytes()

public ByteString getAccessPolicyIdBytes()

Required. The ID to use for the access policy, which will become the final component of the access policy's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

This value must be unique among all access policies with the same parent.

string access_policy_id = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for accessPolicyId.

getAccessPolicyOrBuilder()

public AccessPolicyOrBuilder getAccessPolicyOrBuilder()

Required. The access policy to create.

.google.iam.v3beta.AccessPolicy access_policy = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AccessPolicyOrBuilder

getDefaultInstanceForType()

public CreateAccessPolicyRequest getDefaultInstanceForType()
Returns
Type Description
CreateAccessPolicyRequest

getDescriptorForType()

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

getParent()

public String getParent()

Required. The parent resource where this access policy will be created.

Format: projects/{project_id}/locations/{location} projects/{project_number}/locations/{location} folders/{folder_id}/locations/{location} organizations/{organization_id}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent resource where this access policy will be created.

Format: projects/{project_id}/locations/{location} projects/{project_number}/locations/{location} folders/{folder_id}/locations/{location} organizations/{organization_id}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getValidateOnly()

public boolean getValidateOnly()

Optional. If set, validate the request and preview the creation, but do not actually post it.

bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The validateOnly.

hasAccessPolicy()

public boolean hasAccessPolicy()

Required. The access policy to create.

.google.iam.v3beta.AccessPolicy access_policy = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the accessPolicy field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAccessPolicy(AccessPolicy value)

public CreateAccessPolicyRequest.Builder mergeAccessPolicy(AccessPolicy value)

Required. The access policy to create.

.google.iam.v3beta.AccessPolicy access_policy = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value AccessPolicy
Returns
Type Description
CreateAccessPolicyRequest.Builder

mergeFrom(CreateAccessPolicyRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setAccessPolicy(AccessPolicy value)

public CreateAccessPolicyRequest.Builder setAccessPolicy(AccessPolicy value)

Required. The access policy to create.

.google.iam.v3beta.AccessPolicy access_policy = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value AccessPolicy
Returns
Type Description
CreateAccessPolicyRequest.Builder

setAccessPolicy(AccessPolicy.Builder builderForValue)

public CreateAccessPolicyRequest.Builder setAccessPolicy(AccessPolicy.Builder builderForValue)

Required. The access policy to create.

.google.iam.v3beta.AccessPolicy access_policy = 3 [(.google.api.field_behavior) = REQUIRED];

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

setAccessPolicyId(String value)

public CreateAccessPolicyRequest.Builder setAccessPolicyId(String value)

Required. The ID to use for the access policy, which will become the final component of the access policy's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

This value must be unique among all access policies with the same parent.

string access_policy_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The accessPolicyId to set.

Returns
Type Description
CreateAccessPolicyRequest.Builder

This builder for chaining.

setAccessPolicyIdBytes(ByteString value)

public CreateAccessPolicyRequest.Builder setAccessPolicyIdBytes(ByteString value)

Required. The ID to use for the access policy, which will become the final component of the access policy's resource name.

This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /a-z{2,62}/.

This value must be unique among all access policies with the same parent.

string access_policy_id = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for accessPolicyId to set.

Returns
Type Description
CreateAccessPolicyRequest.Builder

This builder for chaining.

setParent(String value)

public CreateAccessPolicyRequest.Builder setParent(String value)

Required. The parent resource where this access policy will be created.

Format: projects/{project_id}/locations/{location} projects/{project_number}/locations/{location} folders/{folder_id}/locations/{location} organizations/{organization_id}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateAccessPolicyRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateAccessPolicyRequest.Builder setParentBytes(ByteString value)

Required. The parent resource where this access policy will be created.

Format: projects/{project_id}/locations/{location} projects/{project_number}/locations/{location} folders/{folder_id}/locations/{location} organizations/{organization_id}/locations/{location}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateAccessPolicyRequest.Builder

This builder for chaining.

setValidateOnly(boolean value)

public CreateAccessPolicyRequest.Builder setValidateOnly(boolean value)

Optional. If set, validate the request and preview the creation, but do not actually post it.

bool validate_only = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The validateOnly to set.

Returns
Type Description
CreateAccessPolicyRequest.Builder

This builder for chaining.