public static final class ListBackupPlansRequest.Builder extends GeneratedMessageV3.Builder<ListBackupPlansRequest.Builder> implements ListBackupPlansRequestOrBuilder The request message for getting a list BackupPlan.
Protobuf type google.cloud.backupdr.v1.ListBackupPlansRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListBackupPlansRequest.BuilderImplements
ListBackupPlansRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListBackupPlansRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
|
build()
public ListBackupPlansRequest build()| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest |
|
buildPartial()
public ListBackupPlansRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest |
|
clear()
public ListBackupPlansRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ListBackupPlansRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
|
clearFilter()
public ListBackupPlansRequest.Builder clearFilter()Optional. Field match expression used to filter the results.
string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListBackupPlansRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
|
clearOrderBy()
public ListBackupPlansRequest.Builder clearOrderBy()Optional. Field by which to sort the results.
string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
This builder for chaining. |
clearPageSize()
public ListBackupPlansRequest.Builder clearPageSize() Optional. The maximum number of BackupPlans 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 |
ListBackupPlansRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListBackupPlansRequest.Builder clearPageToken() Optional. The value of
next_page_token
received from a previous ListBackupPlans call.
Provide this to retrieve the subsequent page in a multi-page list of
results. When paginating, all other parameters provided to
ListBackupPlans must match the call that provided the page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
This builder for chaining. |
clearParent()
public ListBackupPlansRequest.Builder clearParent() Required. The project and location for which to retrieve BackupPlans
information. Format: projects/{project}/locations/{location}. In Cloud
BackupDR, locations map to GCP regions, for e.g. us-central1. To
retrieve backup plans for all locations, use "-" for the
{location} value.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
This builder for chaining. |
clone()
public ListBackupPlansRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
|
getDefaultInstanceForType()
public ListBackupPlansRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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 BackupPlans 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 ListBackupPlans call.
Provide this to retrieve the subsequent page in a multi-page list of
results. When paginating, all other parameters provided to
ListBackupPlans 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 ListBackupPlans call.
Provide this to retrieve the subsequent page in a multi-page list of
results. When paginating, all other parameters provided to
ListBackupPlans 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 BackupPlans
information. Format: projects/{project}/locations/{location}. In Cloud
BackupDR, locations map to GCP regions, for e.g. us-central1. To
retrieve backup 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 BackupPlans
information. Format: projects/{project}/locations/{location}. In Cloud
BackupDR, locations map to GCP regions, for e.g. us-central1. To
retrieve backup 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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(ListBackupPlansRequest other)
public ListBackupPlansRequest.Builder mergeFrom(ListBackupPlansRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListBackupPlansRequest |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListBackupPlansRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListBackupPlansRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListBackupPlansRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ListBackupPlansRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
|
setFilter(String value)
public ListBackupPlansRequest.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 |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListBackupPlansRequest.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 |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
This builder for chaining. |
setOrderBy(String value)
public ListBackupPlansRequest.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 |
StringThe orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
This builder for chaining. |
setOrderByBytes(ByteString value)
public ListBackupPlansRequest.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 |
ByteStringThe bytes for orderBy to set. |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListBackupPlansRequest.Builder setPageSize(int value) Optional. The maximum number of BackupPlans 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 |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListBackupPlansRequest.Builder setPageToken(String value) Optional. The value of
next_page_token
received from a previous ListBackupPlans call.
Provide this to retrieve the subsequent page in a multi-page list of
results. When paginating, all other parameters provided to
ListBackupPlans must match the call that provided the page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListBackupPlansRequest.Builder setPageTokenBytes(ByteString value) Optional. The value of
next_page_token
received from a previous ListBackupPlans call.
Provide this to retrieve the subsequent page in a multi-page list of
results. When paginating, all other parameters provided to
ListBackupPlans must match the call that provided the page token.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListBackupPlansRequest.Builder setParent(String value) Required. The project and location for which to retrieve BackupPlans
information. Format: projects/{project}/locations/{location}. In Cloud
BackupDR, locations map to GCP regions, for e.g. us-central1. To
retrieve backup 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 |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListBackupPlansRequest.Builder setParentBytes(ByteString value) Required. The project and location for which to retrieve BackupPlans
information. Format: projects/{project}/locations/{location}. In Cloud
BackupDR, locations map to GCP regions, for e.g. us-central1. To
retrieve backup 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 |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListBackupPlansRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListBackupPlansRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListBackupPlansRequest.Builder |
|