Class CustomAPIPagination.TokenPagination (0.37.0)

public static final class CustomAPIPagination.TokenPagination extends GeneratedMessage implements CustomAPIPagination.TokenPaginationOrBuilder

Use tokens (custom keys) to get the next page of data.

Protobuf type google.cloud.chronicle.v1.CustomAPIPagination.TokenPagination

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > CustomAPIPagination.TokenPagination

Static Fields

NEXT_PAGE_TOKEN_JSON_PATH_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_JSON_PATH_FIELD_NUMBER
Field Value
Type Description
int

QUERY_PARAM_FIELD_NUMBER

public static final int QUERY_PARAM_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CustomAPIPagination.TokenPagination getDefaultInstance()
Returns
Type Description
CustomAPIPagination.TokenPagination

getDescriptor()

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

newBuilder()

public static CustomAPIPagination.TokenPagination.Builder newBuilder()
Returns
Type Description
CustomAPIPagination.TokenPagination.Builder

newBuilder(CustomAPIPagination.TokenPagination prototype)

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

parseDelimitedFrom(InputStream input)

public static CustomAPIPagination.TokenPagination parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomAPIPagination.TokenPagination
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static CustomAPIPagination.TokenPagination parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CustomAPIPagination.TokenPagination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static CustomAPIPagination.TokenPagination parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CustomAPIPagination.TokenPagination
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static CustomAPIPagination.TokenPagination parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CustomAPIPagination.TokenPagination
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static CustomAPIPagination.TokenPagination parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CustomAPIPagination.TokenPagination
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<CustomAPIPagination.TokenPagination> parser()
Returns
Type Description
Parser<TokenPagination>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CustomAPIPagination.TokenPagination getDefaultInstanceForType()
Returns
Type Description
CustomAPIPagination.TokenPagination

getNextPageTokenJsonPath()

public String getNextPageTokenJsonPath()

Required. Enter the field in the API response that contains the URL or token needed to fetch the next page of data.

string next_page_token_json_path = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The nextPageTokenJsonPath.

getNextPageTokenJsonPathBytes()

public ByteString getNextPageTokenJsonPathBytes()

Required. Enter the field in the API response that contains the URL or token needed to fetch the next page of data.

string next_page_token_json_path = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for nextPageTokenJsonPath.

getParserForType()

public Parser<CustomAPIPagination.TokenPagination> getParserForType()
Returns
Type Description
Parser<TokenPagination>
Overrides

getQueryParam()

public String getQueryParam()

Required. Specify the name of the query parameter for next page token in request.

string query_param = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The queryParam.

getQueryParamBytes()

public ByteString getQueryParamBytes()

Required. Specify the name of the query parameter for next page token in request.

string query_param = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for queryParam.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CustomAPIPagination.TokenPagination.Builder newBuilderForType()
Returns
Type Description
CustomAPIPagination.TokenPagination.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected CustomAPIPagination.TokenPagination.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CustomAPIPagination.TokenPagination.Builder
Overrides

toBuilder()

public CustomAPIPagination.TokenPagination.Builder toBuilder()
Returns
Type Description
CustomAPIPagination.TokenPagination.Builder

writeTo(CodedOutputStream output)

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