Class EdgeContainerStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<EdgeContainerStubSettings>
com.google.cloud.edgecontainer.v1.stub.EdgeContainerStubSettings
@Generated("by gapic-generator-java")
public class EdgeContainerStubSettings
extends StubSettings<EdgeContainerStubSettings>
Settings class to configure an instance of
EdgeContainerStub.
The default instance has everything set to sensible defaults:
- The default service address (edgecontainer.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 getCluster:
// 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
EdgeContainerStubSettings.Builder edgeContainerSettingsBuilder =
EdgeContainerStubSettings.newBuilder();
edgeContainerSettingsBuilder
.getClusterSettings()
.setRetrySettings(
edgeContainerSettingsBuilder
.getClusterSettings()
.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());
EdgeContainerStubSettings edgeContainerSettings = edgeContainerSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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 createCluster:
// 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
EdgeContainerStubSettings.Builder edgeContainerSettingsBuilder =
EdgeContainerStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
edgeContainerSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for EdgeContainerStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedEdgeContainerStubSettings(EdgeContainerStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createCluster.Returns the object with the settings used for calls to createCluster.Returns the object with the settings used for calls to createNodePool.Returns the object with the settings used for calls to createNodePool.Returns the object with the settings used for calls to createVpnConnection.Returns the object with the settings used for calls to createVpnConnection.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteClusterRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteCluster.Returns the object with the settings used for calls to deleteCluster.OperationCallSettings<DeleteNodePoolRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteNodePool.Returns the object with the settings used for calls to deleteNodePool.OperationCallSettings<DeleteVpnConnectionRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteVpnConnection.Returns the object with the settings used for calls to deleteVpnConnection.Returns the object with the settings used for calls to generateAccessToken.Returns the object with the settings used for calls to generateOfflineCredential.Returns the object with the settings used for calls to getCluster.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getMachine.Returns the object with the settings used for calls to getNodePool.Returns the object with the settings used for calls to getServerConfig.Returns the default service name.Returns the object with the settings used for calls to getVpnConnection.PagedCallSettings<ListClustersRequest,ListClustersResponse, EdgeContainerClient.ListClustersPagedResponse> Returns the object with the settings used for calls to listClusters.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, EdgeContainerClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListMachinesRequest,ListMachinesResponse, EdgeContainerClient.ListMachinesPagedResponse> Returns the object with the settings used for calls to listMachines.PagedCallSettings<ListNodePoolsRequest,ListNodePoolsResponse, EdgeContainerClient.ListNodePoolsPagedResponse> Returns the object with the settings used for calls to listNodePools.PagedCallSettings<ListVpnConnectionsRequest,ListVpnConnectionsResponse, EdgeContainerClient.ListVpnConnectionsPagedResponse> Returns the object with the settings used for calls to listVpnConnections.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateCluster.Returns the object with the settings used for calls to updateCluster.Returns the object with the settings used for calls to updateNodePool.Returns the object with the settings used for calls to updateNodePool.Returns the object with the settings used for calls to upgradeCluster.Returns the object with the settings used for calls to upgradeCluster.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
-
Constructor Details
-
EdgeContainerStubSettings
protected EdgeContainerStubSettings(EdgeContainerStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listClustersSettings
public PagedCallSettings<ListClustersRequest,ListClustersResponse, listClustersSettings()EdgeContainerClient.ListClustersPagedResponse> Returns the object with the settings used for calls to listClusters. -
getClusterSettings
Returns the object with the settings used for calls to getCluster. -
createClusterSettings
Returns the object with the settings used for calls to createCluster. -
createClusterOperationSettings
public OperationCallSettings<CreateClusterRequest,Cluster, createClusterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createCluster. -
updateClusterSettings
Returns the object with the settings used for calls to updateCluster. -
updateClusterOperationSettings
public OperationCallSettings<UpdateClusterRequest,Cluster, updateClusterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateCluster. -
upgradeClusterSettings
Returns the object with the settings used for calls to upgradeCluster. -
upgradeClusterOperationSettings
public OperationCallSettings<UpgradeClusterRequest,Cluster, upgradeClusterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to upgradeCluster. -
deleteClusterSettings
Returns the object with the settings used for calls to deleteCluster. -
deleteClusterOperationSettings
public OperationCallSettings<DeleteClusterRequest,com.google.protobuf.Empty, deleteClusterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteCluster. -
generateAccessTokenSettings
public UnaryCallSettings<GenerateAccessTokenRequest,GenerateAccessTokenResponse> generateAccessTokenSettings()Returns the object with the settings used for calls to generateAccessToken. -
generateOfflineCredentialSettings
public UnaryCallSettings<GenerateOfflineCredentialRequest,GenerateOfflineCredentialResponse> generateOfflineCredentialSettings()Returns the object with the settings used for calls to generateOfflineCredential. -
listNodePoolsSettings
public PagedCallSettings<ListNodePoolsRequest,ListNodePoolsResponse, listNodePoolsSettings()EdgeContainerClient.ListNodePoolsPagedResponse> Returns the object with the settings used for calls to listNodePools. -
getNodePoolSettings
Returns the object with the settings used for calls to getNodePool. -
createNodePoolSettings
Returns the object with the settings used for calls to createNodePool. -
createNodePoolOperationSettings
public OperationCallSettings<CreateNodePoolRequest,NodePool, createNodePoolOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createNodePool. -
updateNodePoolSettings
Returns the object with the settings used for calls to updateNodePool. -
updateNodePoolOperationSettings
public OperationCallSettings<UpdateNodePoolRequest,NodePool, updateNodePoolOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateNodePool. -
deleteNodePoolSettings
Returns the object with the settings used for calls to deleteNodePool. -
deleteNodePoolOperationSettings
public OperationCallSettings<DeleteNodePoolRequest,com.google.protobuf.Empty, deleteNodePoolOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteNodePool. -
listMachinesSettings
public PagedCallSettings<ListMachinesRequest,ListMachinesResponse, listMachinesSettings()EdgeContainerClient.ListMachinesPagedResponse> Returns the object with the settings used for calls to listMachines. -
getMachineSettings
Returns the object with the settings used for calls to getMachine. -
listVpnConnectionsSettings
public PagedCallSettings<ListVpnConnectionsRequest,ListVpnConnectionsResponse, listVpnConnectionsSettings()EdgeContainerClient.ListVpnConnectionsPagedResponse> Returns the object with the settings used for calls to listVpnConnections. -
getVpnConnectionSettings
Returns the object with the settings used for calls to getVpnConnection. -
createVpnConnectionSettings
Returns the object with the settings used for calls to createVpnConnection. -
createVpnConnectionOperationSettings
public OperationCallSettings<CreateVpnConnectionRequest,VpnConnection, createVpnConnectionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createVpnConnection. -
deleteVpnConnectionSettings
Returns the object with the settings used for calls to deleteVpnConnection. -
deleteVpnConnectionOperationSettings
public OperationCallSettings<DeleteVpnConnectionRequest,com.google.protobuf.Empty, deleteVpnConnectionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteVpnConnection. -
getServerConfigSettings
Returns the object with the settings used for calls to getServerConfig. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()EdgeContainerClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<EdgeContainerStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<EdgeContainerStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<EdgeContainerStubSettings>
-