target.apidocs.com.google.api.services.servicemanagement.model.MethodSettings.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-servicemanagement Show documentation

There is a newer version: v1-rev20241106-2.0.0

Show newest version







MethodSettings (Service Management API v1-rev20240823-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.servicemanagement.model
Class MethodSettings



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.servicemanagement.model.MethodSettings













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class MethodSettings
extends com.google.api.client.json.GenericJson
Describes the generator configuration for a method.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Service Management API. For a detailed explanation
 see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


MethodSettings() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


MethodSettings
clone() 


List<String>
getAutoPopulatedFields()
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.



LongRunning
getLongRunning()
Describes settings to use for long-running operations when generating API methods for RPCs.



String
getSelector()
The fully qualified name of the method, for which the options below apply.



MethodSettings
set(String fieldName,
   Object value) 


MethodSettings
setAutoPopulatedFields(List<String> 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.



MethodSettings
setLongRunning(LongRunning longRunning)
Describes settings to use for long-running operations when generating API methods for RPCs.



MethodSettings
setSelector(String selector)
The fully qualified name of the method, for which the options below apply.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





MethodSettings
public MethodSettings()









Method Detail





getAutoPopulatedFields
public List<String> getAutoPopulatedFields()
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

Returns:
value or null for none








setAutoPopulatedFields
public MethodSettings setAutoPopulatedFields(List<String> 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

Parameters:
autoPopulatedFields - autoPopulatedFields or null for none








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

Returns:
value or null for none








setLongRunning
public MethodSettings setLongRunning(LongRunning 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: 60s # 1 minute
 poll_delay_multiplier: 1.5 max_poll_delay: 360s # 6 minutes total_poll_timeout: 54000s # 90
 minutes

Parameters:
longRunning - longRunning or null for none








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

Returns:
value or null for none








setSelector
public MethodSettings setSelector(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. Example: publishing: method_settings: - selector:
 google.storage.control.v2.StorageControl.CreateFolder # method settings for CreateFolder...

Parameters:
selector - selector or null for none








set
public MethodSettings set(String fieldName,
                          Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public MethodSettings clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`MethodSettings`	`clone()`
`List<String>`	`getAutoPopulatedFields()` 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.
`LongRunning`	`getLongRunning()` Describes settings to use for long-running operations when generating API methods for RPCs.
`String`	`getSelector()` The fully qualified name of the method, for which the options below apply.
`MethodSettings`	`set(String fieldName, Object value)`
`MethodSettings`	`setAutoPopulatedFields(List<String> 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.
`MethodSettings`	`setLongRunning(LongRunning longRunning)` Describes settings to use for long-running operations when generating API methods for RPCs.
`MethodSettings`	`setSelector(String selector)` The fully qualified name of the method, for which the options below apply.