Class ListRestoreVerificationPlansRequest.Builder (0.62.0)

public static final class ListRestoreVerificationPlansRequest.Builder extends GeneratedMessage.Builder<ListRestoreVerificationPlansRequest.Builder> implements ListRestoreVerificationPlansRequestOrBuilder

The request message for getting a list of RestoreVerificationPlans.

Protobuf type google.cloud.backupdr.v1.ListRestoreVerificationPlansRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListRestoreVerificationPlansRequest build()
Returns
Type Description
ListRestoreVerificationPlansRequest

buildPartial()

public ListRestoreVerificationPlansRequest buildPartial()
Returns
Type Description
ListRestoreVerificationPlansRequest

clear()

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

clearFilter()

public ListRestoreVerificationPlansRequest.Builder clearFilter()

Optional. Field match expression used to filter the results.

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

Returns
Type Description
ListRestoreVerificationPlansRequest.Builder

This builder for chaining.

clearOrderBy()

public ListRestoreVerificationPlansRequest.Builder clearOrderBy()

Optional. Field by which to sort the results.

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

Returns
Type Description
ListRestoreVerificationPlansRequest.Builder

This builder for chaining.

clearPageSize()

public ListRestoreVerificationPlansRequest.Builder clearPageSize()

Optional. The maximum number of RestoreVerificationPlans 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
ListRestoreVerificationPlansRequest.Builder

This builder for chaining.

clearPageToken()

public ListRestoreVerificationPlansRequest.Builder clearPageToken()

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

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

Returns
Type Description
ListRestoreVerificationPlansRequest.Builder

This builder for chaining.

clearParent()

public ListRestoreVerificationPlansRequest.Builder clearParent()

Required. The project and location for which to retrieve RestoreVerificationPlans information. Format: projects/{project}/locations/{location}. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve restore verification plans for all locations, use "-" for the {location} value.

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

Returns
Type Description
ListRestoreVerificationPlansRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListRestoreVerificationPlansRequest getDefaultInstanceForType()
Returns
Type Description
ListRestoreVerificationPlansRequest

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 maximum number of RestoreVerificationPlans 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 ListRestoreVerificationPlans call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListRestoreVerificationPlans 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 ListRestoreVerificationPlans call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListRestoreVerificationPlans 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 project and location for which to retrieve RestoreVerificationPlans information. Format: projects/{project}/locations/{location}. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve restore verification plans for all locations, use "-" for the {location} value.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The project and location for which to retrieve RestoreVerificationPlans information. Format: projects/{project}/locations/{location}. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve restore verification plans for all locations, use "-" for the {location} value.

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

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFilter(String value)

public ListRestoreVerificationPlansRequest.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
ListRestoreVerificationPlansRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListRestoreVerificationPlansRequest.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
ListRestoreVerificationPlansRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListRestoreVerificationPlansRequest.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
ListRestoreVerificationPlansRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListRestoreVerificationPlansRequest.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
ListRestoreVerificationPlansRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListRestoreVerificationPlansRequest.Builder setPageSize(int value)

Optional. The maximum number of RestoreVerificationPlans 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
ListRestoreVerificationPlansRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListRestoreVerificationPlansRequest.Builder setPageToken(String value)

Optional. The value of next_page_token received from a previous ListRestoreVerificationPlans call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListRestoreVerificationPlans 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
ListRestoreVerificationPlansRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListRestoreVerificationPlansRequest.Builder setPageTokenBytes(ByteString value)

Optional. The value of next_page_token received from a previous ListRestoreVerificationPlans call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListRestoreVerificationPlans 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
ListRestoreVerificationPlansRequest.Builder

This builder for chaining.

setParent(String value)

public ListRestoreVerificationPlansRequest.Builder setParent(String value)

Required. The project and location for which to retrieve RestoreVerificationPlans information. Format: projects/{project}/locations/{location}. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve restore verification plans for all locations, use "-" for the {location} value.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListRestoreVerificationPlansRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListRestoreVerificationPlansRequest.Builder setParentBytes(ByteString value)

Required. The project and location for which to retrieve RestoreVerificationPlans information. Format: projects/{project}/locations/{location}. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve restore verification plans for all locations, use "-" for the {location} value.

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

This builder for chaining.