Class MethodSettings (2.46.0) 

public final class MethodSettings extends GeneratedMessageV3 implements MethodSettingsOrBuilder

Describes the generator configuration for a method.

Protobuf type google.api.MethodSettings

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > MethodSettings

Static Fields

AUTO_POPULATED_FIELDS_FIELD_NUMBER

public static final int AUTO_POPULATED_FIELDS_FIELD_NUMBER
Field Value
Type Description
int

LONG_RUNNING_FIELD_NUMBER

public static final int LONG_RUNNING_FIELD_NUMBER
Field Value
Type Description
int

SELECTOR_FIELD_NUMBER

public static final int SELECTOR_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MethodSettings getDefaultInstance()
Returns
Type Description
MethodSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static MethodSettings.Builder newBuilder()
Returns
Type Description
MethodSettings.Builder

newBuilder(MethodSettings prototype)

public static MethodSettings.Builder newBuilder(MethodSettings prototype)
Parameter
Name Description
prototype MethodSettings
Returns
Type Description
MethodSettings.Builder

parseDelimitedFrom(InputStream input)

public static MethodSettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MethodSettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MethodSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MethodSettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MethodSettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MethodSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MethodSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MethodSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MethodSettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MethodSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MethodSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MethodSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MethodSettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MethodSettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MethodSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MethodSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MethodSettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MethodSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MethodSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MethodSettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MethodSettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MethodSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MethodSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MethodSettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MethodSettings> parser()
Returns
Type Description
Parser<MethodSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAutoPopulatedFields(int index)

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;

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

Returns
Type Description
ProtocolStringList

A list containing the autoPopulatedFields.

getDefaultInstanceForType()

public MethodSettings getDefaultInstanceForType()
Returns
Type Description
MethodSettings

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;

Returns
Type Description
MethodSettings.LongRunning

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;

Returns
Type Description
MethodSettings.LongRunningOrBuilder

getParserForType()

public Parser<MethodSettings> getParserForType()
Returns
Type Description
Parser<MethodSettings>
Overrides

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;

Returns
Type Description
String

The selector.

getSelectorBytes()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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;

Returns
Type Description
boolean

Whether the longRunning field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MethodSettings.Builder newBuilderForType()
Returns
Type Description
MethodSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MethodSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MethodSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MethodSettings.Builder toBuilder()
Returns
Type Description
MethodSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException