Class ListBackupCollectionsRequest.Builder (0.57.0)

public static final class ListBackupCollectionsRequest.Builder extends GeneratedMessage.Builder<ListBackupCollectionsRequest.Builder> implements ListBackupCollectionsRequestOrBuilder

Request for [ListBackupCollections]

Protobuf type google.cloud.redis.cluster.v1beta1.ListBackupCollectionsRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListBackupCollectionsRequest build()
Returns
Type Description
ListBackupCollectionsRequest

buildPartial()

public ListBackupCollectionsRequest buildPartial()
Returns
Type Description
ListBackupCollectionsRequest

clear()

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

clearPageSize()

public ListBackupCollectionsRequest.Builder clearPageSize()

Optional. The maximum number of items to return.

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 clusters left to be queried.

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

Returns
Type Description
ListBackupCollectionsRequest.Builder

This builder for chaining.

clearPageToken()

public ListBackupCollectionsRequest.Builder clearPageToken()

Optional. The next_page_token value returned from a previous [ListBackupCollections] request, if any.

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

Returns
Type Description
ListBackupCollectionsRequest.Builder

This builder for chaining.

clearParent()

public ListBackupCollectionsRequest.Builder clearParent()

Required. The resource name of the backupCollection location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

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

Returns
Type Description
ListBackupCollectionsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListBackupCollectionsRequest getDefaultInstanceForType()
Returns
Type Description
ListBackupCollectionsRequest

getDescriptorForType()

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

getPageSize()

public int getPageSize()

Optional. The maximum number of items to return.

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 clusters 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 [ListBackupCollections] 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 [ListBackupCollections] 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 resource name of the backupCollection location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the backupCollection location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

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(ListBackupCollectionsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setPageSize(int value)

public ListBackupCollectionsRequest.Builder setPageSize(int value)

Optional. The maximum number of items to return.

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 clusters 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
ListBackupCollectionsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListBackupCollectionsRequest.Builder setPageToken(String value)

Optional. The next_page_token value returned from a previous [ListBackupCollections] request, if any.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListBackupCollectionsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListBackupCollectionsRequest.Builder setPageTokenBytes(ByteString value)

Optional. The next_page_token value returned from a previous [ListBackupCollections] 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
ListBackupCollectionsRequest.Builder

This builder for chaining.

setParent(String value)

public ListBackupCollectionsRequest.Builder setParent(String value)

Required. The resource name of the backupCollection location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListBackupCollectionsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListBackupCollectionsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the backupCollection location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

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

This builder for chaining.