Class ListSnapshotsRequest (1.135.0)

public final class ListSnapshotsRequest extends GeneratedMessageV3 implements ListSnapshotsRequestOrBuilder

Request for the ListSnapshots method.

Protobuf type google.pubsub.v1.ListSnapshotsRequest

Static Fields

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

PROJECT_FIELD_NUMBER

public static final int PROJECT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListSnapshotsRequest getDefaultInstance()
Returns
Type Description
ListSnapshotsRequest

getDescriptor()

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

newBuilder()

public static ListSnapshotsRequest.Builder newBuilder()
Returns
Type Description
ListSnapshotsRequest.Builder

newBuilder(ListSnapshotsRequest prototype)

public static ListSnapshotsRequest.Builder newBuilder(ListSnapshotsRequest prototype)
Parameter
Name Description
prototype ListSnapshotsRequest
Returns
Type Description
ListSnapshotsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListSnapshotsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListSnapshotsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSnapshotsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSnapshotsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListSnapshotsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListSnapshotsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListSnapshotsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSnapshotsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListSnapshotsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListSnapshotsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListSnapshotsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSnapshotsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListSnapshotsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListSnapshotsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSnapshotsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSnapshotsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListSnapshotsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListSnapshotsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListSnapshotsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSnapshotsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListSnapshotsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListSnapshotsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListSnapshotsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListSnapshotsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListSnapshotsRequest> parser()
Returns
Type Description
Parser<ListSnapshotsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListSnapshotsRequest getDefaultInstanceForType()
Returns
Type Description
ListSnapshotsRequest

getPageSize()

public int getPageSize()

Optional. Maximum number of snapshots to return.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. The value returned by the last ListSnapshotsResponse; indicates that this is a continuation of a prior ListSnapshots call, and that the system should return the next page of data.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The value returned by the last ListSnapshotsResponse; indicates that this is a continuation of a prior ListSnapshots call, and that the system should return the next page of data.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParserForType()

public Parser<ListSnapshotsRequest> getParserForType()
Returns
Type Description
Parser<ListSnapshotsRequest>
Overrides

getProject()

public String getProject()

Required. The name of the project in which to list snapshots. Format is projects/{project-id}.

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

Returns
Type Description
String

The project.

getProjectBytes()

public ByteString getProjectBytes()

Required. The name of the project in which to list snapshots. Format is projects/{project-id}.

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

Returns
Type Description
ByteString

The bytes for project.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListSnapshotsRequest.Builder newBuilderForType()
Returns
Type Description
ListSnapshotsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListSnapshotsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListSnapshotsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListSnapshotsRequest.Builder toBuilder()
Returns
Type Description
ListSnapshotsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException