com.google.cloud.bigquery.storage.v1beta1

Class Storage.CreateReadSessionRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.bigquery.storage.v1beta1.Storage.CreateReadSessionRequest

All Implemented Interfaces:

Storage.CreateReadSessionRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Storage

public static final class Storage.CreateReadSessionRequest
extends com.google.protobuf.GeneratedMessageV3
implements Storage.CreateReadSessionRequestOrBuilder

 Creates a new read session, which may include additional options such as
 requested parallelism, projection filters and constraints.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Storage.CreateReadSessionRequest.Builder Creates a new read session, which may include additional options such as requested parallelism, projection filters and constraints.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	FORMAT_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER
static int	READ_OPTIONS_FIELD_NUMBER
static int	REQUESTED_STREAMS_FIELD_NUMBER
static int	SHARDING_STRATEGY_FIELD_NUMBER
static int	TABLE_MODIFIERS_FIELD_NUMBER
static int	TABLE_REFERENCE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Storage.CreateReadSessionRequest	getDefaultInstance()
Storage.CreateReadSessionRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Storage.DataFormat	getFormat() Data output format.
int	getFormatValue() Data output format.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
com.google.protobuf.Parser<Storage.CreateReadSessionRequest>	getParserForType()
ReadOptions.TableReadOptions	getReadOptions() Optional.
ReadOptions.TableReadOptionsOrBuilder	getReadOptionsOrBuilder() Optional.
int	getRequestedStreams() Optional.
int	getSerializedSize()
Storage.ShardingStrategy	getShardingStrategy() The strategy to use for distributing data among multiple streams.
int	getShardingStrategyValue() The strategy to use for distributing data among multiple streams.
TableReferenceProto.TableModifiers	getTableModifiers() Optional.
TableReferenceProto.TableModifiersOrBuilder	getTableModifiersOrBuilder() Optional.
TableReferenceProto.TableReference	getTableReference() Required.
TableReferenceProto.TableReferenceOrBuilder	getTableReferenceOrBuilder() Required.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasReadOptions() Optional.
boolean	hasTableModifiers() Optional.
boolean	hasTableReference() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Storage.CreateReadSessionRequest.Builder	newBuilder()
static Storage.CreateReadSessionRequest.Builder	newBuilder(Storage.CreateReadSessionRequest prototype)
Storage.CreateReadSessionRequest.Builder	newBuilderForType()
protected Storage.CreateReadSessionRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Storage.CreateReadSessionRequest	parseDelimitedFrom(InputStream input)
static Storage.CreateReadSessionRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Storage.CreateReadSessionRequest	parseFrom(byte[] data)
static Storage.CreateReadSessionRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Storage.CreateReadSessionRequest	parseFrom(ByteBuffer data)
static Storage.CreateReadSessionRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Storage.CreateReadSessionRequest	parseFrom(com.google.protobuf.ByteString data)
static Storage.CreateReadSessionRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Storage.CreateReadSessionRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static Storage.CreateReadSessionRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Storage.CreateReadSessionRequest	parseFrom(InputStream input)
static Storage.CreateReadSessionRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Storage.CreateReadSessionRequest>	parser()
Storage.CreateReadSessionRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TABLE_REFERENCE_FIELD_NUMBER

public static final int TABLE_REFERENCE_FIELD_NUMBER

See Also:

Constant Field Values

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

TABLE_MODIFIERS_FIELD_NUMBER

public static final int TABLE_MODIFIERS_FIELD_NUMBER

See Also:

Constant Field Values

REQUESTED_STREAMS_FIELD_NUMBER

public static final int REQUESTED_STREAMS_FIELD_NUMBER

See Also:

Constant Field Values

READ_OPTIONS_FIELD_NUMBER

public static final int READ_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

FORMAT_FIELD_NUMBER

public static final int FORMAT_FIELD_NUMBER

See Also:

Constant Field Values

SHARDING_STRATEGY_FIELD_NUMBER

public static final int SHARDING_STRATEGY_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasTableReference

public boolean hasTableReference()

 Required. Reference to the table to read.
 

.google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 1;

Specified by:

hasTableReference in interface Storage.CreateReadSessionRequestOrBuilder

getTableReference

public TableReferenceProto.TableReference getTableReference()

 Required. Reference to the table to read.
 

.google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 1;

Specified by:

getTableReference in interface Storage.CreateReadSessionRequestOrBuilder

getTableReferenceOrBuilder

public TableReferenceProto.TableReferenceOrBuilder getTableReferenceOrBuilder()

 Required. Reference to the table to read.
 

.google.cloud.bigquery.storage.v1beta1.TableReference table_reference = 1;

Specified by:

getTableReferenceOrBuilder in interface Storage.CreateReadSessionRequestOrBuilder

getParent

public String getParent()

 Required. String of the form `projects/{project_id}` indicating the
 project this ReadSession is associated with. This is the project that will
 be billed for usage.
 

string parent = 6;

Specified by:

getParent in interface Storage.CreateReadSessionRequestOrBuilder

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. String of the form `projects/{project_id}` indicating the
 project this ReadSession is associated with. This is the project that will
 be billed for usage.
 

string parent = 6;

Specified by:

getParentBytes in interface Storage.CreateReadSessionRequestOrBuilder

hasTableModifiers

public boolean hasTableModifiers()

 Optional. Any modifiers to the Table (e.g. snapshot timestamp).
 

.google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 2;

Specified by:

hasTableModifiers in interface Storage.CreateReadSessionRequestOrBuilder

getTableModifiers

public TableReferenceProto.TableModifiers getTableModifiers()

 Optional. Any modifiers to the Table (e.g. snapshot timestamp).
 

.google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 2;

Specified by:

getTableModifiers in interface Storage.CreateReadSessionRequestOrBuilder

getTableModifiersOrBuilder

public TableReferenceProto.TableModifiersOrBuilder getTableModifiersOrBuilder()

 Optional. Any modifiers to the Table (e.g. snapshot timestamp).
 

.google.cloud.bigquery.storage.v1beta1.TableModifiers table_modifiers = 2;

Specified by:

getTableModifiersOrBuilder in interface Storage.CreateReadSessionRequestOrBuilder

getRequestedStreams

public int getRequestedStreams()

 Optional. Initial number of streams. If unset or 0, we 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 and
 the maximum amount of parallelism allowed by the system.
 Streams must be read starting from offset 0.
 

int32 requested_streams = 3;

Specified by:

getRequestedStreams in interface Storage.CreateReadSessionRequestOrBuilder

hasReadOptions

public boolean hasReadOptions()

 Optional. Read options for this session (e.g. column selection, filters).
 

.google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;

Specified by:

hasReadOptions in interface Storage.CreateReadSessionRequestOrBuilder

getReadOptions

public ReadOptions.TableReadOptions getReadOptions()

 Optional. Read options for this session (e.g. column selection, filters).
 

.google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;

Specified by:

getReadOptions in interface Storage.CreateReadSessionRequestOrBuilder

getReadOptionsOrBuilder

public ReadOptions.TableReadOptionsOrBuilder getReadOptionsOrBuilder()

 Optional. Read options for this session (e.g. column selection, filters).
 

.google.cloud.bigquery.storage.v1beta1.TableReadOptions read_options = 4;

Specified by:

getReadOptionsOrBuilder in interface Storage.CreateReadSessionRequestOrBuilder

getFormatValue

public int getFormatValue()

 Data output format. Currently default to Avro.
 

.google.cloud.bigquery.storage.v1beta1.DataFormat format = 5;

Specified by:

getFormatValue in interface Storage.CreateReadSessionRequestOrBuilder

getFormat

public Storage.DataFormat getFormat()

 Data output format. Currently default to Avro.
 

.google.cloud.bigquery.storage.v1beta1.DataFormat format = 5;

Specified by:

getFormat in interface Storage.CreateReadSessionRequestOrBuilder

getShardingStrategyValue

public int getShardingStrategyValue()

 The strategy to use for distributing data among multiple streams. Currently
 defaults to liquid sharding.
 

.google.cloud.bigquery.storage.v1beta1.ShardingStrategy sharding_strategy = 7;

Specified by:

getShardingStrategyValue in interface Storage.CreateReadSessionRequestOrBuilder

getShardingStrategy

public Storage.ShardingStrategy getShardingStrategy()

 The strategy to use for distributing data among multiple streams. Currently
 defaults to liquid sharding.
 

.google.cloud.bigquery.storage.v1beta1.ShardingStrategy sharding_strategy = 7;

Specified by:

getShardingStrategy in interface Storage.CreateReadSessionRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Storage.CreateReadSessionRequest parseFrom(ByteBuffer data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Storage.CreateReadSessionRequest parseFrom(ByteBuffer data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Storage.CreateReadSessionRequest parseFrom(com.google.protobuf.ByteString data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Storage.CreateReadSessionRequest parseFrom(com.google.protobuf.ByteString data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Storage.CreateReadSessionRequest parseFrom(byte[] data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Storage.CreateReadSessionRequest parseFrom(byte[] data,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Storage.CreateReadSessionRequest parseFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseFrom

public static Storage.CreateReadSessionRequest parseFrom(InputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static Storage.CreateReadSessionRequest parseDelimitedFrom(InputStream input)
                                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static Storage.CreateReadSessionRequest parseDelimitedFrom(InputStream input,
                                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                           throws IOException

Throws:

IOException

parseFrom

public static Storage.CreateReadSessionRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                                  throws IOException

Throws:

IOException

parseFrom

public static Storage.CreateReadSessionRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

newBuilderForType

public Storage.CreateReadSessionRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Storage.CreateReadSessionRequest.Builder newBuilder()

newBuilder

public static Storage.CreateReadSessionRequest.Builder newBuilder(Storage.CreateReadSessionRequest prototype)

toBuilder

public Storage.CreateReadSessionRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Storage.CreateReadSessionRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Storage.CreateReadSessionRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<Storage.CreateReadSessionRequest> parser()

getParserForType

public com.google.protobuf.Parser<Storage.CreateReadSessionRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Storage.CreateReadSessionRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder