Class EdgeContainerStubSettings (0.52.0) 

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 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 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();

Inheritance

java.lang.Object > StubSettings > EdgeContainerStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static EdgeContainerStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
EdgeContainerStubSettings.Builder

newBuilder(ClientContext clientContext)

public static EdgeContainerStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
EdgeContainerStubSettings.Builder

newHttpJsonBuilder()

public static EdgeContainerStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
EdgeContainerStubSettings.Builder

Constructors

EdgeContainerStubSettings(EdgeContainerStubSettings.Builder settingsBuilder)

protected EdgeContainerStubSettings(EdgeContainerStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder EdgeContainerStubSettings.Builder

Methods

createClusterOperationSettings()

public OperationCallSettings<CreateClusterRequest,Cluster,OperationMetadata> createClusterOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateClusterRequest,Cluster,OperationMetadata>

createClusterSettings()

public UnaryCallSettings<CreateClusterRequest,Operation> createClusterSettings()

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

Returns
Type Description
UnaryCallSettings<CreateClusterRequest,Operation>

createNodePoolOperationSettings()

public OperationCallSettings<CreateNodePoolRequest,NodePool,OperationMetadata> createNodePoolOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateNodePoolRequest,NodePool,OperationMetadata>

createNodePoolSettings()

public UnaryCallSettings<CreateNodePoolRequest,Operation> createNodePoolSettings()

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

Returns
Type Description
UnaryCallSettings<CreateNodePoolRequest,Operation>

createStub()

public EdgeContainerStub createStub()
Returns
Type Description
EdgeContainerStub
Exceptions
Type Description
IOException

createVpnConnectionOperationSettings()

public OperationCallSettings<CreateVpnConnectionRequest,VpnConnection,OperationMetadata> createVpnConnectionOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateVpnConnectionRequest,VpnConnection,OperationMetadata>

createVpnConnectionSettings()

public UnaryCallSettings<CreateVpnConnectionRequest,Operation> createVpnConnectionSettings()

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

Returns
Type Description
UnaryCallSettings<CreateVpnConnectionRequest,Operation>

deleteClusterOperationSettings()

public OperationCallSettings<DeleteClusterRequest,Empty,OperationMetadata> deleteClusterOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteClusterRequest,Empty,OperationMetadata>

deleteClusterSettings()

public UnaryCallSettings<DeleteClusterRequest,Operation> deleteClusterSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteClusterRequest,Operation>

deleteNodePoolOperationSettings()

public OperationCallSettings<DeleteNodePoolRequest,Empty,OperationMetadata> deleteNodePoolOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteNodePoolRequest,Empty,OperationMetadata>

deleteNodePoolSettings()

public UnaryCallSettings<DeleteNodePoolRequest,Operation> deleteNodePoolSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteNodePoolRequest,Operation>

deleteVpnConnectionOperationSettings()

public OperationCallSettings<DeleteVpnConnectionRequest,Empty,OperationMetadata> deleteVpnConnectionOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteVpnConnectionRequest,Empty,OperationMetadata>

deleteVpnConnectionSettings()

public UnaryCallSettings<DeleteVpnConnectionRequest,Operation> deleteVpnConnectionSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteVpnConnectionRequest,Operation>

generateAccessTokenSettings()

public UnaryCallSettings<GenerateAccessTokenRequest,GenerateAccessTokenResponse> generateAccessTokenSettings()

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

Returns
Type Description
UnaryCallSettings<GenerateAccessTokenRequest,GenerateAccessTokenResponse>

generateOfflineCredentialSettings()

public UnaryCallSettings<GenerateOfflineCredentialRequest,GenerateOfflineCredentialResponse> generateOfflineCredentialSettings()

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

Returns
Type Description
UnaryCallSettings<GenerateOfflineCredentialRequest,GenerateOfflineCredentialResponse>

getClusterSettings()

public UnaryCallSettings<GetClusterRequest,Cluster> getClusterSettings()

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

Returns
Type Description
UnaryCallSettings<GetClusterRequest,Cluster>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getMachineSettings()

public UnaryCallSettings<GetMachineRequest,Machine> getMachineSettings()

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

Returns
Type Description
UnaryCallSettings<GetMachineRequest,Machine>

getNodePoolSettings()

public UnaryCallSettings<GetNodePoolRequest,NodePool> getNodePoolSettings()

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

Returns
Type Description
UnaryCallSettings<GetNodePoolRequest,NodePool>

getServerConfigSettings()

public UnaryCallSettings<GetServerConfigRequest,ServerConfig> getServerConfigSettings()

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

Returns
Type Description
UnaryCallSettings<GetServerConfigRequest,ServerConfig>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

getVpnConnectionSettings()

public UnaryCallSettings<GetVpnConnectionRequest,VpnConnection> getVpnConnectionSettings()

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

Returns
Type Description
UnaryCallSettings<GetVpnConnectionRequest,VpnConnection>

listClustersSettings()

public PagedCallSettings<ListClustersRequest,ListClustersResponse,EdgeContainerClient.ListClustersPagedResponse> listClustersSettings()

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

Returns
Type Description
PagedCallSettings<ListClustersRequest,ListClustersResponse,ListClustersPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,EdgeContainerClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listMachinesSettings()

public PagedCallSettings<ListMachinesRequest,ListMachinesResponse,EdgeContainerClient.ListMachinesPagedResponse> listMachinesSettings()

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

Returns
Type Description
PagedCallSettings<ListMachinesRequest,ListMachinesResponse,ListMachinesPagedResponse>

listNodePoolsSettings()

public PagedCallSettings<ListNodePoolsRequest,ListNodePoolsResponse,EdgeContainerClient.ListNodePoolsPagedResponse> listNodePoolsSettings()

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

Returns
Type Description
PagedCallSettings<ListNodePoolsRequest,ListNodePoolsResponse,ListNodePoolsPagedResponse>

listVpnConnectionsSettings()

public PagedCallSettings<ListVpnConnectionsRequest,ListVpnConnectionsResponse,EdgeContainerClient.ListVpnConnectionsPagedResponse> listVpnConnectionsSettings()

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

Returns
Type Description
PagedCallSettings<ListVpnConnectionsRequest,ListVpnConnectionsResponse,ListVpnConnectionsPagedResponse>

toBuilder()

public EdgeContainerStubSettings.Builder toBuilder()

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

Returns
Type Description
EdgeContainerStubSettings.Builder
Overrides

updateClusterOperationSettings()

public OperationCallSettings<UpdateClusterRequest,Cluster,OperationMetadata> updateClusterOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateClusterRequest,Cluster,OperationMetadata>

updateClusterSettings()

public UnaryCallSettings<UpdateClusterRequest,Operation> updateClusterSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateClusterRequest,Operation>

updateNodePoolOperationSettings()

public OperationCallSettings<UpdateNodePoolRequest,NodePool,OperationMetadata> updateNodePoolOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateNodePoolRequest,NodePool,OperationMetadata>

updateNodePoolSettings()

public UnaryCallSettings<UpdateNodePoolRequest,Operation> updateNodePoolSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateNodePoolRequest,Operation>

upgradeClusterOperationSettings()

public OperationCallSettings<UpgradeClusterRequest,Cluster,OperationMetadata> upgradeClusterOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpgradeClusterRequest,Cluster,OperationMetadata>

upgradeClusterSettings()

public UnaryCallSettings<UpgradeClusterRequest,Operation> upgradeClusterSettings()

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

Returns
Type Description
UnaryCallSettings<UpgradeClusterRequest,Operation>