Google Cloud Datastream V1 Client - Class GcsDestinationConfig (1.3.0)

Reference documentation and code samples for the Google Cloud Datastream V1 Client class GcsDestinationConfig.

Google Cloud Storage destination configuration

Generated from protobuf message google.cloud.datastream.v1.GcsDestinationConfig

Namespace

Google \ Cloud \ Datastream \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ path string

Path inside the Cloud Storage bucket to write data to.

↳ file_rotation_mb int

The maximum file size to be saved in the bucket.

↳ file_rotation_interval Google\Protobuf\Duration

The maximum duration for which new events are added before a file is closed and a new file is created. Values within the range of 15-60 seconds are allowed.

↳ avro_file_format Google\Cloud\Datastream\V1\AvroFileFormat

AVRO file format configuration.

↳ json_file_format Google\Cloud\Datastream\V1\JsonFileFormat

JSON file format configuration.

getPath

Path inside the Cloud Storage bucket to write data to.

Returns
TypeDescription
string

setPath

Path inside the Cloud Storage bucket to write data to.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFileRotationMb

The maximum file size to be saved in the bucket.

Returns
TypeDescription
int

setFileRotationMb

The maximum file size to be saved in the bucket.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getFileRotationInterval

The maximum duration for which new events are added before a file is closed and a new file is created. Values within the range of 15-60 seconds are allowed.

Returns
TypeDescription
Google\Protobuf\Duration|null

hasFileRotationInterval

clearFileRotationInterval

setFileRotationInterval

The maximum duration for which new events are added before a file is closed and a new file is created. Values within the range of 15-60 seconds are allowed.

Parameter
NameDescription
var Google\Protobuf\Duration
Returns
TypeDescription
$this

getAvroFileFormat

AVRO file format configuration.

Returns
TypeDescription
Google\Cloud\Datastream\V1\AvroFileFormat|null

hasAvroFileFormat

setAvroFileFormat

AVRO file format configuration.

Parameter
NameDescription
var Google\Cloud\Datastream\V1\AvroFileFormat
Returns
TypeDescription
$this

getJsonFileFormat

JSON file format configuration.

Returns
TypeDescription
Google\Cloud\Datastream\V1\JsonFileFormat|null

hasJsonFileFormat

setJsonFileFormat

JSON file format configuration.

Parameter
NameDescription
var Google\Cloud\Datastream\V1\JsonFileFormat
Returns
TypeDescription
$this

getFileFormat

Returns
TypeDescription
string