Documentation

MethodSettings extends Message
in package

Describes the generator configuration for a method.

Generated from protobuf message google.api.MethodSettings

Table of Contents

Properties

$long_running  : mixed
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.
$selector  : mixed
The fully qualified name of the method, for which the options below apply.

Methods

__construct()  : mixed
Constructor.
clearLongRunning()  : mixed
getLongRunning()  : LongRunning|null
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.
getSelector()  : string
The fully qualified name of the method, for which the options below apply.
hasLongRunning()  : mixed
setLongRunning()  : $this
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.
setSelector()  : $this
The fully qualified name of the method, for which the options below apply.

Properties

$long_running

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.

protected mixed $long_running = null

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

Generated from protobuf field .google.api.MethodSettings.LongRunning long_running = 2 [json_name = "longRunning"];

$selector

The fully qualified name of the method, for which the options below apply.

protected mixed $selector = ''

This is used to find the method to apply the options.

Generated from protobuf field string selector = 1 [json_name = "selector"];

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type string $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.
@type \Google\Api\MethodSettings\LongRunning $long_running
      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

}

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.

public getLongRunning() : LongRunning|null

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

Generated from protobuf field .google.api.MethodSettings.LongRunning long_running = 2 [json_name = "longRunning"];

Return values
LongRunning|null

getSelector()

The fully qualified name of the method, for which the options below apply.

public getSelector() : string

This is used to find the method to apply the options.

Generated from protobuf field string selector = 1 [json_name = "selector"];

Return values
string

setLongRunning()

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.

public setLongRunning(LongRunning $var) : $this

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

Generated from protobuf field .google.api.MethodSettings.LongRunning long_running = 2 [json_name = "longRunning"];

Parameters
$var : LongRunning
Return values
$this

setSelector()

The fully qualified name of the method, for which the options below apply.

public setSelector(string $var) : $this

This is used to find the method to apply the options.

Generated from protobuf field string selector = 1 [json_name = "selector"];

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results