target.apidocs.com.google.api.services.servicemanagement.model.LongRunning.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







LongRunning (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 LongRunning



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













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




public final class LongRunning
extends com.google.api.client.json.GenericJson
Describes settings to use when generating API methods that use the long-running operation
 pattern. All default values below are from those used in the client library generators (e.g.
 [Java](https://github.com/googleapis/gapic-generator-java/blob/04c2faa191a9b5a10b92392fe8482279c4
 404803/src/main/java/com/google/api/generator/gapic/composer/common/RetrySettingsComposer.java)).

  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


LongRunning() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


LongRunning
clone() 


String
getInitialPollDelay()
Initial delay after which the first poll request will be made.



String
getMaxPollDelay()
Maximum time between two subsequent poll requests.



Float
getPollDelayMultiplier()
Multiplier to gradually increase delay between subsequent polls until it reaches
 max_poll_delay.



String
getTotalPollTimeout()
Total polling timeout.



LongRunning
set(String fieldName,
   Object value) 


LongRunning
setInitialPollDelay(String initialPollDelay)
Initial delay after which the first poll request will be made.



LongRunning
setMaxPollDelay(String maxPollDelay)
Maximum time between two subsequent poll requests.



LongRunning
setPollDelayMultiplier(Float pollDelayMultiplier)
Multiplier to gradually increase delay between subsequent polls until it reaches
 max_poll_delay.



LongRunning
setTotalPollTimeout(String totalPollTimeout)
Total polling timeout.







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





LongRunning
public LongRunning()









Method Detail





getInitialPollDelay
public String getInitialPollDelay()
Initial delay after which the first poll request will be made. Default value: 5 seconds.

Returns:
value or null for none








setInitialPollDelay
public LongRunning setInitialPollDelay(String initialPollDelay)
Initial delay after which the first poll request will be made. Default value: 5 seconds.

Parameters:
initialPollDelay - initialPollDelay or null for none








getMaxPollDelay
public String getMaxPollDelay()
Maximum time between two subsequent poll requests. Default value: 45 seconds.

Returns:
value or null for none








setMaxPollDelay
public LongRunning setMaxPollDelay(String maxPollDelay)
Maximum time between two subsequent poll requests. Default value: 45 seconds.

Parameters:
maxPollDelay - maxPollDelay or null for none








getPollDelayMultiplier
public Float getPollDelayMultiplier()
Multiplier to gradually increase delay between subsequent polls until it reaches
 max_poll_delay. Default value: 1.5.

Returns:
value or null for none








setPollDelayMultiplier
public LongRunning setPollDelayMultiplier(Float pollDelayMultiplier)
Multiplier to gradually increase delay between subsequent polls until it reaches
 max_poll_delay. Default value: 1.5.

Parameters:
pollDelayMultiplier - pollDelayMultiplier or null for none








getTotalPollTimeout
public String getTotalPollTimeout()
Total polling timeout. Default value: 5 minutes.

Returns:
value or null for none








setTotalPollTimeout
public LongRunning setTotalPollTimeout(String totalPollTimeout)
Total polling timeout. Default value: 5 minutes.

Parameters:
totalPollTimeout - totalPollTimeout or null for none








set
public LongRunning set(String fieldName,
                       Object value)

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








clone
public LongRunning 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
`LongRunning`	`clone()`
`String`	`getInitialPollDelay()` Initial delay after which the first poll request will be made.
`String`	`getMaxPollDelay()` Maximum time between two subsequent poll requests.
`Float`	`getPollDelayMultiplier()` Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.
`String`	`getTotalPollTimeout()` Total polling timeout.
`LongRunning`	`set(String fieldName, Object value)`
`LongRunning`	`setInitialPollDelay(String initialPollDelay)` Initial delay after which the first poll request will be made.
`LongRunning`	`setMaxPollDelay(String maxPollDelay)` Maximum time between two subsequent poll requests.
`LongRunning`	`setPollDelayMultiplier(Float pollDelayMultiplier)` Multiplier to gradually increase delay between subsequent polls until it reaches max_poll_delay.
`LongRunning`	`setTotalPollTimeout(String totalPollTimeout)` Total polling timeout.