Class DeleteTokenAuthUserRequest.Builder (0.41.0)

public static final class DeleteTokenAuthUserRequest.Builder extends GeneratedMessage.Builder<DeleteTokenAuthUserRequest.Builder> implements DeleteTokenAuthUserRequestOrBuilder

Request message for DeleteTokenAuthUser.

Protobuf type google.cloud.memorystore.v1beta.DeleteTokenAuthUserRequest

Static Methods

getDescriptor()

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

Methods

build()

public DeleteTokenAuthUserRequest build()
Returns
Type Description
DeleteTokenAuthUserRequest

buildPartial()

public DeleteTokenAuthUserRequest buildPartial()
Returns
Type Description
DeleteTokenAuthUserRequest

clear()

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

clearForce()

public DeleteTokenAuthUserRequest.Builder clearForce()

Optional. If set to true, any auth tokens from this user will also be deleted. Otherwise, the request will only work if the user has no auth tokens.

bool force = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeleteTokenAuthUserRequest.Builder

This builder for chaining.

clearName()

public DeleteTokenAuthUserRequest.Builder clearName()

Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}

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

Returns
Type Description
DeleteTokenAuthUserRequest.Builder

This builder for chaining.

clearRequestId()

public DeleteTokenAuthUserRequest.Builder clearRequestId()

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
DeleteTokenAuthUserRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public DeleteTokenAuthUserRequest getDefaultInstanceForType()
Returns
Type Description
DeleteTokenAuthUserRequest

getDescriptorForType()

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

getForce()

public boolean getForce()

Optional. If set to true, any auth tokens from this user will also be deleted. Otherwise, the request will only work if the user has no auth tokens.

bool force = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The force.

getName()

public String getName()

Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}

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

Returns
Type Description
ByteString

The bytes for name.

getRequestId()

public String getRequestId()

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for requestId.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DeleteTokenAuthUserRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setForce(boolean value)

public DeleteTokenAuthUserRequest.Builder setForce(boolean value)

Optional. If set to true, any auth tokens from this user will also be deleted. Otherwise, the request will only work if the user has no auth tokens.

bool force = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The force to set.

Returns
Type Description
DeleteTokenAuthUserRequest.Builder

This builder for chaining.

setName(String value)

public DeleteTokenAuthUserRequest.Builder setName(String value)

Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
DeleteTokenAuthUserRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DeleteTokenAuthUserRequest.Builder setNameBytes(ByteString value)

Required. The name of the token auth user to delete. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
DeleteTokenAuthUserRequest.Builder

This builder for chaining.

setRequestId(String value)

public DeleteTokenAuthUserRequest.Builder setRequestId(String value)

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
DeleteTokenAuthUserRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public DeleteTokenAuthUserRequest.Builder setRequestIdBytes(ByteString value)

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
DeleteTokenAuthUserRequest.Builder

This builder for chaining.