Google Cloud Ces V1 Client - Class AudioRecordingConfig (0.1.0)

Reference documentation and code samples for the Google Cloud Ces V1 Client class AudioRecordingConfig.

Configuration for how the audio interactions should be recorded.

Generated from protobuf message google.cloud.ces.v1.AudioRecordingConfig

Namespace

Google \ Cloud \ Ces \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ gcs_bucket string

Optional. The Cloud Storage bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant storage.objects.create permission to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
↳ gcs_path_prefix string

Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix $project/$location/$app/$date/$session/ will be used.

getGcsBucket

Optional. The Cloud Storage bucket to store the session audio recordings. The URI must start with "gs://".

Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant storage.objects.create permission to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

Returns
Type Description
string

setGcsBucket

Optional. The Cloud Storage bucket to store the session audio recordings. The URI must start with "gs://".

Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant storage.objects.create permission to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

Parameter
Name Description
var string
Returns
Type Description
$this

getGcsPathPrefix

Optional. The Cloud Storage path prefix for audio recordings.

This prefix can include the following placeholders, which will be dynamically substituted at serving time:

  • $project: project ID
  • $location: app location
  • $app: app ID
  • $date: session date in YYYY-MM-DD format
  • $session: session ID If the path prefix is not specified, the default prefix $project/$location/$app/$date/$session/ will be used.
Returns
Type Description
string

setGcsPathPrefix

Optional. The Cloud Storage path prefix for audio recordings.

This prefix can include the following placeholders, which will be dynamically substituted at serving time:

  • $project: project ID
  • $location: app location
  • $app: app ID
  • $date: session date in YYYY-MM-DD format
  • $session: session ID If the path prefix is not specified, the default prefix $project/$location/$app/$date/$session/ will be used.
Parameter
Name Description
var string
Returns
Type Description
$this