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

Class CreateReadSessionRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<CreateReadSessionRequest.Builder>
com.google.cloud.bigquery.storage.v1.CreateReadSessionRequest.Builder
All Implemented Interfaces:
CreateReadSessionRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
CreateReadSessionRequest
public static final class CreateReadSessionRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<CreateReadSessionRequest.Builder> implements CreateReadSessionRequestOrBuilder
 Request message for `CreateReadSession`.
Protobuf type google.cloud.bigquery.storage.v1.CreateReadSessionRequest

  • Method Details

    • 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.Builder<CreateReadSessionRequest.Builder>

    • clear

      public CreateReadSessionRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<CreateReadSessionRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CreateReadSessionRequest.Builder>

    • getDefaultInstanceForType

      public CreateReadSessionRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

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

    • buildPartial

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

    • clone

      public CreateReadSessionRequest.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<CreateReadSessionRequest.Builder>

    • setField

      public CreateReadSessionRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<CreateReadSessionRequest.Builder>

    • clearField

      public CreateReadSessionRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<CreateReadSessionRequest.Builder>

    • clearOneof

      public CreateReadSessionRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CreateReadSessionRequest.Builder>

    • setRepeatedField

      public CreateReadSessionRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CreateReadSessionRequest.Builder>

    • addRepeatedField

      public CreateReadSessionRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CreateReadSessionRequest.Builder>

    • mergeFrom

      public CreateReadSessionRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CreateReadSessionRequest.Builder>

    • mergeFrom

      public CreateReadSessionRequest.Builder mergeFrom(CreateReadSessionRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CreateReadSessionRequest.Builder>

    • mergeFrom

      public CreateReadSessionRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<CreateReadSessionRequest.Builder>
      Throws:
      IOException

    • 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.

    • setParent

      public CreateReadSessionRequest.Builder setParent(String value)
       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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public CreateReadSessionRequest.Builder clearParent()
       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:
      This builder for chaining.

    • setParentBytes

      public CreateReadSessionRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • 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.

    • setReadSession

      public CreateReadSessionRequest.Builder setReadSession(ReadSession value)
       Required. Session to be created.
      .google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];

    • setReadSession

      public CreateReadSessionRequest.Builder setReadSession(ReadSession.Builder builderForValue)
       Required. Session to be created.
      .google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];

    • mergeReadSession

      public CreateReadSessionRequest.Builder mergeReadSession(ReadSession value)
       Required. Session to be created.
      .google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];

    • clearReadSession

      public CreateReadSessionRequest.Builder clearReadSession()
       Required. Session to be created.
      .google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];

    • getReadSessionBuilder

      public ReadSession.Builder getReadSessionBuilder()
       Required. Session to be created.
      .google.cloud.bigquery.storage.v1.ReadSession read_session = 2 [(.google.api.field_behavior) = REQUIRED];

    • getReadSessionOrBuilder

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

    • 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.

    • setMaxStreamCount

      public CreateReadSessionRequest.Builder setMaxStreamCount(int value)
       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;
      Parameters:
      value - The maxStreamCount to set.
      Returns:
      This builder for chaining.

    • clearMaxStreamCount

      public CreateReadSessionRequest.Builder clearMaxStreamCount()
       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:
      This builder for chaining.

    • 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.

    • setPreferredMinStreamCount

      public CreateReadSessionRequest.Builder setPreferredMinStreamCount(int value)
       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;
      Parameters:
      value - The preferredMinStreamCount to set.
      Returns:
      This builder for chaining.

    • clearPreferredMinStreamCount

      public CreateReadSessionRequest.Builder clearPreferredMinStreamCount()
       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:
      This builder for chaining.

    • setUnknownFields

      public final CreateReadSessionRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CreateReadSessionRequest.Builder>

    • mergeUnknownFields

      public final CreateReadSessionRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CreateReadSessionRequest.Builder>