Class CreateReadSessionRequest (3.5.2)

public final class CreateReadSessionRequest extends GeneratedMessageV3 implements CreateReadSessionRequestOrBuilder

Request message for CreateReadSession.

Protobuf type google.cloud.bigquery.storage.v1.CreateReadSessionRequest

Static Fields

MAX_STREAM_COUNT_FIELD_NUMBER

public static final int MAX_STREAM_COUNT_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

PREFERRED_MIN_STREAM_COUNT_FIELD_NUMBER

public static final int PREFERRED_MIN_STREAM_COUNT_FIELD_NUMBER
Field Value
Type Description
int

READ_SESSION_FIELD_NUMBER

public static final int READ_SESSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateReadSessionRequest getDefaultInstance()
Returns
Type Description
CreateReadSessionRequest

getDescriptor()

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

newBuilder()

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

newBuilder(CreateReadSessionRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public CreateReadSessionRequest getDefaultInstanceForType()
Returns
Type Description
CreateReadSessionRequest

getMaxStreamCount()

public int getMaxStreamCount()

Max initial number of streams. If unset or zero, the server will provide a value of streams so as to produce reasonable throughput. Must be non-negative. The number of streams may be lower than the requested number, depending on the amount parallelism that is reasonable for the table. There is a default system max limit of 1,000.

This must be greater than or equal to preferred_min_stream_count. Typically, clients should either leave this unset to let the system to determine an upper bound OR set this a size for the maximum "units of work" it can gracefully handle.

int32 max_stream_count = 3;

Returns
Type Description
int

The maxStreamCount.

getParent()

public String getParent()

Required. The request project that owns the session, in the form of projects/{project_id}.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The request project that owns the session, in the form of projects/{project_id}.

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getPreferredMinStreamCount()

public int getPreferredMinStreamCount()

The minimum preferred stream count. This parameter can be used to inform the service that there is a desired lower bound on the number of streams. This is typically a target parallelism of the client (e.g. a Spark cluster with N-workers would set this to a low multiple of N to ensure good cluster utilization).

The system will make a best effort to provide at least this number of streams, but in some cases might provide less.

int32 preferred_min_stream_count = 4;

Returns
Type Description
int

The preferredMinStreamCount.

getReadSession()

public ReadSession getReadSession()

Required. Session to be created.

.google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReadSession

The readSession.

getReadSessionOrBuilder()

public ReadSessionOrBuilder getReadSessionOrBuilder()

Required. Session to be created.

.google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReadSessionOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasReadSession()

public boolean hasReadSession()

Required. Session to be created.

.google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the readSession field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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