Class CreateReadSessionRequest (3.3.1)

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
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

PREFERRED_MIN_STREAM_COUNT_FIELD_NUMBER

public static final int PREFERRED_MIN_STREAM_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

READ_SESSION_FIELD_NUMBER

public static final int READ_SESSION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateReadSessionRequest getDefaultInstance()
Returns
TypeDescription
CreateReadSessionRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CreateReadSessionRequest.Builder newBuilder()
Returns
TypeDescription
CreateReadSessionRequest.Builder

newBuilder(CreateReadSessionRequest prototype)

public static CreateReadSessionRequest.Builder newBuilder(CreateReadSessionRequest prototype)
Parameter
NameDescription
prototypeCreateReadSessionRequest
Returns
TypeDescription
CreateReadSessionRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateReadSessionRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateReadSessionRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateReadSessionRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateReadSessionRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateReadSessionRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateReadSessionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateReadSessionRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateReadSessionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateReadSessionRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateReadSessionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateReadSessionRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateReadSessionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateReadSessionRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateReadSessionRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateReadSessionRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateReadSessionRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateReadSessionRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateReadSessionRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateReadSessionRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateReadSessionRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateReadSessionRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateReadSessionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateReadSessionRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateReadSessionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateReadSessionRequest> parser()
Returns
TypeDescription
Parser<CreateReadSessionRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public CreateReadSessionRequest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateReadSessionRequest> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ReadSessionOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
boolean

Whether the readSession field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateReadSessionRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateReadSessionRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateReadSessionRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateReadSessionRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateReadSessionRequest.Builder toBuilder()
Returns
TypeDescription
CreateReadSessionRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException