com.google.cloud.compute.v1

Class UrlMapSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<UrlMapSettings>

com.google.cloud.compute.v1.UrlMapSettings

@Generated(value="by gapic-generator")
 @BetaApi
public class UrlMapSettings
extends ClientSettings<UrlMapSettings>

Settings class to configure an instance of UrlMapClient.

The default instance has everything set to sensible defaults:

• The default service address (https://www.googleapis.com/compute/v1/projects/) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object. For example, to set the total timeout of deleteUrlMap to 30 seconds:

 
 UrlMapSettings.Builder urlMapSettingsBuilder =
     UrlMapSettings.newBuilder();
 urlMapSettingsBuilder.deleteUrlMapSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 UrlMapSettings urlMapSettings = urlMapSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UrlMapSettings.Builder Builder for UrlMapSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UrlMapSettings(UrlMapSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static UrlMapSettings	create(UrlMapStubSettings stub)
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<DeleteUrlMapHttpRequest,Operation>	deleteUrlMapSettings() Returns the object with the settings used for calls to deleteUrlMap.
static String	getDefaultEndpoint() Returns the default service endpoint.
static int	getDefaultServicePort() Returns the default service port.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<GetUrlMapHttpRequest,UrlMap>	getUrlMapSettings() Returns the object with the settings used for calls to getUrlMap.
UnaryCallSettings<InsertUrlMapHttpRequest,Operation>	insertUrlMapSettings() Returns the object with the settings used for calls to insertUrlMap.
UnaryCallSettings<InvalidateCacheUrlMapHttpRequest,Operation>	invalidateCacheUrlMapSettings() Returns the object with the settings used for calls to invalidateCacheUrlMap.
PagedCallSettings<ListUrlMapsHttpRequest,UrlMapList,UrlMapClient.ListUrlMapsPagedResponse>	listUrlMapsSettings() Returns the object with the settings used for calls to listUrlMaps.
static UrlMapSettings.Builder	newBuilder() Returns a new builder for this class.
static UrlMapSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
UnaryCallSettings<PatchUrlMapHttpRequest,Operation>	patchUrlMapSettings() Returns the object with the settings used for calls to patchUrlMap.
UrlMapSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<UpdateUrlMapHttpRequest,Operation>	updateUrlMapSettings() Returns the object with the settings used for calls to updateUrlMap.
UnaryCallSettings<ValidateUrlMapHttpRequest,UrlMapsValidateResponse>	validateUrlMapSettings() Returns the object with the settings used for calls to validateUrlMap.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UrlMapSettings

protected UrlMapSettings(UrlMapSettings.Builder settingsBuilder)
                  throws IOException

Throws:

IOException

Method Detail

deleteUrlMapSettings

public UnaryCallSettings<DeleteUrlMapHttpRequest,Operation> deleteUrlMapSettings()

Returns the object with the settings used for calls to deleteUrlMap.

getUrlMapSettings

public UnaryCallSettings<GetUrlMapHttpRequest,UrlMap> getUrlMapSettings()

Returns the object with the settings used for calls to getUrlMap.

insertUrlMapSettings

public UnaryCallSettings<InsertUrlMapHttpRequest,Operation> insertUrlMapSettings()

Returns the object with the settings used for calls to insertUrlMap.

invalidateCacheUrlMapSettings

public UnaryCallSettings<InvalidateCacheUrlMapHttpRequest,Operation> invalidateCacheUrlMapSettings()

Returns the object with the settings used for calls to invalidateCacheUrlMap.

listUrlMapsSettings

public PagedCallSettings<ListUrlMapsHttpRequest,UrlMapList,UrlMapClient.ListUrlMapsPagedResponse> listUrlMapsSettings()

Returns the object with the settings used for calls to listUrlMaps.

patchUrlMapSettings

public UnaryCallSettings<PatchUrlMapHttpRequest,Operation> patchUrlMapSettings()

Returns the object with the settings used for calls to patchUrlMap.

updateUrlMapSettings

public UnaryCallSettings<UpdateUrlMapHttpRequest,Operation> updateUrlMapSettings()

Returns the object with the settings used for calls to updateUrlMap.

validateUrlMapSettings

public UnaryCallSettings<ValidateUrlMapHttpRequest,UrlMapsValidateResponse> validateUrlMapSettings()

Returns the object with the settings used for calls to validateUrlMap.

create

public static final UrlMapSettings create(UrlMapStubSettings stub)
                                   throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServicePort

public static int getDefaultServicePort()

Returns the default service port.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultHttpJsonTransportProviderBuilder

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static UrlMapSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static UrlMapSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public UrlMapSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class ClientSettings<UrlMapSettings>