public final class ListBackupPlansRequest extends GeneratedMessageV3 implements ListBackupPlansRequestOrBuilder
The request message for getting a list BackupPlan
.
Protobuf type google.cloud.backupdr.v1.ListBackupPlansRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListBackupPlansRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListBackupPlansRequest.Builder newBuilder()
newBuilder(ListBackupPlansRequest prototype)
public static ListBackupPlansRequest.Builder newBuilder(ListBackupPlansRequest prototype)
public static ListBackupPlansRequest parseDelimitedFrom(InputStream input)
public static ListBackupPlansRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListBackupPlansRequest parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListBackupPlansRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListBackupPlansRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListBackupPlansRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListBackupPlansRequest parseFrom(CodedInputStream input)
public static ListBackupPlansRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListBackupPlansRequest parseFrom(InputStream input)
public static ListBackupPlansRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListBackupPlansRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListBackupPlansRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListBackupPlansRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListBackupPlansRequest getDefaultInstanceForType()
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()
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.
|
getParserForType()
public Parser<ListBackupPlansRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListBackupPlansRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListBackupPlansRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public ListBackupPlansRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides