Google Cloud Contact Center Insights V1 Client - Class GcsDestination (2.2.0)

Reference documentation and code samples for the Google Cloud Contact Center Insights V1 Client class GcsDestination.

Google Cloud Storage Object details to write the feedback labels to.

Generated from protobuf message google.cloud.contactcenterinsights.v1.BulkDownloadFeedbackLabelsRequest.GcsDestination

Namespace

Google \ Cloud \ ContactCenterInsights \ V1 \ BulkDownloadFeedbackLabelsRequest

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ format int

Required. File format in which the labels will be exported.

↳ object_uri string

Required. The Google Cloud Storage URI to write the feedback labels to. The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. gs://bucket_name/object_uri_prefix

↳ add_whitespace bool

Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.

↳ always_print_empty_fields bool

Optional. Always print fields with no presence. This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format.

↳ records_per_file_count int|string

Optional. The number of records per file. Applicable for either format.

getFormat

Required. File format in which the labels will be exported.

Returns
Type Description
int

setFormat

Required. File format in which the labels will be exported.

Parameter
Name Description
var int
Returns
Type Description
$this

getObjectUri

Required. The Google Cloud Storage URI to write the feedback labels to.

The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. gs://bucket_name/object_uri_prefix

Returns
Type Description
string

setObjectUri

Required. The Google Cloud Storage URI to write the feedback labels to.

The file name will be used as a prefix for the files written to the bucket if the output needs to be split across multiple files, otherwise it will be used as is. The file extension will be appended to the file name based on the format selected. E.g. gs://bucket_name/object_uri_prefix

Parameter
Name Description
var string
Returns
Type Description
$this

getAddWhitespace

Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.

Returns
Type Description
bool

setAddWhitespace

Optional. Add whitespace to the JSON file. Makes easier to read, but increases file size. Only applicable for JSON format.

Parameter
Name Description
var bool
Returns
Type Description
$this

getAlwaysPrintEmptyFields

Optional. Always print fields with no presence.

This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format.

Returns
Type Description
bool

setAlwaysPrintEmptyFields

Optional. Always print fields with no presence.

This is useful for printing fields that are not set, like implicit 0 value or empty lists/maps. Only applicable for JSON format.

Parameter
Name Description
var bool
Returns
Type Description
$this

getRecordsPerFileCount

Optional. The number of records per file. Applicable for either format.

Returns
Type Description
int|string

setRecordsPerFileCount

Optional. The number of records per file. Applicable for either format.

Parameter
Name Description
var int|string
Returns
Type Description
$this