Package com.google.api

Class MethodSettings.Builder

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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      MethodSettings.Builder addAllAutoPopulatedFields​(java.lang.Iterable<java.lang.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.
      MethodSettings.Builder addAutoPopulatedFields​(java.lang.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.
      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.
      MethodSettings build()  
      MethodSettings buildPartial()  
      MethodSettings.Builder clear()  
      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.
      MethodSettings.Builder clearLongRunning()
      Describes settings to use for long-running operations when generating API methods for RPCs.
      MethodSettings.Builder clearSelector()
      The fully qualified name of the method, for which the options below apply.
      java.lang.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.
      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.
      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.
      com.google.protobuf.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.
      MethodSettings getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Descriptors.Descriptor getDescriptorForType()  
      MethodSettings.LongRunning getLongRunning()
      Describes settings to use for long-running operations when generating API methods for RPCs.
      MethodSettings.LongRunning.Builder getLongRunningBuilder()
      Describes settings to use for long-running operations when generating API methods for RPCs.
      MethodSettings.LongRunningOrBuilder getLongRunningOrBuilder()
      Describes settings to use for long-running operations when generating API methods for RPCs.
      java.lang.String getSelector()
      The fully qualified name of the method, for which the options below apply.
      com.google.protobuf.ByteString getSelectorBytes()
      The fully qualified name of the method, for which the options below apply.
      boolean hasLongRunning()
      Describes settings to use for long-running operations when generating API methods for RPCs.
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      MethodSettings.Builder mergeFrom​(MethodSettings other)  
      MethodSettings.Builder mergeFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      MethodSettings.Builder mergeFrom​(com.google.protobuf.Message other)  
      MethodSettings.Builder mergeLongRunning​(MethodSettings.LongRunning value)
      Describes settings to use for long-running operations when generating API methods for RPCs.
      MethodSettings.Builder setAutoPopulatedFields​(int index, java.lang.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.
      MethodSettings.Builder setLongRunning​(MethodSettings.LongRunning value)
      Describes settings to use for long-running operations when generating API methods for RPCs.
      MethodSettings.Builder setLongRunning​(MethodSettings.LongRunning.Builder builderForValue)
      Describes settings to use for long-running operations when generating API methods for RPCs.
      MethodSettings.Builder setSelector​(java.lang.String value)
      The fully qualified name of the method, for which the options below apply.
      MethodSettings.Builder setSelectorBytes​(com.google.protobuf.ByteString value)
      The fully qualified name of the method, for which the options below apply.

      • Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

        addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

      • Methods inherited from class com.google.protobuf.AbstractMessage.Builder

        findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

        addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.protobuf.Message.Builder

        mergeDelimitedFrom, mergeDelimitedFrom

      • Methods inherited from interface com.google.protobuf.MessageLite.Builder

        mergeFrom

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<MethodSettings.Builder>

      • clear

        public MethodSettings.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessage.Builder<MethodSettings.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<MethodSettings.Builder>

      • getDefaultInstanceForType

        public MethodSettings getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public MethodSettings build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public MethodSettings buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • mergeFrom

        public MethodSettings.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<MethodSettings.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.Builder<MethodSettings.Builder>

      • mergeFrom

        public MethodSettings.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<MethodSettings.Builder>
        Throws:
        java.io.IOException

      • getSelector

        public java.lang.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;
        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.
        string selector = 1;
        Specified by:
        getSelectorBytes in interface MethodSettingsOrBuilder
        Returns:
        The bytes for selector.

      • setSelector

        public MethodSettings.Builder setSelector​(java.lang.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;
        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.
        string selector = 1;
        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.
        string selector = 1;
        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:
 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;
        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:
 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;
        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:
 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;

      • 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:
 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;

      • 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:
 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;

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

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

      • 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;
        Specified by:
        getLongRunningOrBuilder in interface MethodSettingsOrBuilder

      • getAutoPopulatedFieldsList

        public com.google.protobuf.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;
        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;
        Specified by:
        getAutoPopulatedFieldsCount in interface MethodSettingsOrBuilder
        Returns:
        The count of autoPopulatedFields.

      • getAutoPopulatedFields

        public java.lang.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;
        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;
        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,
                                                     java.lang.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:
        index - The index to set the value at.
        value - The autoPopulatedFields to set.
        Returns:
        This builder for chaining.

      • addAutoPopulatedFields

        public MethodSettings.Builder addAutoPopulatedFields​(java.lang.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:
        value - The autoPopulatedFields to add.
        Returns:
        This builder for chaining.

      • addAllAutoPopulatedFields

        public MethodSettings.Builder addAllAutoPopulatedFields​(java.lang.Iterable<java.lang.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;
        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;
        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;
        Parameters:
        value - The bytes of the autoPopulatedFields to add.
        Returns:
        This builder for chaining.