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

Class AppendRowsRequest

  • All Implemented Interfaces:
    AppendRowsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class AppendRowsRequest
extends com.google.protobuf.GeneratedMessageV3
implements AppendRowsRequestOrBuilder
     Request message for `AppendRows`.

 Because AppendRows is a bidirectional streaming RPC, certain parts of the
 AppendRowsRequest need only be specified for the first request before
 switching table destinations. You can also switch table destinations within
 the same connection for the default stream.

 The size of a single AppendRowsRequest must be less than 10 MB in size.
 Requests larger than this return an error, typically `INVALID_ARGUMENT`.
    Protobuf type google.cloud.bigquery.storage.v1.AppendRowsRequest
    See Also:
    Serialized Form

    • Field Detail

      • WRITE_STREAM_FIELD_NUMBER

        public static final int WRITE_STREAM_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROTO_ROWS_FIELD_NUMBER

        public static final int PROTO_ROWS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MISSING_VALUE_INTERPRETATIONS_FIELD_NUMBER

        public static final int MISSING_VALUE_INTERPRETATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEFAULT_MISSING_VALUE_INTERPRETATION_FIELD_NUMBER

        public static final int DEFAULT_MISSING_VALUE_INTERPRETATION_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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getWriteStream

        public String getWriteStream()
         Required. The write_stream identifies the append operation. It must be
 provided in the following scenarios:

 * In the first request to an AppendRows connection.

 * In all subsequent requests to an AppendRows connection, if you use the
 same connection to write to multiple tables or change the input schema for
 default streams.

 For explicitly created write streams, the format is:

 * `projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}`

 For the special default stream, the format is:

 * `projects/{project}/datasets/{dataset}/tables/{table}/streams/_default`.

 An example of a possible sequence of requests with write_stream fields
 within a single connection:

 * r1: {write_stream: stream_name_1}

 * r2: {write_stream: /*omit*/}

 * r3: {write_stream: /*omit*/}

 * r4: {write_stream: stream_name_2}

 * r5: {write_stream: stream_name_2}

 The destination changed in request_4, so the write_stream field must be
 populated in all subsequent requests in this stream.
        string write_stream = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getWriteStream in interface AppendRowsRequestOrBuilder
        Returns:
        The writeStream.

      • getWriteStreamBytes

        public com.google.protobuf.ByteString getWriteStreamBytes()
         Required. The write_stream identifies the append operation. It must be
 provided in the following scenarios:

 * In the first request to an AppendRows connection.

 * In all subsequent requests to an AppendRows connection, if you use the
 same connection to write to multiple tables or change the input schema for
 default streams.

 For explicitly created write streams, the format is:

 * `projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}`

 For the special default stream, the format is:

 * `projects/{project}/datasets/{dataset}/tables/{table}/streams/_default`.

 An example of a possible sequence of requests with write_stream fields
 within a single connection:

 * r1: {write_stream: stream_name_1}

 * r2: {write_stream: /*omit*/}

 * r3: {write_stream: /*omit*/}

 * r4: {write_stream: stream_name_2}

 * r5: {write_stream: stream_name_2}

 The destination changed in request_4, so the write_stream field must be
 populated in all subsequent requests in this stream.
        string write_stream = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getWriteStreamBytes in interface AppendRowsRequestOrBuilder
        Returns:
        The bytes for writeStream.

      • hasOffset

        public boolean hasOffset()
         If present, the write is only performed if the next append offset is same
 as the provided value. If not present, the write is performed at the
 current end of stream. Specifying a value for this field is not allowed
 when calling AppendRows for the '_default' stream.
        .google.protobuf.Int64Value offset = 2;
        Specified by:
        hasOffset in interface AppendRowsRequestOrBuilder
        Returns:
        Whether the offset field is set.

      • getOffset

        public com.google.protobuf.Int64Value getOffset()
         If present, the write is only performed if the next append offset is same
 as the provided value. If not present, the write is performed at the
 current end of stream. Specifying a value for this field is not allowed
 when calling AppendRows for the '_default' stream.
        .google.protobuf.Int64Value offset = 2;
        Specified by:
        getOffset in interface AppendRowsRequestOrBuilder
        Returns:
        The offset.

      • getOffsetOrBuilder

        public com.google.protobuf.Int64ValueOrBuilder getOffsetOrBuilder()
         If present, the write is only performed if the next append offset is same
 as the provided value. If not present, the write is performed at the
 current end of stream. Specifying a value for this field is not allowed
 when calling AppendRows for the '_default' stream.
        .google.protobuf.Int64Value offset = 2;
        Specified by:
        getOffsetOrBuilder in interface AppendRowsRequestOrBuilder

      • hasProtoRows

        public boolean hasProtoRows()
         Rows in proto format.
        .google.cloud.bigquery.storage.v1.AppendRowsRequest.ProtoData proto_rows = 4;
        Specified by:
        hasProtoRows in interface AppendRowsRequestOrBuilder
        Returns:
        Whether the protoRows field is set.

      • getTraceId

        public String getTraceId()
         Id set by client to annotate its identity. Only initial request setting is
 respected.
        string trace_id = 6;
        Specified by:
        getTraceId in interface AppendRowsRequestOrBuilder
        Returns:
        The traceId.

      • getTraceIdBytes

        public com.google.protobuf.ByteString getTraceIdBytes()
         Id set by client to annotate its identity. Only initial request setting is
 respected.
        string trace_id = 6;
        Specified by:
        getTraceIdBytes in interface AppendRowsRequestOrBuilder
        Returns:
        The bytes for traceId.

      • getMissingValueInterpretationsCount

        public int getMissingValueInterpretationsCount()
        Description copied from interface: AppendRowsRequestOrBuilder
         A map to indicate how to interpret missing value for some fields. Missing
 values are fields present in user schema but missing in rows. The key is
 the field name. The value is the interpretation of missing values for the
 field.

 For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all
 missing values in field foo are interpreted as NULL, all missing values in
 field bar are interpreted as the default value of field bar in table
 schema.

 If a field is not in this map and has missing values, the missing values
 in this field are interpreted as NULL.

 This field only applies to the current request, it won't affect other
 requests on the connection.

 Currently, field name can only be top-level column name, can't be a struct
 field path like 'foo.bar'.
        map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;
        Specified by:
        getMissingValueInterpretationsCount in interface AppendRowsRequestOrBuilder

      • containsMissingValueInterpretations

        public boolean containsMissingValueInterpretations​(String key)
         A map to indicate how to interpret missing value for some fields. Missing
 values are fields present in user schema but missing in rows. The key is
 the field name. The value is the interpretation of missing values for the
 field.

 For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all
 missing values in field foo are interpreted as NULL, all missing values in
 field bar are interpreted as the default value of field bar in table
 schema.

 If a field is not in this map and has missing values, the missing values
 in this field are interpreted as NULL.

 This field only applies to the current request, it won't affect other
 requests on the connection.

 Currently, field name can only be top-level column name, can't be a struct
 field path like 'foo.bar'.
        map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;
        Specified by:
        containsMissingValueInterpretations in interface AppendRowsRequestOrBuilder

      • getMissingValueInterpretationsMap

        public Map<String,​AppendRowsRequest.MissingValueInterpretation> getMissingValueInterpretationsMap()
         A map to indicate how to interpret missing value for some fields. Missing
 values are fields present in user schema but missing in rows. The key is
 the field name. The value is the interpretation of missing values for the
 field.

 For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all
 missing values in field foo are interpreted as NULL, all missing values in
 field bar are interpreted as the default value of field bar in table
 schema.

 If a field is not in this map and has missing values, the missing values
 in this field are interpreted as NULL.

 This field only applies to the current request, it won't affect other
 requests on the connection.

 Currently, field name can only be top-level column name, can't be a struct
 field path like 'foo.bar'.
        map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;
        Specified by:
        getMissingValueInterpretationsMap in interface AppendRowsRequestOrBuilder

      • getMissingValueInterpretationsOrDefault

        public AppendRowsRequest.MissingValueInterpretation getMissingValueInterpretationsOrDefault​(String key,
                                                                                            AppendRowsRequest.MissingValueInterpretation defaultValue)
         A map to indicate how to interpret missing value for some fields. Missing
 values are fields present in user schema but missing in rows. The key is
 the field name. The value is the interpretation of missing values for the
 field.

 For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all
 missing values in field foo are interpreted as NULL, all missing values in
 field bar are interpreted as the default value of field bar in table
 schema.

 If a field is not in this map and has missing values, the missing values
 in this field are interpreted as NULL.

 This field only applies to the current request, it won't affect other
 requests on the connection.

 Currently, field name can only be top-level column name, can't be a struct
 field path like 'foo.bar'.
        map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;
        Specified by:
        getMissingValueInterpretationsOrDefault in interface AppendRowsRequestOrBuilder

      • getMissingValueInterpretationsOrThrow

        public AppendRowsRequest.MissingValueInterpretation getMissingValueInterpretationsOrThrow​(String key)
         A map to indicate how to interpret missing value for some fields. Missing
 values are fields present in user schema but missing in rows. The key is
 the field name. The value is the interpretation of missing values for the
 field.

 For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all
 missing values in field foo are interpreted as NULL, all missing values in
 field bar are interpreted as the default value of field bar in table
 schema.

 If a field is not in this map and has missing values, the missing values
 in this field are interpreted as NULL.

 This field only applies to the current request, it won't affect other
 requests on the connection.

 Currently, field name can only be top-level column name, can't be a struct
 field path like 'foo.bar'.
        map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;
        Specified by:
        getMissingValueInterpretationsOrThrow in interface AppendRowsRequestOrBuilder

      • getMissingValueInterpretationsValueMap

        public Map<String,​Integer> getMissingValueInterpretationsValueMap()
         A map to indicate how to interpret missing value for some fields. Missing
 values are fields present in user schema but missing in rows. The key is
 the field name. The value is the interpretation of missing values for the
 field.

 For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all
 missing values in field foo are interpreted as NULL, all missing values in
 field bar are interpreted as the default value of field bar in table
 schema.

 If a field is not in this map and has missing values, the missing values
 in this field are interpreted as NULL.

 This field only applies to the current request, it won't affect other
 requests on the connection.

 Currently, field name can only be top-level column name, can't be a struct
 field path like 'foo.bar'.
        map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;
        Specified by:
        getMissingValueInterpretationsValueMap in interface AppendRowsRequestOrBuilder

      • getMissingValueInterpretationsValueOrDefault

        public int getMissingValueInterpretationsValueOrDefault​(String key,
                                                        int defaultValue)
         A map to indicate how to interpret missing value for some fields. Missing
 values are fields present in user schema but missing in rows. The key is
 the field name. The value is the interpretation of missing values for the
 field.

 For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all
 missing values in field foo are interpreted as NULL, all missing values in
 field bar are interpreted as the default value of field bar in table
 schema.

 If a field is not in this map and has missing values, the missing values
 in this field are interpreted as NULL.

 This field only applies to the current request, it won't affect other
 requests on the connection.

 Currently, field name can only be top-level column name, can't be a struct
 field path like 'foo.bar'.
        map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;
        Specified by:
        getMissingValueInterpretationsValueOrDefault in interface AppendRowsRequestOrBuilder

      • getMissingValueInterpretationsValueOrThrow

        public int getMissingValueInterpretationsValueOrThrow​(String key)
         A map to indicate how to interpret missing value for some fields. Missing
 values are fields present in user schema but missing in rows. The key is
 the field name. The value is the interpretation of missing values for the
 field.

 For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all
 missing values in field foo are interpreted as NULL, all missing values in
 field bar are interpreted as the default value of field bar in table
 schema.

 If a field is not in this map and has missing values, the missing values
 in this field are interpreted as NULL.

 This field only applies to the current request, it won't affect other
 requests on the connection.

 Currently, field name can only be top-level column name, can't be a struct
 field path like 'foo.bar'.
        map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;
        Specified by:
        getMissingValueInterpretationsValueOrThrow in interface AppendRowsRequestOrBuilder

      • getDefaultMissingValueInterpretationValue

        public int getDefaultMissingValueInterpretationValue()
         Optional. Default missing value interpretation for all columns in the
 table. When a value is specified on an `AppendRowsRequest`, it is applied
 to all requests on the connection from that point forward, until a
 subsequent `AppendRowsRequest` sets it to a different value.
 `missing_value_interpretation` can override
 `default_missing_value_interpretation`. For example, if you want to write
 `NULL` instead of using default values for some columns, you can set
 `default_missing_value_interpretation` to `DEFAULT_VALUE` and at the same
 time, set `missing_value_interpretations` to `NULL_VALUE` on those columns.
        .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation default_missing_value_interpretation = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDefaultMissingValueInterpretationValue in interface AppendRowsRequestOrBuilder
        Returns:
        The enum numeric value on the wire for defaultMissingValueInterpretation.

      • getDefaultMissingValueInterpretation

        public AppendRowsRequest.MissingValueInterpretation getDefaultMissingValueInterpretation()
         Optional. Default missing value interpretation for all columns in the
 table. When a value is specified on an `AppendRowsRequest`, it is applied
 to all requests on the connection from that point forward, until a
 subsequent `AppendRowsRequest` sets it to a different value.
 `missing_value_interpretation` can override
 `default_missing_value_interpretation`. For example, if you want to write
 `NULL` instead of using default values for some columns, you can set
 `default_missing_value_interpretation` to `DEFAULT_VALUE` and at the same
 time, set `missing_value_interpretations` to `NULL_VALUE` on those columns.
        .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation default_missing_value_interpretation = 8 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDefaultMissingValueInterpretation in interface AppendRowsRequestOrBuilder
        Returns:
        The defaultMissingValueInterpretation.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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