Class AgentRegistrySettings (0.2.0) 

public class AgentRegistrySettings extends ClientSettings<AgentRegistrySettings>

Settings class to configure an instance of AgentRegistryClient.

The default instance has everything set to sensible defaults:

  • The default service address (agentregistry.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 RetrySettings of getAgent:


 // 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
 AgentRegistrySettings.Builder agentRegistrySettingsBuilder = AgentRegistrySettings.newBuilder();
 agentRegistrySettingsBuilder
     .getAgentSettings()
     .setRetrySettings(
         agentRegistrySettingsBuilder
             .getAgentSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 AgentRegistrySettings agentRegistrySettings = agentRegistrySettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createService:


 // 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
 AgentRegistrySettings.Builder agentRegistrySettingsBuilder = AgentRegistrySettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 agentRegistrySettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > AgentRegistrySettings

Static Methods

create(AgentRegistryStubSettings stub)

public static final AgentRegistrySettings create(AgentRegistryStubSettings stub)
Parameter
Name Description
stub AgentRegistryStubSettings
Returns
Type Description
AgentRegistrySettings
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 gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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 AgentRegistrySettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
AgentRegistrySettings.Builder

newBuilder(@Nullable ClientContext clientContext)

public static AgentRegistrySettings.Builder newBuilder(@Nullable ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext @org.jspecify.annotations.Nullable com.google.api.gax.rpc.ClientContext
Returns
Type Description
AgentRegistrySettings.Builder

newHttpJsonBuilder()

public static AgentRegistrySettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
AgentRegistrySettings.Builder

Constructors

AgentRegistrySettings(AgentRegistrySettings.Builder settingsBuilder)

protected AgentRegistrySettings(AgentRegistrySettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder AgentRegistrySettings.Builder

Methods

createBindingOperationSettings()

public OperationCallSettings<CreateBindingRequest,Binding,OperationMetadata> createBindingOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateBindingRequest,Binding,OperationMetadata>

createBindingSettings()

public UnaryCallSettings<CreateBindingRequest,Operation> createBindingSettings()

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

Returns
Type Description
UnaryCallSettings<CreateBindingRequest,Operation>

createServiceOperationSettings()

public OperationCallSettings<CreateServiceRequest,Service,OperationMetadata> createServiceOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateServiceRequest,Service,OperationMetadata>

createServiceSettings()

public UnaryCallSettings<CreateServiceRequest,Operation> createServiceSettings()

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

Returns
Type Description
UnaryCallSettings<CreateServiceRequest,Operation>

deleteBindingOperationSettings()

public OperationCallSettings<DeleteBindingRequest,Empty,OperationMetadata> deleteBindingOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteBindingRequest,Empty,OperationMetadata>

deleteBindingSettings()

public UnaryCallSettings<DeleteBindingRequest,Operation> deleteBindingSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteBindingRequest,Operation>

deleteServiceOperationSettings()

public OperationCallSettings<DeleteServiceRequest,Empty,OperationMetadata> deleteServiceOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteServiceRequest,Empty,OperationMetadata>

deleteServiceSettings()

public UnaryCallSettings<DeleteServiceRequest,Operation> deleteServiceSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteServiceRequest,Operation>

fetchAvailableBindingsSettings()

public PagedCallSettings<FetchAvailableBindingsRequest,FetchAvailableBindingsResponse,AgentRegistryClient.FetchAvailableBindingsPagedResponse> fetchAvailableBindingsSettings()

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

Returns
Type Description
PagedCallSettings<FetchAvailableBindingsRequest,FetchAvailableBindingsResponse,FetchAvailableBindingsPagedResponse>

getAgentSettings()

public UnaryCallSettings<GetAgentRequest,Agent> getAgentSettings()

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

Returns
Type Description
UnaryCallSettings<GetAgentRequest,Agent>

getBindingSettings()

public UnaryCallSettings<GetBindingRequest,Binding> getBindingSettings()

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

Returns
Type Description
UnaryCallSettings<GetBindingRequest,Binding>

getEndpointSettings()

public UnaryCallSettings<GetEndpointRequest,Endpoint> getEndpointSettings()

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

Returns
Type Description
UnaryCallSettings<GetEndpointRequest,Endpoint>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getMcpServerSettings()

public UnaryCallSettings<GetMcpServerRequest,McpServer> getMcpServerSettings()

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

Returns
Type Description
UnaryCallSettings<GetMcpServerRequest,McpServer>

getServiceSettings()

public UnaryCallSettings<GetServiceRequest,Service> getServiceSettings()

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

Returns
Type Description
UnaryCallSettings<GetServiceRequest,Service>

listAgentsSettings()

public PagedCallSettings<ListAgentsRequest,ListAgentsResponse,AgentRegistryClient.ListAgentsPagedResponse> listAgentsSettings()

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

Returns
Type Description
PagedCallSettings<ListAgentsRequest,ListAgentsResponse,ListAgentsPagedResponse>

listBindingsSettings()

public PagedCallSettings<ListBindingsRequest,ListBindingsResponse,AgentRegistryClient.ListBindingsPagedResponse> listBindingsSettings()

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

Returns
Type Description
PagedCallSettings<ListBindingsRequest,ListBindingsResponse,ListBindingsPagedResponse>

listEndpointsSettings()

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

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

Returns
Type Description
PagedCallSettings<ListEndpointsRequest,ListEndpointsResponse,ListEndpointsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,AgentRegistryClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listMcpServersSettings()

public PagedCallSettings<ListMcpServersRequest,ListMcpServersResponse,AgentRegistryClient.ListMcpServersPagedResponse> listMcpServersSettings()

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

Returns
Type Description
PagedCallSettings<ListMcpServersRequest,ListMcpServersResponse,ListMcpServersPagedResponse>

listServicesSettings()

public PagedCallSettings<ListServicesRequest,ListServicesResponse,AgentRegistryClient.ListServicesPagedResponse> listServicesSettings()

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

Returns
Type Description
PagedCallSettings<ListServicesRequest,ListServicesResponse,ListServicesPagedResponse>

searchAgentsSettings()

public PagedCallSettings<SearchAgentsRequest,SearchAgentsResponse,AgentRegistryClient.SearchAgentsPagedResponse> searchAgentsSettings()

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

Returns
Type Description
PagedCallSettings<SearchAgentsRequest,SearchAgentsResponse,SearchAgentsPagedResponse>

searchMcpServersSettings()

public PagedCallSettings<SearchMcpServersRequest,SearchMcpServersResponse,AgentRegistryClient.SearchMcpServersPagedResponse> searchMcpServersSettings()

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

Returns
Type Description
PagedCallSettings<SearchMcpServersRequest,SearchMcpServersResponse,SearchMcpServersPagedResponse>

toBuilder()

public AgentRegistrySettings.Builder toBuilder()

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

Returns
Type Description
AgentRegistrySettings.Builder
Overrides

updateBindingOperationSettings()

public OperationCallSettings<UpdateBindingRequest,Binding,OperationMetadata> updateBindingOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateBindingRequest,Binding,OperationMetadata>

updateBindingSettings()

public UnaryCallSettings<UpdateBindingRequest,Operation> updateBindingSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateBindingRequest,Operation>

updateServiceOperationSettings()

public OperationCallSettings<UpdateServiceRequest,Service,OperationMetadata> updateServiceOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateServiceRequest,Service,OperationMetadata>

updateServiceSettings()

public UnaryCallSettings<UpdateServiceRequest,Operation> updateServiceSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateServiceRequest,Operation>