public static final class MethodSettings.Builder extends GeneratedMessageV3.Builder<MethodSettings.Builder> implements MethodSettingsOrBuilderDescribes the generator configuration for a method.
Protobuf type google.api.MethodSettings
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > MethodSettings.BuilderImplements
MethodSettingsOrBuilderStatic 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 | StringThe 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 | ByteStringThe 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 | |
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 | |
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 | |
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 | |
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 | |
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 | intThe 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 | intThe 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 | |
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 | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public MethodSettings.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
MethodSettings.Builder | |
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 | |
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 | intThe index to set the value at. |
value | StringThe 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 | |
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 | |
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 | StringThe 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 | ByteStringThe 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 | |