Google BigQuery Storage v1 API - Class AppendRowsRequest (3.7.0)

public sealed class AppendRowsRequest : IMessage<AppendRowsRequest>, IEquatable<AppendRowsRequest>, IDeepCloneable<AppendRowsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google BigQuery Storage v1 API class AppendRowsRequest.

Request message for AppendRows.

Due to the nature of AppendRows being a bidirectional streaming RPC, certain parts of the AppendRowsRequest need only be specified for the first request sent each time the gRPC network connection is opened/reopened.

The size of a single AppendRowsRequest must be less than 10 MB in size. Requests larger than this return an error, typically INVALID_ARGUMENT.

Inheritance

object > AppendRowsRequest

Implements

IMessage AppendRowsRequest, IEquatable AppendRowsRequest, IDeepCloneable AppendRowsRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.BigQuery.Storage.V1

Assembly

Google.Cloud.BigQuery.Storage.V1.dll

Constructors

AppendRowsRequest()

public AppendRowsRequest()

AppendRowsRequest(AppendRowsRequest)

public AppendRowsRequest(AppendRowsRequest other)

Parameter
Name	Description
`other`	`AppendRowsRequest`

Properties

MissingValueInterpretations

public MapField<string, AppendRowsRequest.Types.MissingValueInterpretation> MissingValueInterpretations { get; }

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

Property Value
Type	Description
`MapFieldstringAppendRowsRequestTypesMissingValueInterpretation`

Offset

public long? Offset { get; set; }

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.

Property Value
Type	Description
`long`

ProtoRows

public AppendRowsRequest.Types.ProtoData ProtoRows { get; set; }

Rows in proto format.

Property Value
Type	Description
`AppendRowsRequestTypesProtoData`

RowsCase

public AppendRowsRequest.RowsOneofCase RowsCase { get; }

Property Value
Type	Description
`AppendRowsRequestRowsOneofCase`

TraceId

public string TraceId { get; set; }

Id set by client to annotate its identity. Only initial request setting is respected.

Property Value
Type	Description
`string`

WriteStream

public string WriteStream { get; set; }

Required. The write_stream identifies the target of the append operation, and only needs to be specified as part of the first request on the gRPC connection. If provided for subsequent requests, it must match the value of the first request.

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.

Property Value
Type	Description
`string`

WriteStreamAsWriteStreamName

public WriteStreamName WriteStreamAsWriteStreamName { get; set; }

WriteStreamName-typed view over the WriteStream resource name property.

Property Value
Type	Description
`WriteStreamName`