Class protos.google.cloud.datastream.v1alpha1.GcsDestinationConfig

Represents a GcsDestinationConfig.

Package

@google-cloud/datastream!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datastream.v1alpha1.IGcsDestinationConfig);

Constructs a new GcsDestinationConfig.

Parameter
NameDescription
properties IGcsDestinationConfig

Properties to set

Properties

avroFileFormat

public avroFileFormat?: (google.cloud.datastream.v1alpha1.IAvroFileFormat|null);

GcsDestinationConfig avroFileFormat.

Property Value
TypeDescription
(google.cloud.datastream.v1alpha1.IAvroFileFormat|null)

fileFormat

public fileFormat?: ("avroFileFormat"|"jsonFileFormat");

GcsDestinationConfig fileFormat.

Property Value
TypeDescription
("avroFileFormat"|"jsonFileFormat")

fileRotationInterval

public fileRotationInterval?: (google.protobuf.IDuration|null);

GcsDestinationConfig fileRotationInterval.

Property Value
TypeDescription
(google.protobuf.IDuration|null)

fileRotationMb

public fileRotationMb: number;

GcsDestinationConfig fileRotationMb.

Property Value
TypeDescription
number

gcsFileFormat

public gcsFileFormat: (google.cloud.datastream.v1alpha1.GcsFileFormat|keyof typeof google.cloud.datastream.v1alpha1.GcsFileFormat);

GcsDestinationConfig gcsFileFormat.

Property Value
TypeDescription
(google.cloud.datastream.v1alpha1.GcsFileFormat|keyof typeof google.cloud.datastream.v1alpha1.GcsFileFormat)

jsonFileFormat

public jsonFileFormat?: (google.cloud.datastream.v1alpha1.IJsonFileFormat|null);

GcsDestinationConfig jsonFileFormat.

Property Value
TypeDescription
(google.cloud.datastream.v1alpha1.IJsonFileFormat|null)

path

public path: string;

GcsDestinationConfig path.

Property Value
TypeDescription
string

Methods

create(properties)

public static create(properties?: google.cloud.datastream.v1alpha1.IGcsDestinationConfig): google.cloud.datastream.v1alpha1.GcsDestinationConfig;

Creates a new GcsDestinationConfig instance using the specified properties.

Parameter
NameDescription
properties IGcsDestinationConfig

Properties to set

Returns
TypeDescription
google.cloud.datastream.v1alpha1.GcsDestinationConfig

GcsDestinationConfig instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datastream.v1alpha1.GcsDestinationConfig;

Decodes a GcsDestinationConfig message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.datastream.v1alpha1.GcsDestinationConfig

GcsDestinationConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datastream.v1alpha1.GcsDestinationConfig;

Decodes a GcsDestinationConfig message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.datastream.v1alpha1.GcsDestinationConfig

GcsDestinationConfig

encode(message, writer)

public static encode(message: google.cloud.datastream.v1alpha1.IGcsDestinationConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GcsDestinationConfig message. Does not implicitly messages.

Parameters
NameDescription
message IGcsDestinationConfig

GcsDestinationConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.datastream.v1alpha1.IGcsDestinationConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified GcsDestinationConfig message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IGcsDestinationConfig

GcsDestinationConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.datastream.v1alpha1.GcsDestinationConfig;

Creates a GcsDestinationConfig message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.datastream.v1alpha1.GcsDestinationConfig

GcsDestinationConfig

toJSON()

public toJSON(): { [k: string]: any };

Converts this GcsDestinationConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.datastream.v1alpha1.GcsDestinationConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a GcsDestinationConfig message. Also converts values to other types if specified.

Parameters
NameDescription
message google.cloud.datastream.v1alpha1.GcsDestinationConfig

GcsDestinationConfig

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a GcsDestinationConfig message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not