Class MethodSettings.Builder (2.40.0)

Version 2.40.0

• 2.49.0 (latest)
• 2.48.0
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public static final class MethodSettings.Builder extends GeneratedMessageV3.Builder<MethodSettings.Builder> implements MethodSettingsOrBuilder

Describes the generator configuration for a method.

Protobuf type google.api.MethodSettings

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > MethodSettings.Builder

Implements

MethodSettingsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllAutoPopulatedFields(Iterable<String> values)

public MethodSettings.Builder addAllAutoPopulatedFields(Iterable<String> values)

List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4.

Example of a YAML configuration:

publishing: method_settings:

• selector: google.example.v1.ExampleService.CreateExample auto_populated_fields:
  • request_id

repeated string auto_populated_fields = 3;

Parameter
Name	Description
values	Iterable<String> The autoPopulatedFields to add.

Returns
Type	Description
MethodSettings.Builder	This builder for chaining.

addAutoPopulatedFields(String value)

public MethodSettings.Builder addAutoPopulatedFields(String value)

List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4.

Example of a YAML configuration:

publishing: method_settings:

• selector: google.example.v1.ExampleService.CreateExample auto_populated_fields:
  • request_id

repeated string auto_populated_fields = 3;

Parameter
Name	Description
value	String The autoPopulatedFields to add.

Returns
Type	Description
MethodSettings.Builder	This builder for chaining.

addAutoPopulatedFieldsBytes(ByteString value)

public MethodSettings.Builder addAutoPopulatedFieldsBytes(ByteString value)

List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4.

Example of a YAML configuration:

publishing: method_settings:

• selector: google.example.v1.ExampleService.CreateExample auto_populated_fields:
  • request_id

repeated string auto_populated_fields = 3;

Parameter
Name	Description
value	ByteString The bytes of the autoPopulatedFields to add.

Returns
Type	Description
MethodSettings.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public MethodSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
MethodSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public MethodSettings build()

Returns
Type	Description
MethodSettings

buildPartial()

public MethodSettings buildPartial()

Returns
Type	Description
MethodSettings

clear()

public MethodSettings.Builder clear()

Returns
Type	Description
MethodSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAutoPopulatedFields()

public MethodSettings.Builder clearAutoPopulatedFields()

List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4.

Example of a YAML configuration:

publishing: method_settings:

• selector: google.example.v1.ExampleService.CreateExample auto_populated_fields:
  • request_id

repeated string auto_populated_fields = 3;

Returns
Type	Description
MethodSettings.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public MethodSettings.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
MethodSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLongRunning()

public MethodSettings.Builder clearLongRunning()

Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto.

Example of a YAML configuration::

publishing: method_settings:

• selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes

.google.api.MethodSettings.LongRunning long_running = 2;

Returns
Type	Description
MethodSettings.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public MethodSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
MethodSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSelector()

public MethodSettings.Builder clearSelector()

The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.

string selector = 1;

Returns
Type	Description
MethodSettings.Builder	This builder for chaining.

clone()

public MethodSettings.Builder clone()

Returns
Type	Description
MethodSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAutoPopulatedFields(int index)

public String getAutoPopulatedFields(int index)

List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4.

Example of a YAML configuration:

publishing: method_settings:

• selector: google.example.v1.ExampleService.CreateExample auto_populated_fields:
  • request_id

repeated string auto_populated_fields = 3;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The autoPopulatedFields at the given index.

getAutoPopulatedFieldsBytes(int index)

public ByteString getAutoPopulatedFieldsBytes(int index)

List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4.

Example of a YAML configuration:

publishing: method_settings:

• selector: google.example.v1.ExampleService.CreateExample auto_populated_fields:
  • request_id

repeated string auto_populated_fields = 3;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the autoPopulatedFields at the given index.

getAutoPopulatedFieldsCount()

public int getAutoPopulatedFieldsCount()

List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4.

Example of a YAML configuration:

publishing: method_settings:

• selector: google.example.v1.ExampleService.CreateExample auto_populated_fields:
  • request_id

repeated string auto_populated_fields = 3;

Returns
Type	Description
int	The count of autoPopulatedFields.

getAutoPopulatedFieldsList()

public ProtocolStringList getAutoPopulatedFieldsList()

List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4.

Example of a YAML configuration:

publishing: method_settings:

• selector: google.example.v1.ExampleService.CreateExample auto_populated_fields:
  • request_id

repeated string auto_populated_fields = 3;

Returns
Type	Description
ProtocolStringList	A list containing the autoPopulatedFields.

getDefaultInstanceForType()

public MethodSettings getDefaultInstanceForType()

Returns
Type	Description
MethodSettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getLongRunning()

public MethodSettings.LongRunning getLongRunning()

Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto.

Example of a YAML configuration::

publishing: method_settings:

• selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes

.google.api.MethodSettings.LongRunning long_running = 2;

Returns
Type	Description
MethodSettings.LongRunning	The longRunning.

getLongRunningBuilder()

public MethodSettings.LongRunning.Builder getLongRunningBuilder()

Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto.

Example of a YAML configuration::

publishing: method_settings:

• selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes

.google.api.MethodSettings.LongRunning long_running = 2;

Returns
Type	Description
MethodSettings.LongRunning.Builder

getLongRunningOrBuilder()

public MethodSettings.LongRunningOrBuilder getLongRunningOrBuilder()

Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto.

Example of a YAML configuration::

publishing: method_settings:

• selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes

.google.api.MethodSettings.LongRunning long_running = 2;

Returns
Type	Description
MethodSettings.LongRunningOrBuilder

getSelector()

public String getSelector()

The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.

string selector = 1;

Returns
Type	Description
String	The selector.

getSelectorBytes()

public ByteString getSelectorBytes()

The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.

string selector = 1;

Returns
Type	Description
ByteString	The bytes for selector.

hasLongRunning()

public boolean hasLongRunning()

Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto.

Example of a YAML configuration::

publishing: method_settings:

• selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes

.google.api.MethodSettings.LongRunning long_running = 2;

Returns
Type	Description
boolean	Whether the longRunning field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(MethodSettings other)

public MethodSettings.Builder mergeFrom(MethodSettings other)

Parameter
Name	Description
other	MethodSettings

Returns
Type	Description
MethodSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public MethodSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
MethodSettings.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public MethodSettings.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
MethodSettings.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeLongRunning(MethodSettings.LongRunning value)

public MethodSettings.Builder mergeLongRunning(MethodSettings.LongRunning value)

Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto.

Example of a YAML configuration::

publishing: method_settings:

• selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes

.google.api.MethodSettings.LongRunning long_running = 2;

Parameter
Name	Description
value	MethodSettings.LongRunning

Returns
Type	Description
MethodSettings.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final MethodSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
MethodSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAutoPopulatedFields(int index, String value)

public MethodSettings.Builder setAutoPopulatedFields(int index, String value)

List of top-level fields of the request message, that should be automatically populated by the client libraries based on their (google.api.field_info).format. Currently supported format: UUID4.

Example of a YAML configuration:

publishing: method_settings:

• selector: google.example.v1.ExampleService.CreateExample auto_populated_fields:
  • request_id

repeated string auto_populated_fields = 3;

Parameters
Name	Description
index	int The index to set the value at.
value	String The autoPopulatedFields to set.

Returns
Type	Description
MethodSettings.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public MethodSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
MethodSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setLongRunning(MethodSettings.LongRunning value)

public MethodSettings.Builder setLongRunning(MethodSettings.LongRunning value)

Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto.

Example of a YAML configuration::

publishing: method_settings:

• selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes

.google.api.MethodSettings.LongRunning long_running = 2;

Parameter
Name	Description
value	MethodSettings.LongRunning

Returns
Type	Description
MethodSettings.Builder

setLongRunning(MethodSettings.LongRunning.Builder builderForValue)

public MethodSettings.Builder setLongRunning(MethodSettings.LongRunning.Builder builderForValue)

Describes settings to use for long-running operations when generating API methods for RPCs. Complements RPCs that use the annotations in google/longrunning/operations.proto.

Example of a YAML configuration::

publishing: method_settings:

• selector: google.cloud.speech.v2.Speech.BatchRecognize long_running: initial_poll_delay: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes

.google.api.MethodSettings.LongRunning long_running = 2;

Parameter
Name	Description
builderForValue	MethodSettings.LongRunning.Builder

Returns
Type	Description
MethodSettings.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public MethodSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
MethodSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSelector(String value)

public MethodSettings.Builder setSelector(String value)

The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.

string selector = 1;

Parameter
Name	Description
value	String The selector to set.

Returns
Type	Description
MethodSettings.Builder	This builder for chaining.

setSelectorBytes(ByteString value)

public MethodSettings.Builder setSelectorBytes(ByteString value)

The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.

string selector = 1;

Parameter
Name	Description
value	ByteString The bytes for selector to set.

Returns
Type	Description
MethodSettings.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final MethodSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
MethodSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)