public static final class ListBackupsRequest.Builder extends GeneratedMessageV3.Builder<ListBackupsRequest.Builder> implements ListBackupsRequestOrBuilderThe request for FirestoreAdmin.ListBackups.
Protobuf type google.firestore.admin.v1.ListBackupsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListBackupsRequest.BuilderImplements
ListBackupsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListBackupsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
build()
public ListBackupsRequest build()| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest |
|
buildPartial()
public ListBackupsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest |
|
clear()
public ListBackupsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ListBackupsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
clearFilter()
public ListBackupsRequest.Builder clearFilter()An expression that filters the list of returned backups.
A filter expression consists of a field name, a comparison operator, and a
value for filtering.
The value must be a string, a number, or a boolean. The comparison operator
must be one of: <, >, <=, >=, !=, =, or :.
Colon : is the contains operator. Filter rules are not case sensitive.
The following fields in the Backup are eligible for filtering:
database_uid(supports=only)
string filter = 2;
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListBackupsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
clearParent()
public ListBackupsRequest.Builder clearParent()Required. The location to list backups from.
Format is projects/{project}/locations/{location}.
Use {location} = '-' to list backups from all locations for the given
project. This allows listing backups from a single location or from all
locations.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
This builder for chaining. |
clone()
public ListBackupsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
getDefaultInstanceForType()
public ListBackupsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFilter()
public String getFilter()An expression that filters the list of returned backups.
A filter expression consists of a field name, a comparison operator, and a
value for filtering.
The value must be a string, a number, or a boolean. The comparison operator
must be one of: <, >, <=, >=, !=, =, or :.
Colon : is the contains operator. Filter rules are not case sensitive.
The following fields in the Backup are eligible for filtering:
database_uid(supports=only)
string filter = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The filter. |
getFilterBytes()
public ByteString getFilterBytes()An expression that filters the list of returned backups.
A filter expression consists of a field name, a comparison operator, and a
value for filtering.
The value must be a string, a number, or a boolean. The comparison operator
must be one of: <, >, <=, >=, !=, =, or :.
Colon : is the contains operator. Filter rules are not case sensitive.
The following fields in the Backup are eligible for filtering:
database_uid(supports=only)
string filter = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for filter. |
getParent()
public String getParent()Required. The location to list backups from.
Format is projects/{project}/locations/{location}.
Use {location} = '-' to list backups from all locations for the given
project. This allows listing backups from a single location or from all
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 to list backups from.
Format is projects/{project}/locations/{location}.
Use {location} = '-' to list backups from all locations for the given
project. This allows listing backups from a single location or from all
locations.
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(ListBackupsRequest other)
public ListBackupsRequest.Builder mergeFrom(ListBackupsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListBackupsRequest |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListBackupsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListBackupsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListBackupsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ListBackupsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
setFilter(String value)
public ListBackupsRequest.Builder setFilter(String value)An expression that filters the list of returned backups.
A filter expression consists of a field name, a comparison operator, and a
value for filtering.
The value must be a string, a number, or a boolean. The comparison operator
must be one of: <, >, <=, >=, !=, =, or :.
Colon : is the contains operator. Filter rules are not case sensitive.
The following fields in the Backup are eligible for filtering:
database_uid(supports=only)
string filter = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListBackupsRequest.Builder setFilterBytes(ByteString value)An expression that filters the list of returned backups.
A filter expression consists of a field name, a comparison operator, and a
value for filtering.
The value must be a string, a number, or a boolean. The comparison operator
must be one of: <, >, <=, >=, !=, =, or :.
Colon : is the contains operator. Filter rules are not case sensitive.
The following fields in the Backup are eligible for filtering:
database_uid(supports=only)
string filter = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListBackupsRequest.Builder setParent(String value)Required. The location to list backups from.
Format is projects/{project}/locations/{location}.
Use {location} = '-' to list backups from all locations for the given
project. This allows listing backups from a single location or from all
locations.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListBackupsRequest.Builder setParentBytes(ByteString value)Required. The location to list backups from.
Format is projects/{project}/locations/{location}.
Use {location} = '-' to list backups from all locations for the given
project. This allows listing backups from a single location or from all
locations.
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 |
ListBackupsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListBackupsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListBackupsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|