Class MatchServiceStubSettings (3.35.0)

public class MatchServiceStubSettings extends StubSettings<MatchServiceStubSettings>

Settings class to configure an instance of MatchServiceStub.

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 findNeighbors 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
 MatchServiceStubSettings.Builder matchServiceSettingsBuilder =
     MatchServiceStubSettings.newBuilder();
 matchServiceSettingsBuilder
     .findNeighborsSettings()
     .setRetrySettings(
         matchServiceSettingsBuilder
             .findNeighborsSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 MatchServiceStubSettings matchServiceSettings = matchServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > MatchServiceStubSettings

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

Returns a new builder for this class.

Returns
TypeDescription
MatchServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static MatchServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
MatchServiceStubSettings.Builder

Constructors

MatchServiceStubSettings(MatchServiceStubSettings.Builder settingsBuilder)

protected MatchServiceStubSettings(MatchServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderMatchServiceStubSettings.Builder

Methods

createStub()

public MatchServiceStub createStub()
Returns
TypeDescription
MatchServiceStub
Exceptions
TypeDescription
IOException

findNeighborsSettings()

public UnaryCallSettings<FindNeighborsRequest,FindNeighborsResponse> findNeighborsSettings()

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

Returns
TypeDescription
UnaryCallSettings<FindNeighborsRequest,FindNeighborsResponse>

getEndpoint()

public String getEndpoint()

Returns the endpoint set by the user or the the service's default endpoint.

Returns
TypeDescription
String
Overrides

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>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
TypeDescription
String
Overrides

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,MatchServiceClient.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>

readIndexDatapointsSettings()

public UnaryCallSettings<ReadIndexDatapointsRequest,ReadIndexDatapointsResponse> readIndexDatapointsSettings()

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

Returns
TypeDescription
UnaryCallSettings<ReadIndexDatapointsRequest,ReadIndexDatapointsResponse>

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>

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 MatchServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
MatchServiceStubSettings.Builder
Overrides