Package com.google.api

Class MethodSettings

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MethodSettings.Builder
    Describes the generator configuration for a method.
    static final class 
    MethodSettings.LongRunning
    Describes settings to use when generating API methods that use the long-running operation pattern.
    static interface 
    MethodSettings.LongRunningOrBuilder
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    AUTO_POPULATED_FIELDS_FIELD_NUMBER
     
    static final int
    LONG_RUNNING_FIELD_NUMBER
     
    static final int
    SELECTOR_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    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.
    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.
    static MethodSettings
    getDefaultInstance()
     
    MethodSettings.LongRunning
    getLongRunning()
    Describes settings to use for long-running operations when generating API methods for RPCs.
    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.
    static MethodSettings.Builder
    newBuilder()
     
    static MethodSettings.Builder
    newBuilder(MethodSettings prototype)
     
    static MethodSettings
    parseDelimitedFrom(InputStream input)
     
    static MethodSettings
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MethodSettings
    parseFrom(byte[] data)
     
    static MethodSettings
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MethodSettings
    parseFrom(com.google.protobuf.ByteString data)
     
    static MethodSettings
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MethodSettings
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static MethodSettings
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MethodSettings
    parseFrom(InputStream input)
     
    static MethodSettings
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MethodSettings
    parseFrom(ByteBuffer data)
     
    static MethodSettings
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<MethodSettings>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

    • SELECTOR_FIELD_NUMBER

      public static final int SELECTOR_FIELD_NUMBER
      See Also:

    • LONG_RUNNING_FIELD_NUMBER

      public static final int LONG_RUNNING_FIELD_NUMBER
      See Also:

    • AUTO_POPULATED_FIELDS_FIELD_NUMBER

      public static final int AUTO_POPULATED_FIELDS_FIELD_NUMBER
      See Also:

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

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

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

    • parseFrom

      public static MethodSettings parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MethodSettings parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MethodSettings parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MethodSettings parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MethodSettings parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MethodSettings parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MethodSettings parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MethodSettings parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MethodSettings parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MethodSettings parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MethodSettings parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MethodSettings parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static MethodSettings.Builder newBuilder()

    • newBuilder

      public static MethodSettings.Builder newBuilder(MethodSettings prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<MethodSettings,MethodSettings.Builder>

    • getDefaultInstance

      public static MethodSettings getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<MethodSettings> parser()