com.google.cloud.aiplatform.v1

Class NotebookServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<NotebookServiceSettings>

com.google.cloud.aiplatform.v1.NotebookServiceSettings

@Generated(value="by gapic-generator-java")
public class NotebookServiceSettings
extends com.google.api.gax.rpc.ClientSettings<NotebookServiceSettings>

Settings class to configure an instance of NotebookServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (aiplatform.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 getNotebookRuntimeTemplate 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
 NotebookServiceSettings.Builder notebookServiceSettingsBuilder =
     NotebookServiceSettings.newBuilder();
 notebookServiceSettingsBuilder
     .getNotebookRuntimeTemplateSettings()
     .setRetrySettings(
         notebookServiceSettingsBuilder
             .getNotebookRuntimeTemplateSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 NotebookServiceSettings notebookServiceSettings = notebookServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NotebookServiceSettings.Builder Builder for NotebookServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NotebookServiceSettings(NotebookServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.OperationCallSettings<AssignNotebookRuntimeRequest,NotebookRuntime,AssignNotebookRuntimeOperationMetadata>	assignNotebookRuntimeOperationSettings() Returns the object with the settings used for calls to assignNotebookRuntime.
com.google.api.gax.rpc.UnaryCallSettings<AssignNotebookRuntimeRequest,com.google.longrunning.Operation>	assignNotebookRuntimeSettings() Returns the object with the settings used for calls to assignNotebookRuntime.
static NotebookServiceSettings	create(NotebookServiceStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate,CreateNotebookRuntimeTemplateOperationMetadata>	createNotebookRuntimeTemplateOperationSettings() Returns the object with the settings used for calls to createNotebookRuntimeTemplate.
com.google.api.gax.rpc.UnaryCallSettings<CreateNotebookRuntimeTemplateRequest,com.google.longrunning.Operation>	createNotebookRuntimeTemplateSettings() Returns the object with the settings used for calls to createNotebookRuntimeTemplate.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteNotebookRuntimeRequest,com.google.protobuf.Empty,DeleteOperationMetadata>	deleteNotebookRuntimeOperationSettings() Returns the object with the settings used for calls to deleteNotebookRuntime.
com.google.api.gax.rpc.UnaryCallSettings<DeleteNotebookRuntimeRequest,com.google.longrunning.Operation>	deleteNotebookRuntimeSettings() Returns the object with the settings used for calls to deleteNotebookRuntime.
com.google.api.gax.rpc.OperationCallSettings<DeleteNotebookRuntimeTemplateRequest,com.google.protobuf.Empty,DeleteOperationMetadata>	deleteNotebookRuntimeTemplateOperationSettings() Returns the object with the settings used for calls to deleteNotebookRuntimeTemplate.
com.google.api.gax.rpc.UnaryCallSettings<DeleteNotebookRuntimeTemplateRequest,com.google.longrunning.Operation>	deleteNotebookRuntimeTemplateSettings() Returns the object with the settings used for calls to deleteNotebookRuntimeTemplate.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationSettings() Returns the object with the settings used for calls to getLocation.
com.google.api.gax.rpc.UnaryCallSettings<GetNotebookRuntimeRequest,NotebookRuntime>	getNotebookRuntimeSettings() Returns the object with the settings used for calls to getNotebookRuntime.
com.google.api.gax.rpc.UnaryCallSettings<GetNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate>	getNotebookRuntimeTemplateSettings() Returns the object with the settings used for calls to getNotebookRuntimeTemplate.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,NotebookServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
com.google.api.gax.rpc.PagedCallSettings<ListNotebookRuntimesRequest,ListNotebookRuntimesResponse,NotebookServiceClient.ListNotebookRuntimesPagedResponse>	listNotebookRuntimesSettings() Returns the object with the settings used for calls to listNotebookRuntimes.
com.google.api.gax.rpc.PagedCallSettings<ListNotebookRuntimeTemplatesRequest,ListNotebookRuntimeTemplatesResponse,NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse>	listNotebookRuntimeTemplatesSettings() Returns the object with the settings used for calls to listNotebookRuntimeTemplates.
static NotebookServiceSettings.Builder	newBuilder() Returns a new builder for this class.
static NotebookServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.OperationCallSettings<StartNotebookRuntimeRequest,StartNotebookRuntimeResponse,StartNotebookRuntimeOperationMetadata>	startNotebookRuntimeOperationSettings() Returns the object with the settings used for calls to startNotebookRuntime.
com.google.api.gax.rpc.UnaryCallSettings<StartNotebookRuntimeRequest,com.google.longrunning.Operation>	startNotebookRuntimeSettings() Returns the object with the settings used for calls to startNotebookRuntime.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
NotebookServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpgradeNotebookRuntimeRequest,UpgradeNotebookRuntimeResponse,UpgradeNotebookRuntimeOperationMetadata>	upgradeNotebookRuntimeOperationSettings() Returns the object with the settings used for calls to upgradeNotebookRuntime.
com.google.api.gax.rpc.UnaryCallSettings<UpgradeNotebookRuntimeRequest,com.google.longrunning.Operation>	upgradeNotebookRuntimeSettings() Returns the object with the settings used for calls to upgradeNotebookRuntime.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NotebookServiceSettings

protected NotebookServiceSettings(NotebookServiceSettings.Builder settingsBuilder)
                           throws IOException

Throws:

IOException

Method Detail

createNotebookRuntimeTemplateSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateNotebookRuntimeTemplateRequest,com.google.longrunning.Operation> createNotebookRuntimeTemplateSettings()

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

createNotebookRuntimeTemplateOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate,CreateNotebookRuntimeTemplateOperationMetadata> createNotebookRuntimeTemplateOperationSettings()

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

getNotebookRuntimeTemplateSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetNotebookRuntimeTemplateRequest,NotebookRuntimeTemplate> getNotebookRuntimeTemplateSettings()

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

listNotebookRuntimeTemplatesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListNotebookRuntimeTemplatesRequest,ListNotebookRuntimeTemplatesResponse,NotebookServiceClient.ListNotebookRuntimeTemplatesPagedResponse> listNotebookRuntimeTemplatesSettings()

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

deleteNotebookRuntimeTemplateSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteNotebookRuntimeTemplateRequest,com.google.longrunning.Operation> deleteNotebookRuntimeTemplateSettings()

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

deleteNotebookRuntimeTemplateOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteNotebookRuntimeTemplateRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteNotebookRuntimeTemplateOperationSettings()

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

assignNotebookRuntimeSettings

public com.google.api.gax.rpc.UnaryCallSettings<AssignNotebookRuntimeRequest,com.google.longrunning.Operation> assignNotebookRuntimeSettings()

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

assignNotebookRuntimeOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<AssignNotebookRuntimeRequest,NotebookRuntime,AssignNotebookRuntimeOperationMetadata> assignNotebookRuntimeOperationSettings()

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

getNotebookRuntimeSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetNotebookRuntimeRequest,NotebookRuntime> getNotebookRuntimeSettings()

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

listNotebookRuntimesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListNotebookRuntimesRequest,ListNotebookRuntimesResponse,NotebookServiceClient.ListNotebookRuntimesPagedResponse> listNotebookRuntimesSettings()

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

deleteNotebookRuntimeSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteNotebookRuntimeRequest,com.google.longrunning.Operation> deleteNotebookRuntimeSettings()

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

deleteNotebookRuntimeOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteNotebookRuntimeRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteNotebookRuntimeOperationSettings()

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

upgradeNotebookRuntimeSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpgradeNotebookRuntimeRequest,com.google.longrunning.Operation> upgradeNotebookRuntimeSettings()

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

upgradeNotebookRuntimeOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpgradeNotebookRuntimeRequest,UpgradeNotebookRuntimeResponse,UpgradeNotebookRuntimeOperationMetadata> upgradeNotebookRuntimeOperationSettings()

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

startNotebookRuntimeSettings

public com.google.api.gax.rpc.UnaryCallSettings<StartNotebookRuntimeRequest,com.google.longrunning.Operation> startNotebookRuntimeSettings()

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

startNotebookRuntimeOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<StartNotebookRuntimeRequest,StartNotebookRuntimeResponse,StartNotebookRuntimeOperationMetadata> startNotebookRuntimeOperationSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,NotebookServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

getLocationSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()

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

setIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

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

getIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

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

testIamPermissionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

create

public static final NotebookServiceSettings create(NotebookServiceStubSettings stub)
                                            throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static NotebookServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static NotebookServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public NotebookServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<NotebookServiceSettings>