Class: Google::Cloud::Bigquery::Storage::V1::WriteStream

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

Overview

Information about a single stream that gets data inside the storage system.

Defined Under Namespace

Modules: Type, WriteMode

Instance Attribute Summary collapse

Instance Attribute Details

#commit_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Commit time of the stream. If a stream is of COMMITTED type, then it will have a commit_time same as create_time. If the stream is of PENDING type, empty commit_time means it is not committed.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Commit time of the stream. If a stream is of COMMITTED type, then it will have a commit_time same as create_time. If the stream is of PENDING type, empty commit_time means it is not committed.



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'proto_docs/google/cloud/bigquery/storage/v1/stream.rb', line 248

class WriteStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type enum of the stream.
  module Type
    # Unknown type.
    TYPE_UNSPECIFIED = 0

    # Data will commit automatically and appear as soon as the write is
    # acknowledged.
    COMMITTED = 1

    # Data is invisible until the stream is committed.
    PENDING = 2

    # Data is only visible up to the offset to which it was flushed.
    BUFFERED = 3
  end

  # Mode enum of the stream.
  module WriteMode
    # Unknown type.
    WRITE_MODE_UNSPECIFIED = 0

    # Insert new records into the table.
    # It is the default value if customers do not specify it.
    INSERT = 1
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Create time of the stream. For the _default stream, this is the creation_time of the table.

Returns:



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'proto_docs/google/cloud/bigquery/storage/v1/stream.rb', line 248

class WriteStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type enum of the stream.
  module Type
    # Unknown type.
    TYPE_UNSPECIFIED = 0

    # Data will commit automatically and appear as soon as the write is
    # acknowledged.
    COMMITTED = 1

    # Data is invisible until the stream is committed.
    PENDING = 2

    # Data is only visible up to the offset to which it was flushed.
    BUFFERED = 3
  end

  # Mode enum of the stream.
  module WriteMode
    # Unknown type.
    WRITE_MODE_UNSPECIFIED = 0

    # Insert new records into the table.
    # It is the default value if customers do not specify it.
    INSERT = 1
  end
end

#location ⇒ ::String

Returns Immutable. The geographic location where the stream's dataset resides. See https://cloud.google.com/bigquery/docs/locations for supported locations.

Returns:



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'proto_docs/google/cloud/bigquery/storage/v1/stream.rb', line 248

class WriteStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type enum of the stream.
  module Type
    # Unknown type.
    TYPE_UNSPECIFIED = 0

    # Data will commit automatically and appear as soon as the write is
    # acknowledged.
    COMMITTED = 1

    # Data is invisible until the stream is committed.
    PENDING = 2

    # Data is only visible up to the offset to which it was flushed.
    BUFFERED = 3
  end

  # Mode enum of the stream.
  module WriteMode
    # Unknown type.
    WRITE_MODE_UNSPECIFIED = 0

    # Insert new records into the table.
    # It is the default value if customers do not specify it.
    INSERT = 1
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Name of the stream, in the form projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}.

Returns:

  • (::String) —

    Output only. Name of the stream, in the form projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}.



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'proto_docs/google/cloud/bigquery/storage/v1/stream.rb', line 248

class WriteStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type enum of the stream.
  module Type
    # Unknown type.
    TYPE_UNSPECIFIED = 0

    # Data will commit automatically and appear as soon as the write is
    # acknowledged.
    COMMITTED = 1

    # Data is invisible until the stream is committed.
    PENDING = 2

    # Data is only visible up to the offset to which it was flushed.
    BUFFERED = 3
  end

  # Mode enum of the stream.
  module WriteMode
    # Unknown type.
    WRITE_MODE_UNSPECIFIED = 0

    # Insert new records into the table.
    # It is the default value if customers do not specify it.
    INSERT = 1
  end
end

#table_schema ⇒ ::Google::Cloud::Bigquery::Storage::V1::TableSchema (readonly)

Returns Output only. The schema of the destination table. It is only returned in CreateWriteStream response. Caller should generate data that's compatible with this schema to send in initial AppendRowsRequest. The table schema could go out of date during the life time of the stream.

Returns:

  • (::Google::Cloud::Bigquery::Storage::V1::TableSchema) —

    Output only. The schema of the destination table. It is only returned in CreateWriteStream response. Caller should generate data that's compatible with this schema to send in initial AppendRowsRequest. The table schema could go out of date during the life time of the stream.



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'proto_docs/google/cloud/bigquery/storage/v1/stream.rb', line 248

class WriteStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type enum of the stream.
  module Type
    # Unknown type.
    TYPE_UNSPECIFIED = 0

    # Data will commit automatically and appear as soon as the write is
    # acknowledged.
    COMMITTED = 1

    # Data is invisible until the stream is committed.
    PENDING = 2

    # Data is only visible up to the offset to which it was flushed.
    BUFFERED = 3
  end

  # Mode enum of the stream.
  module WriteMode
    # Unknown type.
    WRITE_MODE_UNSPECIFIED = 0

    # Insert new records into the table.
    # It is the default value if customers do not specify it.
    INSERT = 1
  end
end

#type ⇒ ::Google::Cloud::Bigquery::Storage::V1::WriteStream::Type

Returns Immutable. Type of the stream.

Returns:



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'proto_docs/google/cloud/bigquery/storage/v1/stream.rb', line 248

class WriteStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type enum of the stream.
  module Type
    # Unknown type.
    TYPE_UNSPECIFIED = 0

    # Data will commit automatically and appear as soon as the write is
    # acknowledged.
    COMMITTED = 1

    # Data is invisible until the stream is committed.
    PENDING = 2

    # Data is only visible up to the offset to which it was flushed.
    BUFFERED = 3
  end

  # Mode enum of the stream.
  module WriteMode
    # Unknown type.
    WRITE_MODE_UNSPECIFIED = 0

    # Insert new records into the table.
    # It is the default value if customers do not specify it.
    INSERT = 1
  end
end

#write_mode ⇒ ::Google::Cloud::Bigquery::Storage::V1::WriteStream::WriteMode

Returns Immutable. Mode of the stream.

Returns:



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'proto_docs/google/cloud/bigquery/storage/v1/stream.rb', line 248

class WriteStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Type enum of the stream.
  module Type
    # Unknown type.
    TYPE_UNSPECIFIED = 0

    # Data will commit automatically and appear as soon as the write is
    # acknowledged.
    COMMITTED = 1

    # Data is invisible until the stream is committed.
    PENDING = 2

    # Data is only visible up to the offset to which it was flushed.
    BUFFERED = 3
  end

  # Mode enum of the stream.
  module WriteMode
    # Unknown type.
    WRITE_MODE_UNSPECIFIED = 0

    # Insert new records into the table.
    # It is the default value if customers do not specify it.
    INSERT = 1
  end
end