Class EndpointServiceSettings (2.7.4)

public class EndpointServiceSettings extends ClientSettings<EndpointServiceSettings>

Settings class to configure an instance of EndpointServiceClient.

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 getEndpoint to 30 seconds:


 EndpointServiceSettings.Builder endpointServiceSettingsBuilder =
     EndpointServiceSettings.newBuilder();
 endpointServiceSettingsBuilder
     .getEndpointSettings()
     .setRetrySettings(
         endpointServiceSettingsBuilder
             .getEndpointSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 EndpointServiceSettings endpointServiceSettings = endpointServiceSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > EndpointServiceSettings

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(EndpointServiceStubSettings stub)

public static final EndpointServiceSettings create(EndpointServiceStubSettings stub)

Parameter

Name	Description
stub	`EndpointServiceStubSettings`

Returns

Type	Description
EndpointServiceSettings

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

Returns a new builder for this class.

Returns

Type	Description
EndpointServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static EndpointServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
EndpointServiceSettings.Builder

Constructors

EndpointServiceSettings(EndpointServiceSettings.Builder settingsBuilder)

protected EndpointServiceSettings(EndpointServiceSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`EndpointServiceSettings.Builder`

Methods

createEndpointOperationSettings()

public OperationCallSettings<CreateEndpointRequest,Endpoint,CreateEndpointOperationMetadata> createEndpointOperationSettings()

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

Returns

Type	Description
OperationCallSettings<CreateEndpointRequest,Endpoint,CreateEndpointOperationMetadata>

createEndpointSettings()

public UnaryCallSettings<CreateEndpointRequest,Operation> createEndpointSettings()

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

Returns

Type	Description
UnaryCallSettings<CreateEndpointRequest,Operation>

deleteEndpointOperationSettings()

public OperationCallSettings<DeleteEndpointRequest,Empty,DeleteOperationMetadata> deleteEndpointOperationSettings()

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

Returns

Type	Description
OperationCallSettings<DeleteEndpointRequest,Empty,DeleteOperationMetadata>

deleteEndpointSettings()

public UnaryCallSettings<DeleteEndpointRequest,Operation> deleteEndpointSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteEndpointRequest,Operation>

deployModelOperationSettings()

public OperationCallSettings<DeployModelRequest,DeployModelResponse,DeployModelOperationMetadata> deployModelOperationSettings()

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

Returns

Type	Description
OperationCallSettings<DeployModelRequest,DeployModelResponse,DeployModelOperationMetadata>

deployModelSettings()

public UnaryCallSettings<DeployModelRequest,Operation> deployModelSettings()

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

Returns

Type	Description
UnaryCallSettings<DeployModelRequest,Operation>

getEndpointSettings()

public UnaryCallSettings<GetEndpointRequest,Endpoint> getEndpointSettings()

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

Returns

Type	Description
UnaryCallSettings<GetEndpointRequest,Endpoint>

listEndpointsSettings()

public PagedCallSettings<ListEndpointsRequest,ListEndpointsResponse,EndpointServiceClient.ListEndpointsPagedResponse> listEndpointsSettings()

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

Returns

Type	Description
PagedCallSettings<ListEndpointsRequest,ListEndpointsResponse,ListEndpointsPagedResponse>

toBuilder()

public EndpointServiceSettings.Builder toBuilder()

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

Returns

Type	Description
EndpointServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

undeployModelOperationSettings()

public OperationCallSettings<UndeployModelRequest,UndeployModelResponse,UndeployModelOperationMetadata> undeployModelOperationSettings()

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

Returns

Type	Description
OperationCallSettings<UndeployModelRequest,UndeployModelResponse,UndeployModelOperationMetadata>

undeployModelSettings()

public UnaryCallSettings<UndeployModelRequest,Operation> undeployModelSettings()

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

Returns

Type	Description
UnaryCallSettings<UndeployModelRequest,Operation>

updateEndpointSettings()

public UnaryCallSettings<UpdateEndpointRequest,Endpoint> updateEndpointSettings()

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

Returns

Type	Description
UnaryCallSettings<UpdateEndpointRequest,Endpoint>