Class BareMetalSolutionStubSettings (0.10.0)

public class BareMetalSolutionStubSettings extends StubSettings<BareMetalSolutionStubSettings>

Settings class to configure an instance of BareMetalSolutionStub.

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 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
 BareMetalSolutionStubSettings.Builder bareMetalSolutionSettingsBuilder =
     BareMetalSolutionStubSettings.newBuilder();
 bareMetalSolutionSettingsBuilder
     .getInstanceSettings()
     .setRetrySettings(
         bareMetalSolutionSettingsBuilder
             .getInstanceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 BareMetalSolutionStubSettings bareMetalSolutionSettings =
     bareMetalSolutionSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > BareMetalSolutionStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.toBuilder()

StubSettings.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

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 BareMetalSolutionStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns

Type	Description
`BareMetalSolutionStubSettings.Builder`

newBuilder(ClientContext clientContext)

public static BareMetalSolutionStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
`clientContext`	`ClientContext`

Returns

Type	Description
`BareMetalSolutionStubSettings.Builder`

newHttpJsonBuilder()

public static BareMetalSolutionStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Type	Description
`BareMetalSolutionStubSettings.Builder`

Constructors

BareMetalSolutionStubSettings(BareMetalSolutionStubSettings.Builder settingsBuilder)

protected BareMetalSolutionStubSettings(BareMetalSolutionStubSettings.Builder settingsBuilder)

Parameter

Name	Description
`settingsBuilder`	`BareMetalSolutionStubSettings.Builder`

Methods

createStub()

public BareMetalSolutionStub createStub()

Returns

Type	Description
`BareMetalSolutionStub`

Exceptions

Type	Description
`IOException`

detachLunOperationSettings()

public OperationCallSettings<DetachLunRequest,Instance,OperationMetadata> detachLunOperationSettings()

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

Returns

Type	Description
`OperationCallSettings<DetachLunRequest,Instance,OperationMetadata>`

detachLunSettings()

public UnaryCallSettings<DetachLunRequest,Operation> detachLunSettings()

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

Returns

Type	Description
`UnaryCallSettings<DetachLunRequest,Operation>`

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>`

getNfsShareSettings()

public UnaryCallSettings<GetNfsShareRequest,NfsShare> getNfsShareSettings()

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

Returns

Type	Description
`UnaryCallSettings<GetNfsShareRequest,NfsShare>`

getVolumeSettings()

public UnaryCallSettings<GetVolumeRequest,Volume> getVolumeSettings()

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

Returns

Type	Description
`UnaryCallSettings<GetVolumeRequest,Volume>`

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>`

listNetworkUsageSettings()

public UnaryCallSettings<ListNetworkUsageRequest,ListNetworkUsageResponse> listNetworkUsageSettings()

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

Returns

Type	Description
`UnaryCallSettings<ListNetworkUsageRequest,ListNetworkUsageResponse>`

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>`

listNfsSharesSettings()

public PagedCallSettings<ListNfsSharesRequest,ListNfsSharesResponse,BareMetalSolutionClient.ListNfsSharesPagedResponse> listNfsSharesSettings()

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

Returns

Type	Description
`PagedCallSettings<ListNfsSharesRequest,ListNfsSharesResponse,ListNfsSharesPagedResponse>`

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>`

resizeVolumeOperationSettings()

public OperationCallSettings<ResizeVolumeRequest,Volume,OperationMetadata> resizeVolumeOperationSettings()

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

Returns

Type	Description
`OperationCallSettings<ResizeVolumeRequest,Volume,OperationMetadata>`

resizeVolumeSettings()

public UnaryCallSettings<ResizeVolumeRequest,Operation> resizeVolumeSettings()

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

Returns

Type	Description
`UnaryCallSettings<ResizeVolumeRequest,Operation>`

startInstanceOperationSettings()

public OperationCallSettings<StartInstanceRequest,StartInstanceResponse,OperationMetadata> startInstanceOperationSettings()

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

Returns

Type	Description
`OperationCallSettings<StartInstanceRequest,StartInstanceResponse,OperationMetadata>`

startInstanceSettings()

public UnaryCallSettings<StartInstanceRequest,Operation> startInstanceSettings()

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

Returns

Type	Description
`UnaryCallSettings<StartInstanceRequest,Operation>`

stopInstanceOperationSettings()

public OperationCallSettings<StopInstanceRequest,StopInstanceResponse,OperationMetadata> stopInstanceOperationSettings()

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

Returns

Type	Description
`OperationCallSettings<StopInstanceRequest,StopInstanceResponse,OperationMetadata>`

stopInstanceSettings()

public UnaryCallSettings<StopInstanceRequest,Operation> stopInstanceSettings()

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

Returns

Type	Description
`UnaryCallSettings<StopInstanceRequest,Operation>`

toBuilder()

public BareMetalSolutionStubSettings.Builder toBuilder()

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

Returns

Type	Description
`BareMetalSolutionStubSettings.Builder`

Overrides

StubSettings<SettingsT>.toBuilder()

updateInstanceOperationSettings()

public OperationCallSettings<UpdateInstanceRequest,Instance,OperationMetadata> updateInstanceOperationSettings()

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

Returns

Type	Description
`OperationCallSettings<UpdateInstanceRequest,Instance,OperationMetadata>`

updateInstanceSettings()

public UnaryCallSettings<UpdateInstanceRequest,Operation> updateInstanceSettings()

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

Returns

Type	Description
`UnaryCallSettings<UpdateInstanceRequest,Operation>`

updateNetworkOperationSettings()

public OperationCallSettings<UpdateNetworkRequest,Network,OperationMetadata> updateNetworkOperationSettings()

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

Returns

Type	Description
`OperationCallSettings<UpdateNetworkRequest,Network,OperationMetadata>`

updateNetworkSettings()

public UnaryCallSettings<UpdateNetworkRequest,Operation> updateNetworkSettings()

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

Returns

Type	Description
`UnaryCallSettings<UpdateNetworkRequest,Operation>`

updateNfsShareOperationSettings()

public OperationCallSettings<UpdateNfsShareRequest,NfsShare,OperationMetadata> updateNfsShareOperationSettings()

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

Returns

Type	Description
`OperationCallSettings<UpdateNfsShareRequest,NfsShare,OperationMetadata>`

updateNfsShareSettings()

public UnaryCallSettings<UpdateNfsShareRequest,Operation> updateNfsShareSettings()

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

Returns

Type	Description
`UnaryCallSettings<UpdateNfsShareRequest,Operation>`

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>`