Class ListRestorePlansRequest.Builder (0.82.0)

public static final class ListRestorePlansRequest.Builder extends GeneratedMessage.Builder<ListRestorePlansRequest.Builder> implements ListRestorePlansRequestOrBuilder

Request message for ListRestorePlans.

Protobuf type google.cloud.gkebackup.v1.ListRestorePlansRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListRestorePlansRequest build()
Returns
Type Description
ListRestorePlansRequest

buildPartial()

public ListRestorePlansRequest buildPartial()
Returns
Type Description
ListRestorePlansRequest

clear()

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

clearFilter()

public ListRestorePlansRequest.Builder clearFilter()

Optional. Field match expression used to filter the results.

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

Returns
Type Description
ListRestorePlansRequest.Builder

This builder for chaining.

clearOrderBy()

public ListRestorePlansRequest.Builder clearOrderBy()

Optional. Field by which to sort the results.

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

Returns
Type Description
ListRestorePlansRequest.Builder

This builder for chaining.

clearPageSize()

public ListRestorePlansRequest.Builder clearPageSize()

Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.

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

Returns
Type Description
ListRestorePlansRequest.Builder

This builder for chaining.

clearPageToken()

public ListRestorePlansRequest.Builder clearPageToken()

Optional. The value of next_page_token received from a previous ListRestorePlans call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListRestorePlans must match the call that provided the page token.

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

Returns
Type Description
ListRestorePlansRequest.Builder

This builder for chaining.

clearParent()

public ListRestorePlansRequest.Builder clearParent()

Required. The location that contains the RestorePlans to list. Format: projects/*/locations/*

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

Returns
Type Description
ListRestorePlansRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListRestorePlansRequest getDefaultInstanceForType()
Returns
Type Description
ListRestorePlansRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Field match expression used to filter the results.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Field match expression used to filter the results.

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

Returns
Type Description
ByteString

The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. Field by which to sort the results.

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

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Field by which to sort the results.

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

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances 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 value of next_page_token received from a previous ListRestorePlans call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListRestorePlans must match the call that provided the page token.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The value of next_page_token received from a previous ListRestorePlans call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListRestorePlans must match the call that provided the page token.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The location that contains the RestorePlans to list. Format: projects/*/locations/*

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The location that contains the RestorePlans to list. Format: projects/*/locations/*

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

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFilter(String value)

public ListRestorePlansRequest.Builder setFilter(String value)

Optional. Field match expression used to filter the results.

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListRestorePlansRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListRestorePlansRequest.Builder setFilterBytes(ByteString value)

Optional. Field match expression used to filter the results.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListRestorePlansRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListRestorePlansRequest.Builder setOrderBy(String value)

Optional. Field by which to sort the results.

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

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListRestorePlansRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListRestorePlansRequest.Builder setOrderByBytes(ByteString value)

Optional. Field by which to sort the results.

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

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListRestorePlansRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListRestorePlansRequest.Builder setPageSize(int value)

Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances 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
ListRestorePlansRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListRestorePlansRequest.Builder setPageToken(String value)

Optional. The value of next_page_token received from a previous ListRestorePlans call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListRestorePlans must match the call that provided the page token.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListRestorePlansRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListRestorePlansRequest.Builder setPageTokenBytes(ByteString value)

Optional. The value of next_page_token received from a previous ListRestorePlans call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListRestorePlans must match the call that provided the page token.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListRestorePlansRequest.Builder

This builder for chaining.

setParent(String value)

public ListRestorePlansRequest.Builder setParent(String value)

Required. The location that contains the RestorePlans to list. Format: projects/*/locations/*

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListRestorePlansRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListRestorePlansRequest.Builder setParentBytes(ByteString value)

Required. The location that contains the RestorePlans to list. Format: projects/*/locations/*

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

This builder for chaining.