Class CustomVoiceSample.Builder (0.19.0)

public static final class CustomVoiceSample.Builder extends GeneratedMessage.Builder<CustomVoiceSample.Builder> implements CustomVoiceSampleOrBuilder

Configuration for a custom voice sample used for voice cloning.

Protobuf type google.cloud.ces.v1beta.CustomVoiceSample

Static Methods

getDescriptor()

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

Methods

addAllWarnings(Iterable<? extends CustomVoiceSample.Warning> values)

public CustomVoiceSample.Builder addAllWarnings(Iterable<? extends CustomVoiceSample.Warning> values)

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.cloud.ces.v1beta.CustomVoiceSample.Warning>
Returns
Type Description
CustomVoiceSample.Builder

addWarnings(CustomVoiceSample.Warning value)

public CustomVoiceSample.Builder addWarnings(CustomVoiceSample.Warning value)

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value CustomVoiceSample.Warning
Returns
Type Description
CustomVoiceSample.Builder

addWarnings(CustomVoiceSample.Warning.Builder builderForValue)

public CustomVoiceSample.Builder addWarnings(CustomVoiceSample.Warning.Builder builderForValue)

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue CustomVoiceSample.Warning.Builder
Returns
Type Description
CustomVoiceSample.Builder

addWarnings(int index, CustomVoiceSample.Warning value)

public CustomVoiceSample.Builder addWarnings(int index, CustomVoiceSample.Warning value)

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value CustomVoiceSample.Warning
Returns
Type Description
CustomVoiceSample.Builder

addWarnings(int index, CustomVoiceSample.Warning.Builder builderForValue)

public CustomVoiceSample.Builder addWarnings(int index, CustomVoiceSample.Warning.Builder builderForValue)

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue CustomVoiceSample.Warning.Builder
Returns
Type Description
CustomVoiceSample.Builder

addWarningsBuilder()

public CustomVoiceSample.Warning.Builder addWarningsBuilder()

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CustomVoiceSample.Warning.Builder

addWarningsBuilder(int index)

public CustomVoiceSample.Warning.Builder addWarningsBuilder(int index)

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
CustomVoiceSample.Warning.Builder

build()

public CustomVoiceSample build()
Returns
Type Description
CustomVoiceSample

buildPartial()

public CustomVoiceSample buildPartial()
Returns
Type Description
CustomVoiceSample

clear()

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

clearConsentAudioGcsUri()

public CustomVoiceSample.Builder clearConsentAudioGcsUri()

Optional. Consent audio for voice cloning.

string consent_audio_gcs_uri = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

clearName()

public CustomVoiceSample.Builder clearName()

Optional. The user-defined name for the custom voice sample.

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

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

clearPreviewAudioContent()

public CustomVoiceSample.Builder clearPreviewAudioContent()

Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).

bytes preview_audio_content = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

clearPreviewText()

public CustomVoiceSample.Builder clearPreviewText()

Optional. Text for synthesizing preview audio for custom voice.

string preview_text = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

clearVoiceInstruction()

public CustomVoiceSample.Builder clearVoiceInstruction()

Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.

string voice_instruction = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

clearVoiceInstructionMode()

public CustomVoiceSample.Builder clearVoiceInstructionMode()

Optional. Instruction mode for the voice sample. If unspecified, defaults to NO_INSTRUCTION.

.google.cloud.ces.v1beta.CustomVoiceSample.VoiceInstructionMode voice_instruction_mode = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

clearVoiceSampleGcsUri()

public CustomVoiceSample.Builder clearVoiceSampleGcsUri()

Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.

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

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

clearWarnings()

public CustomVoiceSample.Builder clearWarnings()

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
CustomVoiceSample.Builder

getConsentAudioGcsUri()

public String getConsentAudioGcsUri()

Optional. Consent audio for voice cloning.

string consent_audio_gcs_uri = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The consentAudioGcsUri.

getConsentAudioGcsUriBytes()

public ByteString getConsentAudioGcsUriBytes()

Optional. Consent audio for voice cloning.

string consent_audio_gcs_uri = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for consentAudioGcsUri.

getDefaultInstanceForType()

public CustomVoiceSample getDefaultInstanceForType()
Returns
Type Description
CustomVoiceSample

getDescriptorForType()

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

getName()

public String getName()

Optional. The user-defined name for the custom voice sample.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Optional. The user-defined name for the custom voice sample.

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

Returns
Type Description
ByteString

The bytes for name.

getPreviewAudioContent()

public ByteString getPreviewAudioContent()

Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).

bytes preview_audio_content = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The previewAudioContent.

getPreviewText()

public String getPreviewText()

Optional. Text for synthesizing preview audio for custom voice.

string preview_text = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The previewText.

getPreviewTextBytes()

public ByteString getPreviewTextBytes()

Optional. Text for synthesizing preview audio for custom voice.

string preview_text = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for previewText.

getVoiceInstruction()

public String getVoiceInstruction()

Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.

string voice_instruction = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The voiceInstruction.

getVoiceInstructionBytes()

public ByteString getVoiceInstructionBytes()

Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.

string voice_instruction = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for voiceInstruction.

getVoiceInstructionMode()

public CustomVoiceSample.VoiceInstructionMode getVoiceInstructionMode()

Optional. Instruction mode for the voice sample. If unspecified, defaults to NO_INSTRUCTION.

.google.cloud.ces.v1beta.CustomVoiceSample.VoiceInstructionMode voice_instruction_mode = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
CustomVoiceSample.VoiceInstructionMode

The voiceInstructionMode.

getVoiceInstructionModeValue()

public int getVoiceInstructionModeValue()

Optional. Instruction mode for the voice sample. If unspecified, defaults to NO_INSTRUCTION.

.google.cloud.ces.v1beta.CustomVoiceSample.VoiceInstructionMode voice_instruction_mode = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for voiceInstructionMode.

getVoiceSampleGcsUri()

public String getVoiceSampleGcsUri()

Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.

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

Returns
Type Description
String

The voiceSampleGcsUri.

getVoiceSampleGcsUriBytes()

public ByteString getVoiceSampleGcsUriBytes()

Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.

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

Returns
Type Description
ByteString

The bytes for voiceSampleGcsUri.

getWarnings(int index)

public CustomVoiceSample.Warning getWarnings(int index)

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
CustomVoiceSample.Warning

getWarningsBuilder(int index)

public CustomVoiceSample.Warning.Builder getWarningsBuilder(int index)

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
CustomVoiceSample.Warning.Builder

getWarningsBuilderList()

public List<CustomVoiceSample.Warning.Builder> getWarningsBuilderList()

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Builder>

getWarningsCount()

public int getWarningsCount()

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getWarningsList()

public List<CustomVoiceSample.Warning> getWarningsList()

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Warning>

getWarningsOrBuilder(int index)

public CustomVoiceSample.WarningOrBuilder getWarningsOrBuilder(int index)

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
CustomVoiceSample.WarningOrBuilder

getWarningsOrBuilderList()

public List<? extends CustomVoiceSample.WarningOrBuilder> getWarningsOrBuilderList()

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.ces.v1beta.CustomVoiceSample.WarningOrBuilder>

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CustomVoiceSample other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

removeWarnings(int index)

public CustomVoiceSample.Builder removeWarnings(int index)

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
CustomVoiceSample.Builder

setConsentAudioGcsUri(String value)

public CustomVoiceSample.Builder setConsentAudioGcsUri(String value)

Optional. Consent audio for voice cloning.

string consent_audio_gcs_uri = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The consentAudioGcsUri to set.

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

setConsentAudioGcsUriBytes(ByteString value)

public CustomVoiceSample.Builder setConsentAudioGcsUriBytes(ByteString value)

Optional. Consent audio for voice cloning.

string consent_audio_gcs_uri = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for consentAudioGcsUri to set.

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

setName(String value)

public CustomVoiceSample.Builder setName(String value)

Optional. The user-defined name for the custom voice sample.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

setNameBytes(ByteString value)

public CustomVoiceSample.Builder setNameBytes(ByteString value)

Optional. The user-defined name for the custom voice sample.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

setPreviewAudioContent(ByteString value)

public CustomVoiceSample.Builder setPreviewAudioContent(ByteString value)

Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono).

bytes preview_audio_content = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The previewAudioContent to set.

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

setPreviewText(String value)

public CustomVoiceSample.Builder setPreviewText(String value)

Optional. Text for synthesizing preview audio for custom voice.

string preview_text = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The previewText to set.

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

setPreviewTextBytes(ByteString value)

public CustomVoiceSample.Builder setPreviewTextBytes(ByteString value)

Optional. Text for synthesizing preview audio for custom voice.

string preview_text = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for previewText to set.

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

setVoiceInstruction(String value)

public CustomVoiceSample.Builder setVoiceInstruction(String value)

Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.

string voice_instruction = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The voiceInstruction to set.

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

setVoiceInstructionBytes(ByteString value)

public CustomVoiceSample.Builder setVoiceInstructionBytes(ByteString value)

Optional. Natural language instructions for voice style, tone, pacing, or pronunciation.

string voice_instruction = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for voiceInstruction to set.

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

setVoiceInstructionMode(CustomVoiceSample.VoiceInstructionMode value)

public CustomVoiceSample.Builder setVoiceInstructionMode(CustomVoiceSample.VoiceInstructionMode value)

Optional. Instruction mode for the voice sample. If unspecified, defaults to NO_INSTRUCTION.

.google.cloud.ces.v1beta.CustomVoiceSample.VoiceInstructionMode voice_instruction_mode = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value CustomVoiceSample.VoiceInstructionMode

The voiceInstructionMode to set.

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

setVoiceInstructionModeValue(int value)

public CustomVoiceSample.Builder setVoiceInstructionModeValue(int value)

Optional. Instruction mode for the voice sample. If unspecified, defaults to NO_INSTRUCTION.

.google.cloud.ces.v1beta.CustomVoiceSample.VoiceInstructionMode voice_instruction_mode = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for voiceInstructionMode to set.

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

setVoiceSampleGcsUri(String value)

public CustomVoiceSample.Builder setVoiceSampleGcsUri(String value)

Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.

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

Parameter
Name Description
value String

The voiceSampleGcsUri to set.

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

setVoiceSampleGcsUriBytes(ByteString value)

public CustomVoiceSample.Builder setVoiceSampleGcsUriBytes(ByteString value)

Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.

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

Parameter
Name Description
value ByteString

The bytes for voiceSampleGcsUri to set.

Returns
Type Description
CustomVoiceSample.Builder

This builder for chaining.

setWarnings(int index, CustomVoiceSample.Warning value)

public CustomVoiceSample.Builder setWarnings(int index, CustomVoiceSample.Warning value)

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value CustomVoiceSample.Warning
Returns
Type Description
CustomVoiceSample.Builder

setWarnings(int index, CustomVoiceSample.Warning.Builder builderForValue)

public CustomVoiceSample.Builder setWarnings(int index, CustomVoiceSample.Warning.Builder builderForValue)

Output only. Warning messages encountered during voice clone processing (e.g. low audio level).

repeated .google.cloud.ces.v1beta.CustomVoiceSample.Warning warnings = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue CustomVoiceSample.Warning.Builder
Returns
Type Description
CustomVoiceSample.Builder