Class MethodSettings (2.34.0)

public final class MethodSettings extends GeneratedMessageV3 implements MethodSettingsOrBuilder

Describes the generator configuration for a method.

Protobuf type google.api.MethodSettings

Static Fields

AUTO_POPULATED_FIELDS_FIELD_NUMBER

public static final int AUTO_POPULATED_FIELDS_FIELD_NUMBER
Field Value
TypeDescription
int

LONG_RUNNING_FIELD_NUMBER

public static final int LONG_RUNNING_FIELD_NUMBER
Field Value
TypeDescription
int

SELECTOR_FIELD_NUMBER

public static final int SELECTOR_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static MethodSettings getDefaultInstance()
Returns
TypeDescription
MethodSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static MethodSettings.Builder newBuilder()
Returns
TypeDescription
MethodSettings.Builder

newBuilder(MethodSettings prototype)

public static MethodSettings.Builder newBuilder(MethodSettings prototype)
Parameter
NameDescription
prototypeMethodSettings
Returns
TypeDescription
MethodSettings.Builder

parseDelimitedFrom(InputStream input)

public static MethodSettings parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MethodSettings
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MethodSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MethodSettings
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static MethodSettings parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
MethodSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MethodSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MethodSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MethodSettings parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
MethodSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MethodSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MethodSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MethodSettings parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
MethodSettings
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MethodSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MethodSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static MethodSettings parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MethodSettings
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MethodSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MethodSettings
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static MethodSettings parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
MethodSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MethodSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MethodSettings
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<MethodSettings> parser()
Returns
TypeDescription
Parser<MethodSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the autoPopulatedFields.

getDefaultInstanceForType()

public MethodSettings getDefaultInstanceForType()
Returns
TypeDescription
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: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes

.google.api.MethodSettings.LongRunning long_running = 2;

Returns
TypeDescription
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: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes

.google.api.MethodSettings.LongRunning long_running = 2;

Returns
TypeDescription
MethodSettings.LongRunningOrBuilder

getParserForType()

public Parser<MethodSettings> getParserForType()
Returns
TypeDescription
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.

string selector = 1;

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

string selector = 1;

Returns
TypeDescription
ByteString

The bytes for selector.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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: seconds: 60 # 1 minute poll_delay_multiplier: 1.5 max_poll_delay: seconds: 360 # 6 minutes total_poll_timeout: seconds: 54000 # 90 minutes

.google.api.MethodSettings.LongRunning long_running = 2;

Returns
TypeDescription
boolean

Whether the longRunning field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public MethodSettings.Builder newBuilderForType()
Returns
TypeDescription
MethodSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MethodSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
MethodSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public MethodSettings.Builder toBuilder()
Returns
TypeDescription
MethodSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException