MethodSettings

com.google.api.client.MethodSettings
See theMethodSettings companion object
final case class MethodSettings(selector: String, longRunning: Option[LongRunning], autoPopulatedFields: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[MethodSettings]

Describes the generator configuration for a method.

Value parameters

autoPopulatedFields

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

longRunning

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

selector

The fully qualified name of the method, for which the options below apply. This is used to find the method to apply the options.

Attributes

Companion
object
Source
MethodSettings.scala
Graph
Supertypes
trait Updatable[MethodSettings]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def addAllAutoPopulatedFields(`__vs`: Iterable[String]): MethodSettings

Attributes

Source
MethodSettings.scala
def addAutoPopulatedFields(`__vs`: String*): MethodSettings

Attributes

Source
MethodSettings.scala

Attributes

Source
MethodSettings.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source
MethodSettings.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source
MethodSettings.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
MethodSettings.scala
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

Source
MethodSettings.scala
def withAutoPopulatedFields(`__v`: Seq[String]): MethodSettings

Attributes

Source
MethodSettings.scala
def withSelector(`__v`: String): MethodSettings

Attributes

Source
MethodSettings.scala
def withUnknownFields(`__v`: UnknownFieldSet): MethodSettings

Attributes

Source
MethodSettings.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source
MethodSettings.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
def update(ms: Lens[MethodSettings, MethodSettings] => () => MethodSettings*): A

Attributes

Inherited from:
Updatable
Source
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala