Class ListStreamObjectsRequest.Builder (1.82.0)

public static final class ListStreamObjectsRequest.Builder extends GeneratedMessage.Builder<ListStreamObjectsRequest.Builder> implements ListStreamObjectsRequestOrBuilder

Request for listing all objects for a specific stream.

Protobuf type google.cloud.datastream.v1.ListStreamObjectsRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListStreamObjectsRequest build()
Returns
Type Description
ListStreamObjectsRequest

buildPartial()

public ListStreamObjectsRequest buildPartial()
Returns
Type Description
ListStreamObjectsRequest

clear()

public ListStreamObjectsRequest.Builder clear()
Returns
Type Description
ListStreamObjectsRequest.Builder
Overrides

clearPageSize()

public ListStreamObjectsRequest.Builder clearPageSize()

Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Returns
Type Description
ListStreamObjectsRequest.Builder

This builder for chaining.

clearPageToken()

public ListStreamObjectsRequest.Builder clearPageToken()

Page token received from a previous ListStreamObjectsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListStreamObjectsRequest must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
ListStreamObjectsRequest.Builder

This builder for chaining.

clearParent()

public ListStreamObjectsRequest.Builder clearParent()

Required. The parent stream that owns the collection of objects.

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

Returns
Type Description
ListStreamObjectsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListStreamObjectsRequest getDefaultInstanceForType()
Returns
Type Description
ListStreamObjectsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPageSize()

public int getPageSize()

Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Page token received from a previous ListStreamObjectsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListStreamObjectsRequest must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Page token received from a previous ListStreamObjectsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListStreamObjectsRequest must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent stream that owns the collection of objects.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent stream that owns the collection of objects.

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

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListStreamObjectsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public ListStreamObjectsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListStreamObjectsRequest.Builder
Overrides

setPageSize(int value)

public ListStreamObjectsRequest.Builder setPageSize(int value)

Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListStreamObjectsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListStreamObjectsRequest.Builder setPageToken(String value)

Page token received from a previous ListStreamObjectsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListStreamObjectsRequest must match the call that provided the page token.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListStreamObjectsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListStreamObjectsRequest.Builder setPageTokenBytes(ByteString value)

Page token received from a previous ListStreamObjectsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListStreamObjectsRequest must match the call that provided the page token.

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListStreamObjectsRequest.Builder

This builder for chaining.

setParent(String value)

public ListStreamObjectsRequest.Builder setParent(String value)

Required. The parent stream that owns the collection of objects.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListStreamObjectsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListStreamObjectsRequest.Builder setParentBytes(ByteString value)

Required. The parent stream that owns the collection of objects.

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListStreamObjectsRequest.Builder

This builder for chaining.