Class EndpointServiceSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<EndpointServiceSettings>
-
- com.google.cloud.aiplatform.v1beta1.EndpointServiceSettings
-
@BetaApi @Generated("by gapic-generator-java") public class EndpointServiceSettings extends com.google.api.gax.rpc.ClientSettings<EndpointServiceSettings>
Settings class to configure an instance ofEndpointServiceClient
.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:
// 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 EndpointServiceSettings.Builder endpointServiceSettingsBuilder = EndpointServiceSettings.newBuilder(); endpointServiceSettingsBuilder .getEndpointSettings() .setRetrySettings( endpointServiceSettingsBuilder .getEndpointSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); EndpointServiceSettings endpointServiceSettings = endpointServiceSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
EndpointServiceSettings.Builder
Builder for EndpointServiceSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
EndpointServiceSettings(EndpointServiceSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static EndpointServiceSettings
create(EndpointServiceStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateEndpointRequest,Endpoint,CreateEndpointOperationMetadata>
createEndpointOperationSettings()
Returns the object with the settings used for calls to createEndpoint.com.google.api.gax.rpc.UnaryCallSettings<CreateEndpointRequest,com.google.longrunning.Operation>
createEndpointSettings()
Returns the object with the settings used for calls to createEndpoint.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<DeleteEndpointRequest,com.google.protobuf.Empty,DeleteOperationMetadata>
deleteEndpointOperationSettings()
Returns the object with the settings used for calls to deleteEndpoint.com.google.api.gax.rpc.UnaryCallSettings<DeleteEndpointRequest,com.google.longrunning.Operation>
deleteEndpointSettings()
Returns the object with the settings used for calls to deleteEndpoint.com.google.api.gax.rpc.OperationCallSettings<DeployModelRequest,DeployModelResponse,DeployModelOperationMetadata>
deployModelOperationSettings()
Returns the object with the settings used for calls to deployModel.com.google.api.gax.rpc.UnaryCallSettings<DeployModelRequest,com.google.longrunning.Operation>
deployModelSettings()
Returns the object with the settings used for calls to deployModel.static String
getDefaultEndpoint()
Returns the default service endpoint.static List<String>
getDefaultServiceScopes()
Returns the default service scopes.com.google.api.gax.rpc.UnaryCallSettings<GetEndpointRequest,Endpoint>
getEndpointSettings()
Returns the object with the settings used for calls to getEndpoint.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.PagedCallSettings<ListEndpointsRequest,ListEndpointsResponse,EndpointServiceClient.ListEndpointsPagedResponse>
listEndpointsSettings()
Returns the object with the settings used for calls to listEndpoints.com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,EndpointServiceClient.ListLocationsPagedResponse>
listLocationsSettings()
Returns the object with the settings used for calls to listLocations.com.google.api.gax.rpc.OperationCallSettings<MutateDeployedModelRequest,MutateDeployedModelResponse,MutateDeployedModelOperationMetadata>
mutateDeployedModelOperationSettings()
Returns the object with the settings used for calls to mutateDeployedModel.com.google.api.gax.rpc.UnaryCallSettings<MutateDeployedModelRequest,com.google.longrunning.Operation>
mutateDeployedModelSettings()
Returns the object with the settings used for calls to mutateDeployedModel.static EndpointServiceSettings.Builder
newBuilder()
Returns a new builder for this class.static EndpointServiceSettings.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.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>
testIamPermissionsSettings()
Returns the object with the settings used for calls to testIamPermissions.EndpointServiceSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.OperationCallSettings<UndeployModelRequest,UndeployModelResponse,UndeployModelOperationMetadata>
undeployModelOperationSettings()
Returns the object with the settings used for calls to undeployModel.com.google.api.gax.rpc.UnaryCallSettings<UndeployModelRequest,com.google.longrunning.Operation>
undeployModelSettings()
Returns the object with the settings used for calls to undeployModel.com.google.api.gax.rpc.UnaryCallSettings<UpdateEndpointRequest,Endpoint>
updateEndpointSettings()
Returns the object with the settings used for calls to updateEndpoint.-
Methods inherited from class com.google.api.gax.rpc.ClientSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString
-
-
-
-
Constructor Detail
-
EndpointServiceSettings
protected EndpointServiceSettings(EndpointServiceSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
createEndpointSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateEndpointRequest,com.google.longrunning.Operation> createEndpointSettings()
Returns the object with the settings used for calls to createEndpoint.
-
createEndpointOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<CreateEndpointRequest,Endpoint,CreateEndpointOperationMetadata> createEndpointOperationSettings()
Returns the object with the settings used for calls to createEndpoint.
-
getEndpointSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetEndpointRequest,Endpoint> getEndpointSettings()
Returns the object with the settings used for calls to getEndpoint.
-
listEndpointsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListEndpointsRequest,ListEndpointsResponse,EndpointServiceClient.ListEndpointsPagedResponse> listEndpointsSettings()
Returns the object with the settings used for calls to listEndpoints.
-
updateEndpointSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateEndpointRequest,Endpoint> updateEndpointSettings()
Returns the object with the settings used for calls to updateEndpoint.
-
deleteEndpointSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteEndpointRequest,com.google.longrunning.Operation> deleteEndpointSettings()
Returns the object with the settings used for calls to deleteEndpoint.
-
deleteEndpointOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<DeleteEndpointRequest,com.google.protobuf.Empty,DeleteOperationMetadata> deleteEndpointOperationSettings()
Returns the object with the settings used for calls to deleteEndpoint.
-
deployModelSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeployModelRequest,com.google.longrunning.Operation> deployModelSettings()
Returns the object with the settings used for calls to deployModel.
-
deployModelOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<DeployModelRequest,DeployModelResponse,DeployModelOperationMetadata> deployModelOperationSettings()
Returns the object with the settings used for calls to deployModel.
-
undeployModelSettings
public com.google.api.gax.rpc.UnaryCallSettings<UndeployModelRequest,com.google.longrunning.Operation> undeployModelSettings()
Returns the object with the settings used for calls to undeployModel.
-
undeployModelOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<UndeployModelRequest,UndeployModelResponse,UndeployModelOperationMetadata> undeployModelOperationSettings()
Returns the object with the settings used for calls to undeployModel.
-
mutateDeployedModelSettings
public com.google.api.gax.rpc.UnaryCallSettings<MutateDeployedModelRequest,com.google.longrunning.Operation> mutateDeployedModelSettings()
Returns the object with the settings used for calls to mutateDeployedModel.
-
mutateDeployedModelOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<MutateDeployedModelRequest,MutateDeployedModelResponse,MutateDeployedModelOperationMetadata> mutateDeployedModelOperationSettings()
Returns the object with the settings used for calls to mutateDeployedModel.
-
listLocationsSettings
public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,EndpointServiceClient.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 EndpointServiceSettings create(EndpointServiceStubSettings 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
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static EndpointServiceSettings.Builder newBuilder()
Returns a new builder for this class.
-
newBuilder
public static EndpointServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public EndpointServiceSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.ClientSettings<EndpointServiceSettings>
-
-