Cloud PubSub V1 Client - Class CloudStorage (2.8.0)

Reference documentation and code samples for the Cloud PubSub V1 Client class CloudStorage.

Ingestion settings for Cloud Storage.

Generated from protobuf message google.pubsub.v1.IngestionDataSourceSettings.CloudStorage

Namespace

Google \ Cloud \ PubSub \ V1 \ IngestionDataSourceSettings

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ state int

Output only. An output-only field that indicates the state of the Cloud Storage ingestion source.

↳ bucket string

Optional. Cloud Storage bucket. The bucket name must be without any prefix like "gs://". See the bucket naming requirements.

↳ text_format Google\Cloud\PubSub\V1\IngestionDataSourceSettings\CloudStorage\TextFormat

Optional. Data from Cloud Storage will be interpreted as text.

↳ avro_format Google\Cloud\PubSub\V1\IngestionDataSourceSettings\CloudStorage\AvroFormat

Optional. Data from Cloud Storage will be interpreted in Avro format.

↳ pubsub_avro_format Google\Cloud\PubSub\V1\IngestionDataSourceSettings\CloudStorage\PubSubAvroFormat

Optional. It will be assumed data from Cloud Storage was written via Cloud Storage subscriptions.

↳ minimum_object_create_time Google\Protobuf\Timestamp

Optional. Only objects with a larger or equal creation timestamp will be ingested.

↳ match_glob string

Optional. Glob pattern used to match objects that will be ingested. If unset, all objects will be ingested. See the supported patterns.

getState

Output only. An output-only field that indicates the state of the Cloud Storage ingestion source.

Returns
Type Description
int

setState

Output only. An output-only field that indicates the state of the Cloud Storage ingestion source.

Parameter
Name Description
var int
Returns
Type Description
$this

getBucket

Optional. Cloud Storage bucket. The bucket name must be without any prefix like "gs://". See the bucket naming requirements.

Returns
Type Description
string

setBucket

Optional. Cloud Storage bucket. The bucket name must be without any prefix like "gs://". See the bucket naming requirements.

Parameter
Name Description
var string
Returns
Type Description
$this

getTextFormat

Optional. Data from Cloud Storage will be interpreted as text.

Returns
Type Description
Google\Cloud\PubSub\V1\IngestionDataSourceSettings\CloudStorage\TextFormat|null

hasTextFormat

setTextFormat

Optional. Data from Cloud Storage will be interpreted as text.

Parameter
Name Description
var Google\Cloud\PubSub\V1\IngestionDataSourceSettings\CloudStorage\TextFormat
Returns
Type Description
$this

getAvroFormat

Optional. Data from Cloud Storage will be interpreted in Avro format.

Returns
Type Description
Google\Cloud\PubSub\V1\IngestionDataSourceSettings\CloudStorage\AvroFormat|null

hasAvroFormat

setAvroFormat

Optional. Data from Cloud Storage will be interpreted in Avro format.

Parameter
Name Description
var Google\Cloud\PubSub\V1\IngestionDataSourceSettings\CloudStorage\AvroFormat
Returns
Type Description
$this

getPubsubAvroFormat

Optional. It will be assumed data from Cloud Storage was written via Cloud Storage subscriptions.

Returns
Type Description
Google\Cloud\PubSub\V1\IngestionDataSourceSettings\CloudStorage\PubSubAvroFormat|null

hasPubsubAvroFormat

setPubsubAvroFormat

Optional. It will be assumed data from Cloud Storage was written via Cloud Storage subscriptions.

Parameter
Name Description
var Google\Cloud\PubSub\V1\IngestionDataSourceSettings\CloudStorage\PubSubAvroFormat
Returns
Type Description
$this

getMinimumObjectCreateTime

Optional. Only objects with a larger or equal creation timestamp will be ingested.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasMinimumObjectCreateTime

clearMinimumObjectCreateTime

setMinimumObjectCreateTime

Optional. Only objects with a larger or equal creation timestamp will be ingested.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getMatchGlob

Optional. Glob pattern used to match objects that will be ingested. If unset, all objects will be ingested. See the supported patterns.

Returns
Type Description
string

setMatchGlob

Optional. Glob pattern used to match objects that will be ingested. If unset, all objects will be ingested. See the supported patterns.

Parameter
Name Description
var string
Returns
Type Description
$this

getInputFormat

Returns
Type Description
string