Class: Google::Cloud::Bigquery::Storage::V1::CreateReadSessionRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/bigquery/storage/v1/storage.rb

Overview

Request message for CreateReadSession.

Instance Attribute Summary collapse

Instance Attribute Details

#max_stream_count ⇒ ::Integer

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

Returns:

  • (::Integer) —

    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.



55
56
57
58
 
# File 'proto_docs/google/cloud/bigquery/storage/v1/storage.rb', line 55

class CreateReadSessionRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

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

Returns:

  • (::String) —

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



55
56
57
58
 
# File 'proto_docs/google/cloud/bigquery/storage/v1/storage.rb', line 55

class CreateReadSessionRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#preferred_min_stream_count ⇒ ::Integer

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

Returns:

  • (::Integer) —

    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.



55
56
57
58
 
# File 'proto_docs/google/cloud/bigquery/storage/v1/storage.rb', line 55

class CreateReadSessionRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_session ⇒ ::Google::Cloud::Bigquery::Storage::V1::ReadSession

Returns Required. Session to be created.

Returns:



55
56
57
58
 
# File 'proto_docs/google/cloud/bigquery/storage/v1/storage.rb', line 55

class CreateReadSessionRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end