Class ListAuthTokensRequest.Builder (0.41.0)

public static final class ListAuthTokensRequest.Builder extends GeneratedMessage.Builder<ListAuthTokensRequest.Builder> implements ListAuthTokensRequestOrBuilder

Request message for ListAuthTokens.

Protobuf type google.cloud.memorystore.v1beta.ListAuthTokensRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListAuthTokensRequest build()
Returns
Type Description
ListAuthTokensRequest

buildPartial()

public ListAuthTokensRequest buildPartial()
Returns
Type Description
ListAuthTokensRequest

clear()

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

clearFilter()

public ListAuthTokensRequest.Builder clearFilter()

Optional. Expression for filtering results.

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

Returns
Type Description
ListAuthTokensRequest.Builder

This builder for chaining.

clearOrderBy()

public ListAuthTokensRequest.Builder clearOrderBy()

Optional. Sort results by a defined order.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListAuthTokensRequest.Builder

This builder for chaining.

clearPageSize()

public ListAuthTokensRequest.Builder clearPageSize()

Optional. The maximum number of items to return. The maximum value is 1000; values above 1000 will be coerced to 1000.

If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more auth tokens left to be queried.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListAuthTokensRequest.Builder

This builder for chaining.

clearPageToken()

public ListAuthTokensRequest.Builder clearPageToken()

Optional. The next_page_token value returned from a previous ListAuthTokens request, if any.

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

Returns
Type Description
ListAuthTokensRequest.Builder

This builder for chaining.

clearParent()

public ListAuthTokensRequest.Builder clearParent()

Required. The parent to list auth tokens from. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}

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

Returns
Type Description
ListAuthTokensRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListAuthTokensRequest getDefaultInstanceForType()
Returns
Type Description
ListAuthTokensRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Expression for filtering results.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Expression for filtering results.

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

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. Sort results by a defined order.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Sort results by a defined order.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. The maximum number of items to return. The maximum value is 1000; values above 1000 will be coerced to 1000.

If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more auth tokens left to be queried.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. The next_page_token value returned from a previous ListAuthTokens request, if any.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The next_page_token value returned from a previous ListAuthTokens request, if any.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent to list auth tokens from. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}

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 to list auth tokens from. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}

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

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListAuthTokensRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFilter(String value)

public ListAuthTokensRequest.Builder setFilter(String value)

Optional. Expression for filtering results.

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListAuthTokensRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListAuthTokensRequest.Builder setFilterBytes(ByteString value)

Optional. Expression for filtering results.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListAuthTokensRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListAuthTokensRequest.Builder setOrderBy(String value)

Optional. Sort results by a defined order.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListAuthTokensRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListAuthTokensRequest.Builder setOrderByBytes(ByteString value)

Optional. Sort results by a defined order.

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListAuthTokensRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListAuthTokensRequest.Builder setPageSize(int value)

Optional. The maximum number of items to return. The maximum value is 1000; values above 1000 will be coerced to 1000.

If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more auth tokens left to be queried.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListAuthTokensRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListAuthTokensRequest.Builder setPageToken(String value)

Optional. The next_page_token value returned from a previous ListAuthTokens request, if any.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListAuthTokensRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListAuthTokensRequest.Builder setPageTokenBytes(ByteString value)

Optional. The next_page_token value returned from a previous ListAuthTokens request, if any.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListAuthTokensRequest.Builder

This builder for chaining.

setParent(String value)

public ListAuthTokensRequest.Builder setParent(String value)

Required. The parent to list auth tokens from. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListAuthTokensRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListAuthTokensRequest.Builder setParentBytes(ByteString value)

Required. The parent to list auth tokens from. Format: projects/{project}/locations/{location}/instances/{instance}/tokenAuthUsers/{token_auth_user}

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
ListAuthTokensRequest.Builder

This builder for chaining.