Class CustomAPIPagination.Builder (0.37.0)

public static final class CustomAPIPagination.Builder extends GeneratedMessage.Builder<CustomAPIPagination.Builder> implements CustomAPIPaginationOrBuilder

Pagination strategy for the request.

Protobuf type google.cloud.chronicle.v1.CustomAPIPagination

Static Methods

getDescriptor()

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

Methods

build()

public CustomAPIPagination build()
Returns
Type Description
CustomAPIPagination

buildPartial()

public CustomAPIPagination buildPartial()
Returns
Type Description
CustomAPIPagination

clear()

public CustomAPIPagination.Builder clear()
Returns
Type Description
CustomAPIPagination.Builder
Overrides
public CustomAPIPagination.Builder clearLink()

Follow links provided in the response to get more data.

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

Returns
Type Description
CustomAPIPagination.Builder

clearNone()

public CustomAPIPagination.Builder clearNone()

Fetch data in a single request without paging.

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

Returns
Type Description
CustomAPIPagination.Builder

clearOffset()

public CustomAPIPagination.Builder clearOffset()

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

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

Returns
Type Description
CustomAPIPagination.Builder

clearPageNumber()

public CustomAPIPagination.Builder clearPageNumber()

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

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

Returns
Type Description
CustomAPIPagination.Builder

clearPaginationStrategy()

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

clearToken()

public CustomAPIPagination.Builder clearToken()

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

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

Returns
Type Description
CustomAPIPagination.Builder

getDefaultInstanceForType()

public CustomAPIPagination getDefaultInstanceForType()
Returns
Type Description
CustomAPIPagination

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides
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.

getLinkBuilder()

public CustomAPIPagination.LinkPagination.Builder getLinkBuilder()

Follow links provided in the response to get more data.

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

Returns
Type Description
CustomAPIPagination.LinkPagination.Builder

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.

getNoneBuilder()

public CustomAPIPagination.NonePagination.Builder getNoneBuilder()

Fetch data in a single request without paging.

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

Returns
Type Description
CustomAPIPagination.NonePagination.Builder

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.

getOffsetBuilder()

public CustomAPIPagination.OffsetPagination.Builder getOffsetBuilder()

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

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

Returns
Type Description
CustomAPIPagination.OffsetPagination.Builder

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.

getPageNumberBuilder()

public CustomAPIPagination.PageNumberPagination.Builder getPageNumberBuilder()

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

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

Returns
Type Description
CustomAPIPagination.PageNumberPagination.Builder

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

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.

getTokenBuilder()

public CustomAPIPagination.TokenPagination.Builder getTokenBuilder()

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

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

Returns
Type Description
CustomAPIPagination.TokenPagination.Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CustomAPIPagination other)

public CustomAPIPagination.Builder mergeFrom(CustomAPIPagination other)
Parameter
Name Description
other CustomAPIPagination
Returns
Type Description
CustomAPIPagination.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CustomAPIPagination.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CustomAPIPagination.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CustomAPIPagination.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CustomAPIPagination.Builder
Overrides
public CustomAPIPagination.Builder mergeLink(CustomAPIPagination.LinkPagination value)

Follow links provided in the response to get more data.

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

Parameter
Name Description
value CustomAPIPagination.LinkPagination
Returns
Type Description
CustomAPIPagination.Builder

mergeNone(CustomAPIPagination.NonePagination value)

public CustomAPIPagination.Builder mergeNone(CustomAPIPagination.NonePagination value)

Fetch data in a single request without paging.

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

Parameter
Name Description
value CustomAPIPagination.NonePagination
Returns
Type Description
CustomAPIPagination.Builder

mergeOffset(CustomAPIPagination.OffsetPagination value)

public CustomAPIPagination.Builder mergeOffset(CustomAPIPagination.OffsetPagination value)

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

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

Parameter
Name Description
value CustomAPIPagination.OffsetPagination
Returns
Type Description
CustomAPIPagination.Builder

mergePageNumber(CustomAPIPagination.PageNumberPagination value)

public CustomAPIPagination.Builder mergePageNumber(CustomAPIPagination.PageNumberPagination value)

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

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

Parameter
Name Description
value CustomAPIPagination.PageNumberPagination
Returns
Type Description
CustomAPIPagination.Builder

mergeToken(CustomAPIPagination.TokenPagination value)

public CustomAPIPagination.Builder mergeToken(CustomAPIPagination.TokenPagination value)

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

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

Parameter
Name Description
value CustomAPIPagination.TokenPagination
Returns
Type Description
CustomAPIPagination.Builder
public CustomAPIPagination.Builder setLink(CustomAPIPagination.LinkPagination value)

Follow links provided in the response to get more data.

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

Parameter
Name Description
value CustomAPIPagination.LinkPagination
Returns
Type Description
CustomAPIPagination.Builder
public CustomAPIPagination.Builder setLink(CustomAPIPagination.LinkPagination.Builder builderForValue)

Follow links provided in the response to get more data.

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

Parameter
Name Description
builderForValue CustomAPIPagination.LinkPagination.Builder
Returns
Type Description
CustomAPIPagination.Builder

setNone(CustomAPIPagination.NonePagination value)

public CustomAPIPagination.Builder setNone(CustomAPIPagination.NonePagination value)

Fetch data in a single request without paging.

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

Parameter
Name Description
value CustomAPIPagination.NonePagination
Returns
Type Description
CustomAPIPagination.Builder

setNone(CustomAPIPagination.NonePagination.Builder builderForValue)

public CustomAPIPagination.Builder setNone(CustomAPIPagination.NonePagination.Builder builderForValue)

Fetch data in a single request without paging.

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

Parameter
Name Description
builderForValue CustomAPIPagination.NonePagination.Builder
Returns
Type Description
CustomAPIPagination.Builder

setOffset(CustomAPIPagination.OffsetPagination value)

public CustomAPIPagination.Builder setOffset(CustomAPIPagination.OffsetPagination value)

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

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

Parameter
Name Description
value CustomAPIPagination.OffsetPagination
Returns
Type Description
CustomAPIPagination.Builder

setOffset(CustomAPIPagination.OffsetPagination.Builder builderForValue)

public CustomAPIPagination.Builder setOffset(CustomAPIPagination.OffsetPagination.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue CustomAPIPagination.OffsetPagination.Builder
Returns
Type Description
CustomAPIPagination.Builder

setPageNumber(CustomAPIPagination.PageNumberPagination value)

public CustomAPIPagination.Builder setPageNumber(CustomAPIPagination.PageNumberPagination value)

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

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

Parameter
Name Description
value CustomAPIPagination.PageNumberPagination
Returns
Type Description
CustomAPIPagination.Builder

setPageNumber(CustomAPIPagination.PageNumberPagination.Builder builderForValue)

public CustomAPIPagination.Builder setPageNumber(CustomAPIPagination.PageNumberPagination.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue CustomAPIPagination.PageNumberPagination.Builder
Returns
Type Description
CustomAPIPagination.Builder

setToken(CustomAPIPagination.TokenPagination value)

public CustomAPIPagination.Builder setToken(CustomAPIPagination.TokenPagination value)

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

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

Parameter
Name Description
value CustomAPIPagination.TokenPagination
Returns
Type Description
CustomAPIPagination.Builder

setToken(CustomAPIPagination.TokenPagination.Builder builderForValue)

public CustomAPIPagination.Builder setToken(CustomAPIPagination.TokenPagination.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue CustomAPIPagination.TokenPagination.Builder
Returns
Type Description
CustomAPIPagination.Builder