Class CustomAPIPagination (0.37.0)

public final class CustomAPIPagination extends GeneratedMessage implements CustomAPIPaginationOrBuilder

Pagination strategy for the request.

Protobuf type google.cloud.chronicle.v1.CustomAPIPagination

Static Fields

public static final int LINK_FIELD_NUMBER
Field Value
Type Description
int

NONE_FIELD_NUMBER

public static final int NONE_FIELD_NUMBER
Field Value
Type Description
int

OFFSET_FIELD_NUMBER

public static final int OFFSET_FIELD_NUMBER
Field Value
Type Description
int

PAGE_NUMBER_FIELD_NUMBER

public static final int PAGE_NUMBER_FIELD_NUMBER
Field Value
Type Description
int

TOKEN_FIELD_NUMBER

public static final int TOKEN_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CustomAPIPagination getDefaultInstance()
Returns
Type Description
CustomAPIPagination

getDescriptor()

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

newBuilder()

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

newBuilder(CustomAPIPagination prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CustomAPIPagination getDefaultInstanceForType()
Returns
Type Description
CustomAPIPagination
public CustomAPIPagination.LinkPagination getLink()

Follow links provided in the response to get more data.

.google.cloud.chronicle.v1.CustomAPIPagination.LinkPagination link = 6;

Returns
Type Description
CustomAPIPagination.LinkPagination

The link.

getLinkOrBuilder()

public CustomAPIPagination.LinkPaginationOrBuilder getLinkOrBuilder()

Follow links provided in the response to get more data.

.google.cloud.chronicle.v1.CustomAPIPagination.LinkPagination link = 6;

Returns
Type Description
CustomAPIPagination.LinkPaginationOrBuilder

getNone()

public CustomAPIPagination.NonePagination getNone()

Fetch data in a single request without paging.

.google.cloud.chronicle.v1.CustomAPIPagination.NonePagination none = 4;

Returns
Type Description
CustomAPIPagination.NonePagination

The none.

getNoneOrBuilder()

public CustomAPIPagination.NonePaginationOrBuilder getNoneOrBuilder()

Fetch data in a single request without paging.

.google.cloud.chronicle.v1.CustomAPIPagination.NonePagination none = 4;

Returns
Type Description
CustomAPIPagination.NonePaginationOrBuilder

getOffset()

public CustomAPIPagination.OffsetPagination getOffset()

Skip a set number of records to get the next set.

.google.cloud.chronicle.v1.CustomAPIPagination.OffsetPagination offset = 7;

Returns
Type Description
CustomAPIPagination.OffsetPagination

The offset.

getOffsetOrBuilder()

public CustomAPIPagination.OffsetPaginationOrBuilder getOffsetOrBuilder()

Skip a set number of records to get the next set.

.google.cloud.chronicle.v1.CustomAPIPagination.OffsetPagination offset = 7;

Returns
Type Description
CustomAPIPagination.OffsetPaginationOrBuilder

getPageNumber()

public CustomAPIPagination.PageNumberPagination getPageNumber()

Go to the next page number (e.g., page 2).

.google.cloud.chronicle.v1.CustomAPIPagination.PageNumberPagination page_number = 8;

Returns
Type Description
CustomAPIPagination.PageNumberPagination

The pageNumber.

getPageNumberOrBuilder()

public CustomAPIPagination.PageNumberPaginationOrBuilder getPageNumberOrBuilder()

Go to the next page number (e.g., page 2).

.google.cloud.chronicle.v1.CustomAPIPagination.PageNumberPagination page_number = 8;

Returns
Type Description
CustomAPIPagination.PageNumberPaginationOrBuilder

getPaginationStrategyCase()

public CustomAPIPagination.PaginationStrategyCase getPaginationStrategyCase()
Returns
Type Description
CustomAPIPagination.PaginationStrategyCase

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getToken()

public CustomAPIPagination.TokenPagination getToken()

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

.google.cloud.chronicle.v1.CustomAPIPagination.TokenPagination token = 5;

Returns
Type Description
CustomAPIPagination.TokenPagination

The token.

getTokenOrBuilder()

public CustomAPIPagination.TokenPaginationOrBuilder getTokenOrBuilder()

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

.google.cloud.chronicle.v1.CustomAPIPagination.TokenPagination token = 5;

Returns
Type Description
CustomAPIPagination.TokenPaginationOrBuilder
public boolean hasLink()

Follow links provided in the response to get more data.

.google.cloud.chronicle.v1.CustomAPIPagination.LinkPagination link = 6;

Returns
Type Description
boolean

Whether the link field is set.

hasNone()

public boolean hasNone()

Fetch data in a single request without paging.

.google.cloud.chronicle.v1.CustomAPIPagination.NonePagination none = 4;

Returns
Type Description
boolean

Whether the none field is set.

hasOffset()

public boolean hasOffset()

Skip a set number of records to get the next set.

.google.cloud.chronicle.v1.CustomAPIPagination.OffsetPagination offset = 7;

Returns
Type Description
boolean

Whether the offset field is set.

hasPageNumber()

public boolean hasPageNumber()

Go to the next page number (e.g., page 2).

.google.cloud.chronicle.v1.CustomAPIPagination.PageNumberPagination page_number = 8;

Returns
Type Description
boolean

Whether the pageNumber field is set.

hasToken()

public boolean hasToken()

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

.google.cloud.chronicle.v1.CustomAPIPagination.TokenPagination token = 5;

Returns
Type Description
boolean

Whether the token field is set.

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.Builder newBuilderForType()
Returns
Type Description
CustomAPIPagination.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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