Class AudioRecordingConfig.Builder (0.1.0)

public static final class AudioRecordingConfig.Builder extends GeneratedMessage.Builder<AudioRecordingConfig.Builder> implements AudioRecordingConfigOrBuilder

Configuration for how the audio interactions should be recorded.

Protobuf type google.cloud.ces.v1.AudioRecordingConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public AudioRecordingConfig build()
Returns
Type Description
AudioRecordingConfig

buildPartial()

public AudioRecordingConfig buildPartial()
Returns
Type Description
AudioRecordingConfig

clear()

public AudioRecordingConfig.Builder clear()
Returns
Type Description
AudioRecordingConfig.Builder
Overrides

clearGcsBucket()

public AudioRecordingConfig.Builder clearGcsBucket()

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.

string gcs_bucket = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudioRecordingConfig.Builder

This builder for chaining.

clearGcsPathPrefix()

public AudioRecordingConfig.Builder clearGcsPathPrefix()

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.

string gcs_path_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudioRecordingConfig.Builder

This builder for chaining.

getDefaultInstanceForType()

public AudioRecordingConfig getDefaultInstanceForType()
Returns
Type Description
AudioRecordingConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getGcsBucket()

public String 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.

string gcs_bucket = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The gcsBucket.

getGcsBucketBytes()

public ByteString getGcsBucketBytes()

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.

string gcs_bucket = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for gcsBucket.

getGcsPathPrefix()

public String 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.

string gcs_path_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The gcsPathPrefix.

getGcsPathPrefixBytes()

public ByteString getGcsPathPrefixBytes()

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.

string gcs_path_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for gcsPathPrefix.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AudioRecordingConfig other)

public AudioRecordingConfig.Builder mergeFrom(AudioRecordingConfig other)
Parameter
Name Description
other AudioRecordingConfig
Returns
Type Description
AudioRecordingConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AudioRecordingConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudioRecordingConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AudioRecordingConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AudioRecordingConfig.Builder
Overrides

setGcsBucket(String value)

public AudioRecordingConfig.Builder setGcsBucket(String value)

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.

string gcs_bucket = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The gcsBucket to set.

Returns
Type Description
AudioRecordingConfig.Builder

This builder for chaining.

setGcsBucketBytes(ByteString value)

public AudioRecordingConfig.Builder setGcsBucketBytes(ByteString value)

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.

string gcs_bucket = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for gcsBucket to set.

Returns
Type Description
AudioRecordingConfig.Builder

This builder for chaining.

setGcsPathPrefix(String value)

public AudioRecordingConfig.Builder setGcsPathPrefix(String value)

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.

string gcs_path_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The gcsPathPrefix to set.

Returns
Type Description
AudioRecordingConfig.Builder

This builder for chaining.

setGcsPathPrefixBytes(ByteString value)

public AudioRecordingConfig.Builder setGcsPathPrefixBytes(ByteString value)

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.

string gcs_path_prefix = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for gcsPathPrefix to set.

Returns
Type Description
AudioRecordingConfig.Builder

This builder for chaining.