Package com.google.api

Class MethodSettings

  • All Implemented Interfaces:
    MethodSettingsOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class MethodSettings
extends com.google.protobuf.GeneratedMessageV3
implements MethodSettingsOrBuilder
     Describes the generator configuration for a method.
    Protobuf type google.api.MethodSettings
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  MethodSettings.Builder
      Describes the generator configuration for a method.
      static 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.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

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

      • Fields inherited from class com.google.protobuf.GeneratedMessage

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      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.
      static MethodSettings getDefaultInstance()  
      MethodSettings getDefaultInstanceForType()  
      static 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()  
      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.
      int getSerializedSize()  
      int hashCode()  
      boolean hasLongRunning()
      Describes settings to use for long-running operations when generating API methods for RPCs.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static MethodSettings.Builder newBuilder()  
      static MethodSettings.Builder newBuilder​(MethodSettings prototype)  
      MethodSettings.Builder newBuilderForType()  
      protected MethodSettings.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static MethodSettings parseDelimitedFrom​(java.io.InputStream input)  
      static MethodSettings parseDelimitedFrom​(java.io.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​(java.io.InputStream input)  
      static MethodSettings parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MethodSettings parseFrom​(java.nio.ByteBuffer data)  
      static MethodSettings parseFrom​(java.nio.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.GeneratedMessageV3

        mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType

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

        extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

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

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, 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 Detail

      • LONG_RUNNING_FIELD_NUMBER

        public static final int LONG_RUNNING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AUTO_POPULATED_FIELDS_FIELD_NUMBER

        public static final int AUTO_POPULATED_FIELDS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Overrides:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

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

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.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​(java.lang.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​(java.nio.ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MethodSettings parseFrom​(java.nio.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​(java.io.InputStream input)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static MethodSettings parseDelimitedFrom​(java.io.InputStream input)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder