Package com.google.api

Class MethodSettings

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.api.MethodSettings
All Implemented Interfaces:
MethodSettingsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class MethodSettings extends com.google.protobuf.GeneratedMessage implements MethodSettingsOrBuilder
 Describes the generator configuration for a method.
Protobuf type google.api.MethodSettings
See Also:

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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.
    static MethodSettings
    getDefaultInstance()
     
    MethodSettings
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    MethodSettings.LongRunning
    getLongRunning()
    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.
    com.google.protobuf.Parser<MethodSettings>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasLongRunning()
    Describes settings to use for long-running operations when generating API methods for RPCs.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static MethodSettings.Builder
    newBuilder()
     
    static MethodSettings.Builder
    newBuilder(MethodSettings prototype)
     
    MethodSettings.Builder
    newBuilderForType()
     
    protected MethodSettings.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    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()
     
    MethodSettings.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

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

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • 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

    • 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

    • 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;
      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;
      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;
      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;
      Specified by:
      getLongRunning in interface MethodSettingsOrBuilder
      Returns:
      The longRunning.

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

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • 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

    • newBuilderForType

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

    • newBuilder

      public static MethodSettings.Builder newBuilder()

    • newBuilder

      public static MethodSettings.Builder newBuilder(MethodSettings prototype)

    • toBuilder

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

    • newBuilderForType

      protected MethodSettings.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static MethodSettings getDefaultInstance()

    • parser

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

    • getParserForType

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

    • getDefaultInstanceForType

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