Class AudioRecordingConfig (0.1.0)

public final class AudioRecordingConfig extends GeneratedMessage implements AudioRecordingConfigOrBuilder

Configuration for how the audio interactions should be recorded.

Protobuf type google.cloud.ces.v1.AudioRecordingConfig

Static Fields

GCS_BUCKET_FIELD_NUMBER

public static final int GCS_BUCKET_FIELD_NUMBER
Field Value
Type Description
int

GCS_PATH_PREFIX_FIELD_NUMBER

public static final int GCS_PATH_PREFIX_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AudioRecordingConfig getDefaultInstance()
Returns
Type Description
AudioRecordingConfig

getDescriptor()

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

newBuilder()

public static AudioRecordingConfig.Builder newBuilder()
Returns
Type Description
AudioRecordingConfig.Builder

newBuilder(AudioRecordingConfig prototype)

public static AudioRecordingConfig.Builder newBuilder(AudioRecordingConfig prototype)
Parameter
Name Description
prototype AudioRecordingConfig
Returns
Type Description
AudioRecordingConfig.Builder

parseDelimitedFrom(InputStream input)

public static AudioRecordingConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AudioRecordingConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AudioRecordingConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudioRecordingConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AudioRecordingConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AudioRecordingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AudioRecordingConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudioRecordingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AudioRecordingConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AudioRecordingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AudioRecordingConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudioRecordingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AudioRecordingConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AudioRecordingConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AudioRecordingConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudioRecordingConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AudioRecordingConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AudioRecordingConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AudioRecordingConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudioRecordingConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AudioRecordingConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AudioRecordingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AudioRecordingConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudioRecordingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AudioRecordingConfig> parser()
Returns
Type Description
Parser<AudioRecordingConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public AudioRecordingConfig getDefaultInstanceForType()
Returns
Type Description
AudioRecordingConfig

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.

getParserForType()

public Parser<AudioRecordingConfig> getParserForType()
Returns
Type Description
Parser<AudioRecordingConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AudioRecordingConfig.Builder newBuilderForType()
Returns
Type Description
AudioRecordingConfig.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected AudioRecordingConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AudioRecordingConfig.Builder
Overrides

toBuilder()

public AudioRecordingConfig.Builder toBuilder()
Returns
Type Description
AudioRecordingConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException