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

Class WriteStream

  • All Implemented Interfaces:
    WriteStreamOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class WriteStream
extends com.google.protobuf.GeneratedMessageV3
implements WriteStreamOrBuilder
     Information about a single stream that gets data inside the storage system.
    Protobuf type google.cloud.bigquery.storage.v1.WriteStream
    See Also:
    Serialized Form

    • 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

      • getName

        public String getName()
         Output only. Name of the stream, in the form
 `projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface WriteStreamOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Name of the stream, in the form
 `projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface WriteStreamOrBuilder
        Returns:
        The bytes for name.

      • getTypeValue

        public int getTypeValue()
         Immutable. Type of the stream.
        .google.cloud.bigquery.storage.v1.WriteStream.Type type = 2 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getTypeValue in interface WriteStreamOrBuilder
        Returns:
        The enum numeric value on the wire for type.

      • getType

        public WriteStream.Type getType()
         Immutable. Type of the stream.
        .google.cloud.bigquery.storage.v1.WriteStream.Type type = 2 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getType in interface WriteStreamOrBuilder
        Returns:
        The type.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Create time of the stream. For the _default stream, this is
 the creation_time of the table.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface WriteStreamOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Create time of the stream. For the _default stream, this is
 the creation_time of the table.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface WriteStreamOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Create time of the stream. For the _default stream, this is
 the creation_time of the table.
        .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface WriteStreamOrBuilder

      • hasCommitTime

        public boolean hasCommitTime()
         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.
        .google.protobuf.Timestamp commit_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCommitTime in interface WriteStreamOrBuilder
        Returns:
        Whether the commitTime field is set.

      • getCommitTime

        public com.google.protobuf.Timestamp getCommitTime()
         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.
        .google.protobuf.Timestamp commit_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCommitTime in interface WriteStreamOrBuilder
        Returns:
        The commitTime.

      • getCommitTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCommitTimeOrBuilder()
         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.
        .google.protobuf.Timestamp commit_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCommitTimeOrBuilder in interface WriteStreamOrBuilder

      • hasTableSchema

        public boolean hasTableSchema()
         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.
        .google.cloud.bigquery.storage.v1.TableSchema table_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasTableSchema in interface WriteStreamOrBuilder
        Returns:
        Whether the tableSchema field is set.

      • getTableSchema

        public TableSchema getTableSchema()
         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.
        .google.cloud.bigquery.storage.v1.TableSchema table_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTableSchema in interface WriteStreamOrBuilder
        Returns:
        The tableSchema.

      • getTableSchemaOrBuilder

        public TableSchemaOrBuilder getTableSchemaOrBuilder()
         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.
        .google.cloud.bigquery.storage.v1.TableSchema table_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getTableSchemaOrBuilder in interface WriteStreamOrBuilder

      • getWriteModeValue

        public int getWriteModeValue()
         Immutable. Mode of the stream.
        .google.cloud.bigquery.storage.v1.WriteStream.WriteMode write_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getWriteModeValue in interface WriteStreamOrBuilder
        Returns:
        The enum numeric value on the wire for writeMode.

      • getWriteMode

        public WriteStream.WriteMode getWriteMode()
         Immutable. Mode of the stream.
        .google.cloud.bigquery.storage.v1.WriteStream.WriteMode write_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getWriteMode in interface WriteStreamOrBuilder
        Returns:
        The writeMode.

      • getLocation

        public String getLocation()
         Immutable. The geographic location where the stream's dataset resides. See
 https://cloud.google.com/bigquery/docs/locations for supported
 locations.
        string location = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getLocation in interface WriteStreamOrBuilder
        Returns:
        The location.

      • getLocationBytes

        public com.google.protobuf.ByteString getLocationBytes()
         Immutable. The geographic location where the stream's dataset resides. See
 https://cloud.google.com/bigquery/docs/locations for supported
 locations.
        string location = 8 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getLocationBytes in interface WriteStreamOrBuilder
        Returns:
        The bytes for location.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static WriteStream parseFrom​(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static WriteStream parseFrom​(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static WriteStream getDefaultInstance()

      • parser

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

      • getParserForType

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