com.google.cloud.compute.v1.stub

Class UrlMapStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<UrlMapStubSettings>

com.google.cloud.compute.v1.stub.UrlMapStubSettings

@Generated(value="by gapic-generator")
 @BetaApi
public class UrlMapStubSettings
extends com.google.api.gax.rpc.StubSettings<UrlMapStubSettings>

Settings class to configure an instance of UrlMapStub.

The default instance has everything set to sensible defaults:

• The default service address (https://compute.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:

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.PagedCallSettings<AggregatedListUrlMapsHttpRequest,UrlMapsAggregatedList,UrlMapClient.AggregatedListUrlMapsPagedResponse>	aggregatedListUrlMapsSettings() Returns the object with the settings used for calls to aggregatedListUrlMaps.
UrlMapStub	createStub()
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.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.
com.google.api.gax.rpc.UnaryCallSettings<GetUrlMapHttpRequest,UrlMap>	getUrlMapSettings() Returns the object with the settings used for calls to getUrlMap.
com.google.api.gax.rpc.UnaryCallSettings<InsertUrlMapHttpRequest,Operation>	insertUrlMapSettings() Returns the object with the settings used for calls to insertUrlMap.
com.google.api.gax.rpc.UnaryCallSettings<InvalidateCacheUrlMapHttpRequest,Operation>	invalidateCacheUrlMapSettings() Returns the object with the settings used for calls to invalidateCacheUrlMap.
com.google.api.gax.rpc.PagedCallSettings<ListUrlMapsHttpRequest,UrlMapList,UrlMapClient.ListUrlMapsPagedResponse>	listUrlMapsSettings() Returns the object with the settings used for calls to listUrlMaps.
static UrlMapStubSettings.Builder	newBuilder() Returns a new builder for this class.
static UrlMapStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<PatchUrlMapHttpRequest,Operation>	patchUrlMapSettings() Returns the object with the settings used for calls to patchUrlMap.
UrlMapStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateUrlMapHttpRequest,Operation>	updateUrlMapSettings() Returns the object with the settings used for calls to updateUrlMap.
com.google.api.gax.rpc.UnaryCallSettings<ValidateUrlMapHttpRequest,UrlMapsValidateResponse>	validateUrlMapSettings() Returns the object with the settings used for calls to validateUrlMap.

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

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlMapStubSettings

protected UrlMapStubSettings(UrlMapStubSettings.Builder settingsBuilder)
                      throws IOException

Throws:

IOException

Method Detail

aggregatedListUrlMapsSettings

public com.google.api.gax.rpc.PagedCallSettings<AggregatedListUrlMapsHttpRequest,UrlMapsAggregatedList,UrlMapClient.AggregatedListUrlMapsPagedResponse> aggregatedListUrlMapsSettings()

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

deleteUrlMapSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteUrlMapHttpRequest,Operation> deleteUrlMapSettings()

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

getUrlMapSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetUrlMapHttpRequest,UrlMap> getUrlMapSettings()

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

insertUrlMapSettings

public com.google.api.gax.rpc.UnaryCallSettings<InsertUrlMapHttpRequest,Operation> insertUrlMapSettings()

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

invalidateCacheUrlMapSettings

public com.google.api.gax.rpc.UnaryCallSettings<InvalidateCacheUrlMapHttpRequest,Operation> invalidateCacheUrlMapSettings()

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

listUrlMapsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListUrlMapsHttpRequest,UrlMapList,UrlMapClient.ListUrlMapsPagedResponse> listUrlMapsSettings()

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

patchUrlMapSettings

public com.google.api.gax.rpc.UnaryCallSettings<PatchUrlMapHttpRequest,Operation> patchUrlMapSettings()

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

updateUrlMapSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateUrlMapHttpRequest,Operation> updateUrlMapSettings()

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

validateUrlMapSettings

public com.google.api.gax.rpc.UnaryCallSettings<ValidateUrlMapHttpRequest,UrlMapsValidateResponse> validateUrlMapSettings()

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

createStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public UrlMapStub createStub()
                                                                                                                    throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.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 com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultHttpJsonTransportProviderBuilder

public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

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

newBuilder

public static UrlMapStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static UrlMapStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public UrlMapStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<UrlMapStubSettings>