Class ManagedNotebookServiceStubSettings (1.16.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

Static Methods

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

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static ManagedNotebookServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
ManagedNotebookServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static ManagedNotebookServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
ManagedNotebookServiceStubSettings.Builder

Constructors

ManagedNotebookServiceStubSettings(ManagedNotebookServiceStubSettings.Builder settingsBuilder)

protected ManagedNotebookServiceStubSettings(ManagedNotebookServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderManagedNotebookServiceStubSettings.Builder

Methods

createRuntimeOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateRuntimeRequest,Runtime,OperationMetadata>

createRuntimeSettings()

public UnaryCallSettings<CreateRuntimeRequest,Operation> createRuntimeSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateRuntimeRequest,Operation>

createStub()

public ManagedNotebookServiceStub createStub()
Returns
TypeDescription
ManagedNotebookServiceStub
Exceptions
TypeDescription
IOException

deleteRuntimeOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteRuntimeRequest,Empty,OperationMetadata>

deleteRuntimeSettings()

public UnaryCallSettings<DeleteRuntimeRequest,Operation> deleteRuntimeSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteRuntimeRequest,Operation>

diagnoseRuntimeOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DiagnoseRuntimeRequest,Runtime,OperationMetadata>

diagnoseRuntimeSettings()

public UnaryCallSettings<DiagnoseRuntimeRequest,Operation> diagnoseRuntimeSettings()

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

Returns
TypeDescription
UnaryCallSettings<DiagnoseRuntimeRequest,Operation>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
UnaryCallSettings<GetRuntimeRequest,Runtime>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,ManagedNotebookServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
TypeDescription
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
TypeDescription
PagedCallSettings<ListRuntimesRequest,ListRuntimesResponse,ListRuntimesPagedResponse>

refreshRuntimeTokenInternalSettings()

public UnaryCallSettings<RefreshRuntimeTokenInternalRequest,RefreshRuntimeTokenInternalResponse> refreshRuntimeTokenInternalSettings()

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

Returns
TypeDescription
UnaryCallSettings<RefreshRuntimeTokenInternalRequest,RefreshRuntimeTokenInternalResponse>

reportRuntimeEventOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ReportRuntimeEventRequest,Runtime,OperationMetadata>

reportRuntimeEventSettings()

public UnaryCallSettings<ReportRuntimeEventRequest,Operation> reportRuntimeEventSettings()

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

Returns
TypeDescription
UnaryCallSettings<ReportRuntimeEventRequest,Operation>

resetRuntimeOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<ResetRuntimeRequest,Runtime,OperationMetadata>

resetRuntimeSettings()

public UnaryCallSettings<ResetRuntimeRequest,Operation> resetRuntimeSettings()

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

Returns
TypeDescription
UnaryCallSettings<ResetRuntimeRequest,Operation>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
OperationCallSettings<StartRuntimeRequest,Runtime,OperationMetadata>

startRuntimeSettings()

public UnaryCallSettings<StartRuntimeRequest,Operation> startRuntimeSettings()

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

Returns
TypeDescription
UnaryCallSettings<StartRuntimeRequest,Operation>

stopRuntimeOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<StopRuntimeRequest,Runtime,OperationMetadata>

stopRuntimeSettings()

public UnaryCallSettings<StopRuntimeRequest,Operation> stopRuntimeSettings()

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

Returns
TypeDescription
UnaryCallSettings<StopRuntimeRequest,Operation>

switchRuntimeOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<SwitchRuntimeRequest,Runtime,OperationMetadata>

switchRuntimeSettings()

public UnaryCallSettings<SwitchRuntimeRequest,Operation> switchRuntimeSettings()

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

Returns
TypeDescription
UnaryCallSettings<SwitchRuntimeRequest,Operation>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
TypeDescription
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
TypeDescription
ManagedNotebookServiceStubSettings.Builder
Overrides

updateRuntimeOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateRuntimeRequest,Runtime,OperationMetadata>

updateRuntimeSettings()

public UnaryCallSettings<UpdateRuntimeRequest,Operation> updateRuntimeSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateRuntimeRequest,Operation>

upgradeRuntimeOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpgradeRuntimeRequest,Runtime,OperationMetadata>

upgradeRuntimeSettings()

public UnaryCallSettings<UpgradeRuntimeRequest,Operation> upgradeRuntimeSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpgradeRuntimeRequest,Operation>