Package com.google.api

Class MethodSettings.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<MethodSettings,MethodSettings.Builder>
com.google.protobuf.GeneratedMessageLite.Builder<MethodSettings,MethodSettings.Builder>
com.google.api.MethodSettings.Builder
All Implemented Interfaces:
MethodSettingsOrBuilder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, Cloneable
Enclosing class:
MethodSettings
public static final class MethodSettings.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<MethodSettings,MethodSettings.Builder> implements MethodSettingsOrBuilder
 Describes the generator configuration for a method.
Protobuf type google.api.MethodSettings

  • Method Details

    • 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.

 Example:

 publishing:
 method_settings:
 - selector: google.storage.control.v2.StorageControl.CreateFolder
 # method settings for CreateFolder...
      string selector = 1 [json_name = "selector"];
      Specified by:
      getSelector in interface MethodSettingsOrBuilder
      Returns:
      The selector.

    • getSelectorBytes

      public com.google.protobuf.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.

 Example:

 publishing:
 method_settings:
 - selector: google.storage.control.v2.StorageControl.CreateFolder
 # method settings for CreateFolder...
      string selector = 1 [json_name = "selector"];
      Specified by:
      getSelectorBytes in interface MethodSettingsOrBuilder
      Returns:
      The bytes for selector.

    • setSelector

      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.

 Example:

 publishing:
 method_settings:
 - selector: google.storage.control.v2.StorageControl.CreateFolder
 # method settings for CreateFolder...
      string selector = 1 [json_name = "selector"];
      Parameters:
      value - The selector to set.
      Returns:
      This builder for chaining.

    • 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.

 Example:

 publishing:
 method_settings:
 - selector: google.storage.control.v2.StorageControl.CreateFolder
 # method settings for CreateFolder...
      string selector = 1 [json_name = "selector"];
      Returns:
      This builder for chaining.

    • setSelectorBytes

      public MethodSettings.Builder setSelectorBytes(com.google.protobuf.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.

 Example:

 publishing:
 method_settings:
 - selector: google.storage.control.v2.StorageControl.CreateFolder
 # method settings for CreateFolder...
      string selector = 1 [json_name = "selector"];
      Parameters:
      value - The bytes for selector to set.
      Returns:
      This builder for chaining.

    • 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: 60s # 1 minute
 poll_delay_multiplier: 1.5
 max_poll_delay: 360s # 6 minutes
 total_poll_timeout: 54000s # 90 minutes
      .google.api.MethodSettings.LongRunning long_running = 2 [json_name = "longRunning"];
      Specified by:
      hasLongRunning in interface MethodSettingsOrBuilder
      Returns:
      Whether the longRunning field is set.

    • 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: 60s # 1 minute
 poll_delay_multiplier: 1.5
 max_poll_delay: 360s # 6 minutes
 total_poll_timeout: 54000s # 90 minutes
      .google.api.MethodSettings.LongRunning long_running = 2 [json_name = "longRunning"];
      Specified by:
      getLongRunning in interface MethodSettingsOrBuilder
      Returns:
      The longRunning.

    • setLongRunning

      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: 60s # 1 minute
 poll_delay_multiplier: 1.5
 max_poll_delay: 360s # 6 minutes
 total_poll_timeout: 54000s # 90 minutes
      .google.api.MethodSettings.LongRunning long_running = 2 [json_name = "longRunning"];

    • setLongRunning

      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: 60s # 1 minute
 poll_delay_multiplier: 1.5
 max_poll_delay: 360s # 6 minutes
 total_poll_timeout: 54000s # 90 minutes
      .google.api.MethodSettings.LongRunning long_running = 2 [json_name = "longRunning"];

    • mergeLongRunning

      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: 60s # 1 minute
 poll_delay_multiplier: 1.5
 max_poll_delay: 360s # 6 minutes
 total_poll_timeout: 54000s # 90 minutes
      .google.api.MethodSettings.LongRunning long_running = 2 [json_name = "longRunning"];

    • 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: 60s # 1 minute
 poll_delay_multiplier: 1.5
 max_poll_delay: 360s # 6 minutes
 total_poll_timeout: 54000s # 90 minutes
      .google.api.MethodSettings.LongRunning long_running = 2 [json_name = "longRunning"];

    • getAutoPopulatedFieldsList

      public List<String> 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 [json_name = "autoPopulatedFields"];
      Specified by:
      getAutoPopulatedFieldsList in interface MethodSettingsOrBuilder
      Returns:
      A list containing the autoPopulatedFields.

    • 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 [json_name = "autoPopulatedFields"];
      Specified by:
      getAutoPopulatedFieldsCount in interface MethodSettingsOrBuilder
      Returns:
      The count of autoPopulatedFields.

    • getAutoPopulatedFields

      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 [json_name = "autoPopulatedFields"];
      Specified by:
      getAutoPopulatedFields in interface MethodSettingsOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The autoPopulatedFields at the given index.

    • getAutoPopulatedFieldsBytes

      public com.google.protobuf.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 [json_name = "autoPopulatedFields"];
      Specified by:
      getAutoPopulatedFieldsBytes in interface MethodSettingsOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the autoPopulatedFields at the given index.

    • setAutoPopulatedFields

      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 [json_name = "autoPopulatedFields"];
      Parameters:
      index - The index to set the value at.
      value - The autoPopulatedFields to set.
      Returns:
      This builder for chaining.

    • addAutoPopulatedFields

      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 [json_name = "autoPopulatedFields"];
      Parameters:
      value - The autoPopulatedFields to add.
      Returns:
      This builder for chaining.

    • addAllAutoPopulatedFields

      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 [json_name = "autoPopulatedFields"];
      Parameters:
      values - The autoPopulatedFields to add.
      Returns:
      This builder for chaining.

    • 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 [json_name = "autoPopulatedFields"];
      Returns:
      This builder for chaining.

    • addAutoPopulatedFieldsBytes

      public MethodSettings.Builder addAutoPopulatedFieldsBytes(com.google.protobuf.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 [json_name = "autoPopulatedFields"];
      Parameters:
      value - The bytes of the autoPopulatedFields to add.
      Returns:
      This builder for chaining.

    • hasBatching

      public boolean hasBatching()
       Batching configuration for an API method in client libraries.

 Example of a YAML configuration:

 publishing:
 method_settings:
 - selector: google.example.v1.ExampleService.BatchCreateExample
 batching:
 element_count_threshold: 1000
 request_byte_threshold: 100000000
 delay_threshold_millis: 10
      .google.api.BatchingConfigProto batching = 4 [json_name = "batching"];
      Specified by:
      hasBatching in interface MethodSettingsOrBuilder
      Returns:
      Whether the batching field is set.

    • getBatching

      public BatchingConfigProto getBatching()
       Batching configuration for an API method in client libraries.

 Example of a YAML configuration:

 publishing:
 method_settings:
 - selector: google.example.v1.ExampleService.BatchCreateExample
 batching:
 element_count_threshold: 1000
 request_byte_threshold: 100000000
 delay_threshold_millis: 10
      .google.api.BatchingConfigProto batching = 4 [json_name = "batching"];
      Specified by:
      getBatching in interface MethodSettingsOrBuilder
      Returns:
      The batching.

    • setBatching

      public MethodSettings.Builder setBatching(BatchingConfigProto value)
       Batching configuration for an API method in client libraries.

 Example of a YAML configuration:

 publishing:
 method_settings:
 - selector: google.example.v1.ExampleService.BatchCreateExample
 batching:
 element_count_threshold: 1000
 request_byte_threshold: 100000000
 delay_threshold_millis: 10
      .google.api.BatchingConfigProto batching = 4 [json_name = "batching"];

    • setBatching

      public MethodSettings.Builder setBatching(BatchingConfigProto.Builder builderForValue)
       Batching configuration for an API method in client libraries.

 Example of a YAML configuration:

 publishing:
 method_settings:
 - selector: google.example.v1.ExampleService.BatchCreateExample
 batching:
 element_count_threshold: 1000
 request_byte_threshold: 100000000
 delay_threshold_millis: 10
      .google.api.BatchingConfigProto batching = 4 [json_name = "batching"];

    • mergeBatching

      public MethodSettings.Builder mergeBatching(BatchingConfigProto value)
       Batching configuration for an API method in client libraries.

 Example of a YAML configuration:

 publishing:
 method_settings:
 - selector: google.example.v1.ExampleService.BatchCreateExample
 batching:
 element_count_threshold: 1000
 request_byte_threshold: 100000000
 delay_threshold_millis: 10
      .google.api.BatchingConfigProto batching = 4 [json_name = "batching"];

    • clearBatching

      public MethodSettings.Builder clearBatching()
       Batching configuration for an API method in client libraries.

 Example of a YAML configuration:

 publishing:
 method_settings:
 - selector: google.example.v1.ExampleService.BatchCreateExample
 batching:
 element_count_threshold: 1000
 request_byte_threshold: 100000000
 delay_threshold_millis: 10
      .google.api.BatchingConfigProto batching = 4 [json_name = "batching"];