Class AzureClustersSettings (0.4.0)

public class AzureClustersSettings extends ClientSettings<AzureClustersSettings>

Settings class to configure an instance of AzureClustersClient.

The default instance has everything set to sensible defaults:

  • The default service address (gkemulticloud.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 getAzureClient to 30 seconds:


 // 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
 AzureClustersSettings.Builder azureClustersSettingsBuilder = AzureClustersSettings.newBuilder();
 azureClustersSettingsBuilder
     .getAzureClientSettings()
     .setRetrySettings(
         azureClustersSettingsBuilder.getAzureClientSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AzureClustersSettings azureClustersSettings = azureClustersSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > AzureClustersSettings

Static Methods

create(AzureClustersStubSettings stub)

public static final AzureClustersSettings create(AzureClustersStubSettings stub)
Parameter
NameDescription
stubAzureClustersStubSettings
Returns
TypeDescription
AzureClustersSettings
Exceptions
TypeDescription
IOException

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 gRPC ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

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>

newBuilder()

public static AzureClustersSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
AzureClustersSettings.Builder

newBuilder(ClientContext clientContext)

public static AzureClustersSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
AzureClustersSettings.Builder

newHttpJsonBuilder()

public static AzureClustersSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
AzureClustersSettings.Builder

Constructors

AzureClustersSettings(AzureClustersSettings.Builder settingsBuilder)

protected AzureClustersSettings(AzureClustersSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderAzureClustersSettings.Builder

Methods

createAzureClientOperationSettings()

public OperationCallSettings<CreateAzureClientRequest,AzureClient,OperationMetadata> createAzureClientOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateAzureClientRequest,AzureClient,OperationMetadata>

createAzureClientSettings()

public UnaryCallSettings<CreateAzureClientRequest,Operation> createAzureClientSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateAzureClientRequest,Operation>

createAzureClusterOperationSettings()

public OperationCallSettings<CreateAzureClusterRequest,AzureCluster,OperationMetadata> createAzureClusterOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateAzureClusterRequest,AzureCluster,OperationMetadata>

createAzureClusterSettings()

public UnaryCallSettings<CreateAzureClusterRequest,Operation> createAzureClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateAzureClusterRequest,Operation>

createAzureNodePoolOperationSettings()

public OperationCallSettings<CreateAzureNodePoolRequest,AzureNodePool,OperationMetadata> createAzureNodePoolOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateAzureNodePoolRequest,AzureNodePool,OperationMetadata>

createAzureNodePoolSettings()

public UnaryCallSettings<CreateAzureNodePoolRequest,Operation> createAzureNodePoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateAzureNodePoolRequest,Operation>

deleteAzureClientOperationSettings()

public OperationCallSettings<DeleteAzureClientRequest,Empty,OperationMetadata> deleteAzureClientOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteAzureClientRequest,Empty,OperationMetadata>

deleteAzureClientSettings()

public UnaryCallSettings<DeleteAzureClientRequest,Operation> deleteAzureClientSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteAzureClientRequest,Operation>

deleteAzureClusterOperationSettings()

public OperationCallSettings<DeleteAzureClusterRequest,Empty,OperationMetadata> deleteAzureClusterOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteAzureClusterRequest,Empty,OperationMetadata>

deleteAzureClusterSettings()

public UnaryCallSettings<DeleteAzureClusterRequest,Operation> deleteAzureClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteAzureClusterRequest,Operation>

deleteAzureNodePoolOperationSettings()

public OperationCallSettings<DeleteAzureNodePoolRequest,Empty,OperationMetadata> deleteAzureNodePoolOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteAzureNodePoolRequest,Empty,OperationMetadata>

deleteAzureNodePoolSettings()

public UnaryCallSettings<DeleteAzureNodePoolRequest,Operation> deleteAzureNodePoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteAzureNodePoolRequest,Operation>

generateAzureAccessTokenSettings()

public UnaryCallSettings<GenerateAzureAccessTokenRequest,GenerateAzureAccessTokenResponse> generateAzureAccessTokenSettings()

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

Returns
TypeDescription
UnaryCallSettings<GenerateAzureAccessTokenRequest,GenerateAzureAccessTokenResponse>

getAzureClientSettings()

public UnaryCallSettings<GetAzureClientRequest,AzureClient> getAzureClientSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetAzureClientRequest,AzureClient>

getAzureClusterSettings()

public UnaryCallSettings<GetAzureClusterRequest,AzureCluster> getAzureClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetAzureClusterRequest,AzureCluster>

getAzureNodePoolSettings()

public UnaryCallSettings<GetAzureNodePoolRequest,AzureNodePool> getAzureNodePoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetAzureNodePoolRequest,AzureNodePool>

getAzureServerConfigSettings()

public UnaryCallSettings<GetAzureServerConfigRequest,AzureServerConfig> getAzureServerConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetAzureServerConfigRequest,AzureServerConfig>

listAzureClientsSettings()

public PagedCallSettings<ListAzureClientsRequest,ListAzureClientsResponse,AzureClustersClient.ListAzureClientsPagedResponse> listAzureClientsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListAzureClientsRequest,ListAzureClientsResponse,ListAzureClientsPagedResponse>

listAzureClustersSettings()

public PagedCallSettings<ListAzureClustersRequest,ListAzureClustersResponse,AzureClustersClient.ListAzureClustersPagedResponse> listAzureClustersSettings()

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

Returns
TypeDescription
PagedCallSettings<ListAzureClustersRequest,ListAzureClustersResponse,ListAzureClustersPagedResponse>

listAzureNodePoolsSettings()

public PagedCallSettings<ListAzureNodePoolsRequest,ListAzureNodePoolsResponse,AzureClustersClient.ListAzureNodePoolsPagedResponse> listAzureNodePoolsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListAzureNodePoolsRequest,ListAzureNodePoolsResponse,ListAzureNodePoolsPagedResponse>

toBuilder()

public AzureClustersSettings.Builder toBuilder()

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

Returns
TypeDescription
AzureClustersSettings.Builder
Overrides

updateAzureClusterOperationSettings()

public OperationCallSettings<UpdateAzureClusterRequest,AzureCluster,OperationMetadata> updateAzureClusterOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateAzureClusterRequest,AzureCluster,OperationMetadata>

updateAzureClusterSettings()

public UnaryCallSettings<UpdateAzureClusterRequest,Operation> updateAzureClusterSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateAzureClusterRequest,Operation>

updateAzureNodePoolOperationSettings()

public OperationCallSettings<UpdateAzureNodePoolRequest,AzureNodePool,OperationMetadata> updateAzureNodePoolOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateAzureNodePoolRequest,AzureNodePool,OperationMetadata>

updateAzureNodePoolSettings()

public UnaryCallSettings<UpdateAzureNodePoolRequest,Operation> updateAzureNodePoolSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateAzureNodePoolRequest,Operation>