Package com.google.cloud.bigquery.storage.v1

Class CreateReadSessionRequest

  • All Implemented Interfaces:
    CreateReadSessionRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class CreateReadSessionRequest
extends com.google.protobuf.GeneratedMessageV3
implements CreateReadSessionRequestOrBuilder
     Request message for `CreateReadSession`.
    Protobuf type google.cloud.bigquery.storage.v1.CreateReadSessionRequest
    See Also:
    Serialized Form

    • Field Detail

      • READ_SESSION_FIELD_NUMBER

        public static final int READ_SESSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_STREAM_COUNT_FIELD_NUMBER

        public static final int MAX_STREAM_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PREFERRED_MIN_STREAM_COUNT_FIELD_NUMBER

        public static final int PREFERRED_MIN_STREAM_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance 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

      • 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) = { ... }
        Specified by:
        getParent in interface CreateReadSessionRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getParentBytes in interface CreateReadSessionRequestOrBuilder
        Returns:
        The bytes for parent.

      • hasReadSession

        public boolean hasReadSession()
         Required. Session to be created.
        .google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasReadSession in interface CreateReadSessionRequestOrBuilder
        Returns:
        Whether the readSession field is set.

      • getReadSession

        public ReadSession getReadSession()
         Required. Session to be created.
        .google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getReadSession in interface CreateReadSessionRequestOrBuilder
        Returns:
        The readSession.

      • 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;
        Specified by:
        getMaxStreamCount in interface CreateReadSessionRequestOrBuilder
        Returns:
        The maxStreamCount.

      • 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;
        Specified by:
        getPreferredMinStreamCount in interface CreateReadSessionRequestOrBuilder
        Returns:
        The preferredMinStreamCount.

      • 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 CreateReadSessionRequest parseFrom​(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static CreateReadSessionRequest parseFrom​(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static 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 CreateReadSessionRequest parseFrom​(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • newBuilderForType

        public CreateReadSessionRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public CreateReadSessionRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected CreateReadSessionRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<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 CreateReadSessionRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder