Class BareMetalSolutionSettings (0.2.0)

public class BareMetalSolutionSettings extends ClientSettings<BareMetalSolutionSettings>

Settings class to configure an instance of BareMetalSolutionClient.

The default instance has everything set to sensible defaults:

The default service address (baremetalsolution.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 getInstance to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 BareMetalSolutionSettings.Builder bareMetalSolutionSettingsBuilder =
     BareMetalSolutionSettings.newBuilder();
 bareMetalSolutionSettingsBuilder
     .getInstanceSettings()
     .setRetrySettings(
         bareMetalSolutionSettingsBuilder
             .getInstanceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 BareMetalSolutionSettings bareMetalSolutionSettings = bareMetalSolutionSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > BareMetalSolutionSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(BareMetalSolutionStubSettings stub)

public static final BareMetalSolutionSettings create(BareMetalSolutionStubSettings stub)

Parameter

Name	Description
stub	`BareMetalSolutionStubSettings`

Returns

Type	Description
BareMetalSolutionSettings

Exceptions

Type	Description
IOException

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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default 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

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

newBuilder()

public static BareMetalSolutionSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
BareMetalSolutionSettings.Builder

newBuilder(ClientContext clientContext)

public static BareMetalSolutionSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
BareMetalSolutionSettings.Builder

Constructors

BareMetalSolutionSettings(BareMetalSolutionSettings.Builder settingsBuilder)

protected BareMetalSolutionSettings(BareMetalSolutionSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`BareMetalSolutionSettings.Builder`

Methods

createSnapshotSchedulePolicySettings()

public UnaryCallSettings<CreateSnapshotSchedulePolicyRequest,SnapshotSchedulePolicy> createSnapshotSchedulePolicySettings()

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

Returns

Type	Description
UnaryCallSettings<CreateSnapshotSchedulePolicyRequest,SnapshotSchedulePolicy>

createVolumeSnapshotSettings()

public UnaryCallSettings<CreateVolumeSnapshotRequest,VolumeSnapshot> createVolumeSnapshotSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateVolumeSnapshotRequest,VolumeSnapshot>

deleteSnapshotSchedulePolicySettings()

public UnaryCallSettings<DeleteSnapshotSchedulePolicyRequest,Empty> deleteSnapshotSchedulePolicySettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteSnapshotSchedulePolicyRequest,Empty>

deleteVolumeSnapshotSettings()

public UnaryCallSettings<DeleteVolumeSnapshotRequest,Empty> deleteVolumeSnapshotSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteVolumeSnapshotRequest,Empty>

getInstanceSettings()

public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<GetInstanceRequest,Instance>

getLunSettings()

public UnaryCallSettings<GetLunRequest,Lun> getLunSettings()

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

Returns

Type	Description
UnaryCallSettings<GetLunRequest,Lun>

getNetworkSettings()

public UnaryCallSettings<GetNetworkRequest,Network> getNetworkSettings()

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

Returns

Type	Description
UnaryCallSettings<GetNetworkRequest,Network>

getSnapshotSchedulePolicySettings()

public UnaryCallSettings<GetSnapshotSchedulePolicyRequest,SnapshotSchedulePolicy> getSnapshotSchedulePolicySettings()

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

Returns

Type	Description
UnaryCallSettings<GetSnapshotSchedulePolicyRequest,SnapshotSchedulePolicy>

getVolumeSettings()

public UnaryCallSettings<GetVolumeRequest,Volume> getVolumeSettings()

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

Returns

Type	Description
UnaryCallSettings<GetVolumeRequest,Volume>

getVolumeSnapshotSettings()

public UnaryCallSettings<GetVolumeSnapshotRequest,VolumeSnapshot> getVolumeSnapshotSettings()

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

Returns

Type	Description
UnaryCallSettings<GetVolumeSnapshotRequest,VolumeSnapshot>

listInstancesSettings()

public PagedCallSettings<ListInstancesRequest,ListInstancesResponse,BareMetalSolutionClient.ListInstancesPagedResponse> listInstancesSettings()

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

Returns

Type	Description
PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse>

listLunsSettings()

public PagedCallSettings<ListLunsRequest,ListLunsResponse,BareMetalSolutionClient.ListLunsPagedResponse> listLunsSettings()

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

Returns

Type	Description
PagedCallSettings<ListLunsRequest,ListLunsResponse,ListLunsPagedResponse>

listNetworksSettings()

public PagedCallSettings<ListNetworksRequest,ListNetworksResponse,BareMetalSolutionClient.ListNetworksPagedResponse> listNetworksSettings()

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

Returns

Type	Description
PagedCallSettings<ListNetworksRequest,ListNetworksResponse,ListNetworksPagedResponse>

listSnapshotSchedulePoliciesSettings()

public PagedCallSettings<ListSnapshotSchedulePoliciesRequest,ListSnapshotSchedulePoliciesResponse,BareMetalSolutionClient.ListSnapshotSchedulePoliciesPagedResponse> listSnapshotSchedulePoliciesSettings()

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

Returns

Type	Description
PagedCallSettings<ListSnapshotSchedulePoliciesRequest,ListSnapshotSchedulePoliciesResponse,ListSnapshotSchedulePoliciesPagedResponse>

listVolumeSnapshotsSettings()

public PagedCallSettings<ListVolumeSnapshotsRequest,ListVolumeSnapshotsResponse,BareMetalSolutionClient.ListVolumeSnapshotsPagedResponse> listVolumeSnapshotsSettings()

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

Returns

Type	Description
PagedCallSettings<ListVolumeSnapshotsRequest,ListVolumeSnapshotsResponse,ListVolumeSnapshotsPagedResponse>

listVolumesSettings()

public PagedCallSettings<ListVolumesRequest,ListVolumesResponse,BareMetalSolutionClient.ListVolumesPagedResponse> listVolumesSettings()

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

Returns

Type	Description
PagedCallSettings<ListVolumesRequest,ListVolumesResponse,ListVolumesPagedResponse>

resetInstanceOperationSettings()

public OperationCallSettings<ResetInstanceRequest,ResetInstanceResponse,OperationMetadata> resetInstanceOperationSettings()

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

Returns

Type	Description
OperationCallSettings<ResetInstanceRequest,ResetInstanceResponse,OperationMetadata>

resetInstanceSettings()

public UnaryCallSettings<ResetInstanceRequest,Operation> resetInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<ResetInstanceRequest,Operation>

restoreVolumeSnapshotOperationSettings()

public OperationCallSettings<RestoreVolumeSnapshotRequest,VolumeSnapshot,OperationMetadata> restoreVolumeSnapshotOperationSettings()

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

Returns

Type	Description
OperationCallSettings<RestoreVolumeSnapshotRequest,VolumeSnapshot,OperationMetadata>

restoreVolumeSnapshotSettings()

public UnaryCallSettings<RestoreVolumeSnapshotRequest,Operation> restoreVolumeSnapshotSettings()

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

Returns

Type	Description
UnaryCallSettings<RestoreVolumeSnapshotRequest,Operation>

toBuilder()

public BareMetalSolutionSettings.Builder toBuilder()

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

Returns

Type	Description
BareMetalSolutionSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateSnapshotSchedulePolicySettings()

public UnaryCallSettings<UpdateSnapshotSchedulePolicyRequest,SnapshotSchedulePolicy> updateSnapshotSchedulePolicySettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateSnapshotSchedulePolicyRequest,SnapshotSchedulePolicy>

updateVolumeOperationSettings()

public OperationCallSettings<UpdateVolumeRequest,Volume,OperationMetadata> updateVolumeOperationSettings()

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

Returns

Type	Description
OperationCallSettings<UpdateVolumeRequest,Volume,OperationMetadata>

updateVolumeSettings()

public UnaryCallSettings<UpdateVolumeRequest,Operation> updateVolumeSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateVolumeRequest,Operation>