com.google.cloud.compute.v1.stub

Class RegionTargetHttpsProxiesStubSettings

java.lang.Object

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

com.google.cloud.compute.v1.stub.RegionTargetHttpsProxiesStubSettings

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

Settings class to configure an instance of RegionTargetHttpsProxiesStub.

The default instance has everything set to sensible defaults:

• The default service address (compute.googleapis.com) 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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of get:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 RegionTargetHttpsProxiesStubSettings.Builder regionTargetHttpsProxiesSettingsBuilder =
     RegionTargetHttpsProxiesStubSettings.newBuilder();
 regionTargetHttpsProxiesSettingsBuilder
     .getSettings()
     .setRetrySettings(
         regionTargetHttpsProxiesSettingsBuilder
             .getSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 RegionTargetHttpsProxiesStubSettings regionTargetHttpsProxiesSettings =
     regionTargetHttpsProxiesSettingsBuilder.build();
 

Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for delete:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 RegionTargetHttpsProxiesStubSettings.Builder regionTargetHttpsProxiesSettingsBuilder =
     RegionTargetHttpsProxiesStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 regionTargetHttpsProxiesSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
RegionTargetHttpsProxiesStub	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.OperationCallSettings<DeleteRegionTargetHttpsProxyRequest,Operation,Operation>	deleteOperationSettings() Returns the object with the settings used for calls to delete.
com.google.api.gax.rpc.UnaryCallSettings<DeleteRegionTargetHttpsProxyRequest,Operation>	deleteSettings() Returns the object with the settings used for calls to delete.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
String	getServiceName() Returns the default service name.
com.google.api.gax.rpc.UnaryCallSettings<GetRegionTargetHttpsProxyRequest,TargetHttpsProxy>	getSettings() Returns the object with the settings used for calls to get.
com.google.api.gax.rpc.OperationCallSettings<InsertRegionTargetHttpsProxyRequest,Operation,Operation>	insertOperationSettings() Returns the object with the settings used for calls to insert.
com.google.api.gax.rpc.UnaryCallSettings<InsertRegionTargetHttpsProxyRequest,Operation>	insertSettings() Returns the object with the settings used for calls to insert.
com.google.api.gax.rpc.PagedCallSettings<ListRegionTargetHttpsProxiesRequest,TargetHttpsProxyList,RegionTargetHttpsProxiesClient.ListPagedResponse>	listSettings() Returns the object with the settings used for calls to list.
static RegionTargetHttpsProxiesStubSettings.Builder	newBuilder() Returns a new builder for this class.
static RegionTargetHttpsProxiesStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.OperationCallSettings<PatchRegionTargetHttpsProxyRequest,Operation,Operation>	patchOperationSettings() Returns the object with the settings used for calls to patch.
com.google.api.gax.rpc.UnaryCallSettings<PatchRegionTargetHttpsProxyRequest,Operation>	patchSettings() Returns the object with the settings used for calls to patch.
com.google.api.gax.rpc.OperationCallSettings<SetSslCertificatesRegionTargetHttpsProxyRequest,Operation,Operation>	setSslCertificatesOperationSettings() Returns the object with the settings used for calls to setSslCertificates.
com.google.api.gax.rpc.UnaryCallSettings<SetSslCertificatesRegionTargetHttpsProxyRequest,Operation>	setSslCertificatesSettings() Returns the object with the settings used for calls to setSslCertificates.
com.google.api.gax.rpc.OperationCallSettings<SetUrlMapRegionTargetHttpsProxyRequest,Operation,Operation>	setUrlMapOperationSettings() Returns the object with the settings used for calls to setUrlMap.
com.google.api.gax.rpc.UnaryCallSettings<SetUrlMapRegionTargetHttpsProxyRequest,Operation>	setUrlMapSettings() Returns the object with the settings used for calls to setUrlMap.
RegionTargetHttpsProxiesStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

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

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionTargetHttpsProxiesStubSettings

protected RegionTargetHttpsProxiesStubSettings(RegionTargetHttpsProxiesStubSettings.Builder settingsBuilder)
                                        throws IOException

Throws:

IOException

Method Detail

deleteSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteRegionTargetHttpsProxyRequest,Operation> deleteSettings()

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

deleteOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteRegionTargetHttpsProxyRequest,Operation,Operation> deleteOperationSettings()

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

getSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetRegionTargetHttpsProxyRequest,TargetHttpsProxy> getSettings()

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

insertSettings

public com.google.api.gax.rpc.UnaryCallSettings<InsertRegionTargetHttpsProxyRequest,Operation> insertSettings()

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

insertOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<InsertRegionTargetHttpsProxyRequest,Operation,Operation> insertOperationSettings()

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

listSettings

public com.google.api.gax.rpc.PagedCallSettings<ListRegionTargetHttpsProxiesRequest,TargetHttpsProxyList,RegionTargetHttpsProxiesClient.ListPagedResponse> listSettings()

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

patchSettings

public com.google.api.gax.rpc.UnaryCallSettings<PatchRegionTargetHttpsProxyRequest,Operation> patchSettings()

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

patchOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<PatchRegionTargetHttpsProxyRequest,Operation,Operation> patchOperationSettings()

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

setSslCertificatesSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetSslCertificatesRegionTargetHttpsProxyRequest,Operation> setSslCertificatesSettings()

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

setSslCertificatesOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<SetSslCertificatesRegionTargetHttpsProxyRequest,Operation,Operation> setSslCertificatesOperationSettings()

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

setUrlMapSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetUrlMapRegionTargetHttpsProxyRequest,Operation> setUrlMapSettings()

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

setUrlMapOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<SetUrlMapRegionTargetHttpsProxyRequest,Operation,Operation> setUrlMapOperationSettings()

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

createStub

public RegionTargetHttpsProxiesStub createStub()
                                        throws IOException

Throws:

IOException

getServiceName

public String getServiceName()

Returns the default service name.

Overrides:

getServiceName in class com.google.api.gax.rpc.StubSettings<RegionTargetHttpsProxiesStubSettings>

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

@ObsoleteApi(value="Use getEndpoint() instead")
public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

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

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static RegionTargetHttpsProxiesStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public RegionTargetHttpsProxiesStubSettings.Builder toBuilder()

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

Specified by:

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