Class EndpointServiceSettings (2.5.3)

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

Constructors

EndpointServiceSettings(EndpointServiceSettings.Builder settingsBuilder)

protected EndpointServiceSettings(EndpointServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderEndpointServiceSettings.Builder

Methods

create(EndpointServiceStubSettings stub)

public static final EndpointServiceSettings create(EndpointServiceStubSettings stub)
Parameter
NameDescription
stubEndpointServiceStubSettings
Returns
TypeDescription
EndpointServiceSettings
Exceptions
TypeDescription
IOException

createEndpointOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateEndpointRequest,Endpoint,CreateEndpointOperationMetadata>

createEndpointSettings()

public UnaryCallSettings<CreateEndpointRequest,Operation> createEndpointSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateEndpointRequest,Operation>

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

deleteEndpointOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteEndpointRequest,Empty,DeleteOperationMetadata>

deleteEndpointSettings()

public UnaryCallSettings<DeleteEndpointRequest,Operation> deleteEndpointSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteEndpointRequest,Operation>

deployModelOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeployModelRequest,DeployModelResponse,DeployModelOperationMetadata>

deployModelSettings()

public UnaryCallSettings<DeployModelRequest,Operation> deployModelSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeployModelRequest,Operation>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

getEndpointSettings()

public UnaryCallSettings<GetEndpointRequest,Endpoint> getEndpointSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetEndpointRequest,Endpoint>

listEndpointsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListEndpointsRequest,ListEndpointsResponse,ListEndpointsPagedResponse>

newBuilder()

public static EndpointServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
EndpointServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static EndpointServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
EndpointServiceSettings.Builder

toBuilder()

public EndpointServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
EndpointServiceSettings.Builder
Overrides

undeployModelOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UndeployModelRequest,UndeployModelResponse,UndeployModelOperationMetadata>

undeployModelSettings()

public UnaryCallSettings<UndeployModelRequest,Operation> undeployModelSettings()

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

Returns
TypeDescription
UnaryCallSettings<UndeployModelRequest,Operation>

updateEndpointSettings()

public UnaryCallSettings<UpdateEndpointRequest,Endpoint> updateEndpointSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateEndpointRequest,Endpoint>