Interface MethodSettingsOrBuilder (2.45.1)

Version 2.45.1

• 2.48.0 (latest)
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public interface MethodSettingsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAutoPopulatedFields(int index)

public abstract 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;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The autoPopulatedFields at the given index.

getAutoPopulatedFieldsBytes(int index)

public abstract 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;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the autoPopulatedFields at the given index.

getAutoPopulatedFieldsCount()

public abstract 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
Type	Description
int	The count of autoPopulatedFields.

getAutoPopulatedFieldsList()

public abstract 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;

Returns
Type	Description
List<String>	A list containing the autoPopulatedFields.

getLongRunning()

public abstract 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
Type	Description
MethodSettings.LongRunning	The longRunning.

getLongRunningOrBuilder()

public abstract 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;

Returns
Type	Description
MethodSettings.LongRunningOrBuilder

getSelector()

public abstract 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
Type	Description
String	The selector.

getSelectorBytes()

public abstract 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
Type	Description
ByteString	The bytes for selector.

hasLongRunning()

public abstract 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
Type	Description
boolean	Whether the longRunning field is set.