Class ClusterControllerSettings (2.3.1)

public class ClusterControllerSettings extends ClientSettings<ClusterControllerSettings>

Settings class to configure an instance of ClusterControllerClient.

The default instance has everything set to sensible defaults:

  • The default service address (dataproc.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 total timeout of getCluster to 30 seconds:


 ClusterControllerSettings.Builder clusterControllerSettingsBuilder =
     ClusterControllerSettings.newBuilder();
 clusterControllerSettingsBuilder
     .getClusterSettings()
     .setRetrySettings(
         clusterControllerSettingsBuilder
             .getClusterSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ClusterControllerSettings clusterControllerSettings = clusterControllerSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > ClusterControllerSettings

Constructors

ClusterControllerSettings(ClusterControllerSettings.Builder settingsBuilder)

protected ClusterControllerSettings(ClusterControllerSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderClusterControllerSettings.Builder

Methods

create(ClusterControllerStubSettings stub)

public static final ClusterControllerSettings create(ClusterControllerStubSettings stub)
Parameter
NameDescription
stubClusterControllerStubSettings
Returns
TypeDescription
ClusterControllerSettings
Exceptions
TypeDescription
IOException

createClusterOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateClusterRequest,Cluster,ClusterOperationMetadata>

createClusterSettings()

public UnaryCallSettings<CreateClusterRequest,Operation> createClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateClusterRequest,Operation>

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

deleteClusterOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteClusterRequest,Empty,ClusterOperationMetadata>

deleteClusterSettings()

public UnaryCallSettings<DeleteClusterRequest,Operation> deleteClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteClusterRequest,Operation>

diagnoseClusterOperationSettings()

public OperationCallSettings<DiagnoseClusterRequest,DiagnoseClusterResults,ClusterOperationMetadata> diagnoseClusterOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DiagnoseClusterRequest,DiagnoseClusterResults,ClusterOperationMetadata>

diagnoseClusterSettings()

public UnaryCallSettings<DiagnoseClusterRequest,Operation> diagnoseClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<DiagnoseClusterRequest,Operation>

getClusterSettings()

public UnaryCallSettings<GetClusterRequest,Cluster> getClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetClusterRequest,Cluster>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

listClustersSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListClustersRequest,ListClustersResponse,ListClustersPagedResponse>

newBuilder()

public static ClusterControllerSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
ClusterControllerSettings.Builder

newBuilder(ClientContext clientContext)

public static ClusterControllerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
ClusterControllerSettings.Builder

startClusterOperationSettings()

public OperationCallSettings<StartClusterRequest,Cluster,ClusterOperationMetadata> startClusterOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<StartClusterRequest,Cluster,ClusterOperationMetadata>

startClusterSettings()

public UnaryCallSettings<StartClusterRequest,Operation> startClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<StartClusterRequest,Operation>

stopClusterOperationSettings()

public OperationCallSettings<StopClusterRequest,Cluster,ClusterOperationMetadata> stopClusterOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<StopClusterRequest,Cluster,ClusterOperationMetadata>

stopClusterSettings()

public UnaryCallSettings<StopClusterRequest,Operation> stopClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<StopClusterRequest,Operation>

toBuilder()

public ClusterControllerSettings.Builder toBuilder()

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

Returns
TypeDescription
ClusterControllerSettings.Builder
Overrides

updateClusterOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateClusterRequest,Cluster,ClusterOperationMetadata>

updateClusterSettings()

public UnaryCallSettings<UpdateClusterRequest,Operation> updateClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateClusterRequest,Operation>