Package com.google.api

Interface MethodSettingsOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    MethodSettings, MethodSettings.Builder
    public interface MethodSettingsOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      java.util.List<java.lang.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.
      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.
      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.

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

        isInitialized

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

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

    • Method Detail

      • getSelector

        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;
        Returns:
        The selector.

      • getSelectorBytes

        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;
        Returns:
        The bytes for selector.

      • hasLongRunning

        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;
        Returns:
        Whether the longRunning field is set.

      • getLongRunning

        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;
        Returns:
        The longRunning.

      • getLongRunningOrBuilder

        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;

      • getAutoPopulatedFieldsList

        java.util.List<java.lang.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;
        Returns:
        A list containing the autoPopulatedFields.

      • getAutoPopulatedFieldsCount

        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;
        Returns:
        The count of autoPopulatedFields.

      • getAutoPopulatedFields

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The autoPopulatedFields at the given index.

      • getAutoPopulatedFieldsBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the autoPopulatedFields at the given index.