Class ManagedNotebookServiceStubSettings (1.39.0)

public class ManagedNotebookServiceStubSettings extends StubSettings<ManagedNotebookServiceStubSettings>

Settings class to configure an instance of ManagedNotebookServiceStub.

The default instance has everything set to sensible defaults:

The default service address (notebooks.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 getRuntime 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
 ManagedNotebookServiceStubSettings.Builder managedNotebookServiceSettingsBuilder =
     ManagedNotebookServiceStubSettings.newBuilder();
 managedNotebookServiceSettingsBuilder
     .getRuntimeSettings()
     .setRetrySettings(
         managedNotebookServiceSettingsBuilder
             .getRuntimeSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ManagedNotebookServiceStubSettings managedNotebookServiceSettings =
     managedNotebookServiceSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > ManagedNotebookServiceStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

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`

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`

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

Returns a new builder for this class.

Returns
Type	Description
`ManagedNotebookServiceStubSettings.Builder`

newBuilder(ClientContext clientContext)

public static ManagedNotebookServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`ManagedNotebookServiceStubSettings.Builder`

Constructors

ManagedNotebookServiceStubSettings(ManagedNotebookServiceStubSettings.Builder settingsBuilder)

protected ManagedNotebookServiceStubSettings(ManagedNotebookServiceStubSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`ManagedNotebookServiceStubSettings.Builder`

Methods

createRuntimeOperationSettings()

public OperationCallSettings<CreateRuntimeRequest,Runtime,OperationMetadata> createRuntimeOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateRuntimeRequest,Runtime,OperationMetadata>`

createRuntimeSettings()

public UnaryCallSettings<CreateRuntimeRequest,Operation> createRuntimeSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateRuntimeRequest,Operation>`

createStub()

public ManagedNotebookServiceStub createStub()

Returns
Type	Description
`ManagedNotebookServiceStub`

Exceptions
Type	Description
`IOException`

deleteRuntimeOperationSettings()

public OperationCallSettings<DeleteRuntimeRequest,Empty,OperationMetadata> deleteRuntimeOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DeleteRuntimeRequest,Empty,OperationMetadata>`

deleteRuntimeSettings()

public UnaryCallSettings<DeleteRuntimeRequest,Operation> deleteRuntimeSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteRuntimeRequest,Operation>`

diagnoseRuntimeOperationSettings()

public OperationCallSettings<DiagnoseRuntimeRequest,Runtime,OperationMetadata> diagnoseRuntimeOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<DiagnoseRuntimeRequest,Runtime,OperationMetadata>`

diagnoseRuntimeSettings()

public UnaryCallSettings<DiagnoseRuntimeRequest,Operation> diagnoseRuntimeSettings()

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

Returns
Type	Description
`UnaryCallSettings<DiagnoseRuntimeRequest,Operation>`

getEndpoint()

public String getEndpoint()

Returns the endpoint set by the user or the the service's default endpoint.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getEndpoint()

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`

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

getRuntimeSettings()

public UnaryCallSettings<GetRuntimeRequest,Runtime> getRuntimeSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetRuntimeRequest,Runtime>`

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getServiceName()

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,ManagedNotebookServiceClient.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>`

listRuntimesSettings()

public PagedCallSettings<ListRuntimesRequest,ListRuntimesResponse,ManagedNotebookServiceClient.ListRuntimesPagedResponse> listRuntimesSettings()

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

Returns
Type	Description
`PagedCallSettings<ListRuntimesRequest,ListRuntimesResponse,ListRuntimesPagedResponse>`

refreshRuntimeTokenInternalSettings()

public UnaryCallSettings<RefreshRuntimeTokenInternalRequest,RefreshRuntimeTokenInternalResponse> refreshRuntimeTokenInternalSettings()

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

Returns
Type	Description
`UnaryCallSettings<RefreshRuntimeTokenInternalRequest,RefreshRuntimeTokenInternalResponse>`

reportRuntimeEventOperationSettings()

public OperationCallSettings<ReportRuntimeEventRequest,Runtime,OperationMetadata> reportRuntimeEventOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<ReportRuntimeEventRequest,Runtime,OperationMetadata>`

reportRuntimeEventSettings()

public UnaryCallSettings<ReportRuntimeEventRequest,Operation> reportRuntimeEventSettings()

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

Returns
Type	Description
`UnaryCallSettings<ReportRuntimeEventRequest,Operation>`

resetRuntimeOperationSettings()

public OperationCallSettings<ResetRuntimeRequest,Runtime,OperationMetadata> resetRuntimeOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<ResetRuntimeRequest,Runtime,OperationMetadata>`

resetRuntimeSettings()

public UnaryCallSettings<ResetRuntimeRequest,Operation> resetRuntimeSettings()

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

Returns
Type	Description
`UnaryCallSettings<ResetRuntimeRequest,Operation>`

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`

startRuntimeOperationSettings()

public OperationCallSettings<StartRuntimeRequest,Runtime,OperationMetadata> startRuntimeOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<StartRuntimeRequest,Runtime,OperationMetadata>`

startRuntimeSettings()

public UnaryCallSettings<StartRuntimeRequest,Operation> startRuntimeSettings()

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

Returns
Type	Description
`UnaryCallSettings<StartRuntimeRequest,Operation>`

stopRuntimeOperationSettings()

public OperationCallSettings<StopRuntimeRequest,Runtime,OperationMetadata> stopRuntimeOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<StopRuntimeRequest,Runtime,OperationMetadata>`

stopRuntimeSettings()

public UnaryCallSettings<StopRuntimeRequest,Operation> stopRuntimeSettings()

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

Returns
Type	Description
`UnaryCallSettings<StopRuntimeRequest,Operation>`

switchRuntimeOperationSettings()

public OperationCallSettings<SwitchRuntimeRequest,Runtime,OperationMetadata> switchRuntimeOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<SwitchRuntimeRequest,Runtime,OperationMetadata>`

switchRuntimeSettings()

public UnaryCallSettings<SwitchRuntimeRequest,Operation> switchRuntimeSettings()

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

Returns
Type	Description
`UnaryCallSettings<SwitchRuntimeRequest,Operation>`

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`

toBuilder()

public ManagedNotebookServiceStubSettings.Builder toBuilder()

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

Returns
Type	Description
`ManagedNotebookServiceStubSettings.Builder`

Overrides

StubSettings<SettingsT>.toBuilder()

updateRuntimeOperationSettings()

public OperationCallSettings<UpdateRuntimeRequest,Runtime,OperationMetadata> updateRuntimeOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateRuntimeRequest,Runtime,OperationMetadata>`

updateRuntimeSettings()

public UnaryCallSettings<UpdateRuntimeRequest,Operation> updateRuntimeSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateRuntimeRequest,Operation>`

upgradeRuntimeOperationSettings()

public OperationCallSettings<UpgradeRuntimeRequest,Runtime,OperationMetadata> upgradeRuntimeOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpgradeRuntimeRequest,Runtime,OperationMetadata>`

upgradeRuntimeSettings()

public UnaryCallSettings<UpgradeRuntimeRequest,Operation> upgradeRuntimeSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpgradeRuntimeRequest,Operation>`