Package com.google.cloud.servicedirectory.v1 (2.18.0)

The request message for RegistrationService.CreateEndpoint.

Protobuf type google.cloud.servicedirectory.v1.CreateEndpointRequest

The request message for RegistrationService.CreateEndpoint.

Protobuf type google.cloud.servicedirectory.v1.CreateEndpointRequest

The request message for RegistrationService.CreateNamespace.

Protobuf type google.cloud.servicedirectory.v1.CreateNamespaceRequest

The request message for RegistrationService.CreateNamespace.

Protobuf type google.cloud.servicedirectory.v1.CreateNamespaceRequest

The request message for RegistrationService.CreateService.

Protobuf type google.cloud.servicedirectory.v1.CreateServiceRequest

The request message for RegistrationService.CreateService.

Protobuf type google.cloud.servicedirectory.v1.CreateServiceRequest

The request message for RegistrationService.DeleteEndpoint.

Protobuf type google.cloud.servicedirectory.v1.DeleteEndpointRequest

The request message for RegistrationService.DeleteEndpoint.

Protobuf type google.cloud.servicedirectory.v1.DeleteEndpointRequest

The request message for RegistrationService.DeleteNamespace.

Protobuf type google.cloud.servicedirectory.v1.DeleteNamespaceRequest

The request message for RegistrationService.DeleteNamespace.

Protobuf type google.cloud.servicedirectory.v1.DeleteNamespaceRequest

The request message for RegistrationService.DeleteService.

Protobuf type google.cloud.servicedirectory.v1.DeleteServiceRequest

The request message for RegistrationService.DeleteService.

Protobuf type google.cloud.servicedirectory.v1.DeleteServiceRequest

An individual endpoint that provides a service. The service must already exist to create an endpoint.

Protobuf type google.cloud.servicedirectory.v1.Endpoint

An individual endpoint that provides a service. The service must already exist to create an endpoint.

Protobuf type google.cloud.servicedirectory.v1.Endpoint

Builder for projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}/endpoints/{endpoint}.

The request message for RegistrationService.GetEndpoint. This should not be used to lookup endpoints at runtime. Instead, use the resolve method.

Protobuf type google.cloud.servicedirectory.v1.GetEndpointRequest

The request message for RegistrationService.GetEndpoint. This should not be used to lookup endpoints at runtime. Instead, use the resolve method.

Protobuf type google.cloud.servicedirectory.v1.GetEndpointRequest

The request message for RegistrationService.GetNamespace.

Protobuf type google.cloud.servicedirectory.v1.GetNamespaceRequest

The request message for RegistrationService.GetNamespace.

Protobuf type google.cloud.servicedirectory.v1.GetNamespaceRequest

The request message for RegistrationService.GetService. This should not be used for looking up a service. Insead, use the resolve method as it will contain all endpoints and associated metadata.

Protobuf type google.cloud.servicedirectory.v1.GetServiceRequest

The request message for RegistrationService.GetService. This should not be used for looking up a service. Insead, use the resolve method as it will contain all endpoints and associated metadata.

Protobuf type google.cloud.servicedirectory.v1.GetServiceRequest

The request message for RegistrationService.ListEndpoints.

Protobuf type google.cloud.servicedirectory.v1.ListEndpointsRequest

The request message for RegistrationService.ListEndpoints.

Protobuf type google.cloud.servicedirectory.v1.ListEndpointsRequest

The response message for RegistrationService.ListEndpoints.

Protobuf type google.cloud.servicedirectory.v1.ListEndpointsResponse

The response message for RegistrationService.ListEndpoints.

Protobuf type google.cloud.servicedirectory.v1.ListEndpointsResponse

The request message for RegistrationService.ListNamespaces.

Protobuf type google.cloud.servicedirectory.v1.ListNamespacesRequest

The request message for RegistrationService.ListNamespaces.

Protobuf type google.cloud.servicedirectory.v1.ListNamespacesRequest

The response message for RegistrationService.ListNamespaces.

Protobuf type google.cloud.servicedirectory.v1.ListNamespacesResponse

The response message for RegistrationService.ListNamespaces.

Protobuf type google.cloud.servicedirectory.v1.ListNamespacesResponse

The request message for RegistrationService.ListServices.

Protobuf type google.cloud.servicedirectory.v1.ListServicesRequest

The request message for RegistrationService.ListServices.

Protobuf type google.cloud.servicedirectory.v1.ListServicesRequest

The response message for RegistrationService.ListServices.

Protobuf type google.cloud.servicedirectory.v1.ListServicesResponse

The response message for RegistrationService.ListServices.

Protobuf type google.cloud.servicedirectory.v1.ListServicesResponse

Builder for projects/{project}/locations/{location}.

Service Description: Service Directory API for looking up service data at runtime.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // 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
 try (LookupServiceClient lookupServiceClient = LookupServiceClient.create()) {
   ResolveServiceRequest request =
       ResolveServiceRequest.newBuilder()
           .setName(
               ServiceName.of("[PROJECT]", "[LOCATION]", "[NAMESPACE]", "[SERVICE]").toString())
           .setMaxEndpoints(2074789987)
           .setEndpointFilter("endpointFilter-1834249875")
           .build();
   ResolveServiceResponse response = lookupServiceClient.resolveService(request);
 }
 

Note: close() needs to be called on the LookupServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of LookupServiceSettings to create(). For example:

To customize credentials:

 // 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
 LookupServiceSettings lookupServiceSettings =
     LookupServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LookupServiceClient lookupServiceClient = LookupServiceClient.create(lookupServiceSettings);
 

To customize the endpoint:

 // 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
 LookupServiceSettings lookupServiceSettings =
     LookupServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 LookupServiceClient lookupServiceClient = LookupServiceClient.create(lookupServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // 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
 LookupServiceSettings lookupServiceSettings =
     LookupServiceSettings.newHttpJsonBuilder().build();
 LookupServiceClient lookupServiceClient = LookupServiceClient.create(lookupServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Service Directory API for looking up service data at runtime.

A stub to allow clients to do synchronous rpc calls to service LookupService.

Service Directory API for looking up service data at runtime.

A stub to allow clients to do ListenableFuture-style rpc calls to service LookupService.

Service Directory API for looking up service data at runtime.

Base class for the server implementation of the service LookupService.

Service Directory API for looking up service data at runtime.

A stub to allow clients to do asynchronous rpc calls to service LookupService.

Service Directory API for looking up service data at runtime.

Settings class to configure an instance of LookupServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (servicedirectory.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 resolveService 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
 LookupServiceSettings.Builder lookupServiceSettingsBuilder = LookupServiceSettings.newBuilder();
 lookupServiceSettingsBuilder
     .resolveServiceSettings()
     .setRetrySettings(
         lookupServiceSettingsBuilder
             .resolveServiceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 LookupServiceSettings lookupServiceSettings = lookupServiceSettingsBuilder.build();
 

Builder for LookupServiceSettings.

A container for services. Namespaces allow administrators to group services together and define permissions for a collection of services.

Protobuf type google.cloud.servicedirectory.v1.Namespace

A container for services. Namespaces allow administrators to group services together and define permissions for a collection of services.

Protobuf type google.cloud.servicedirectory.v1.Namespace

Builder for projects/{project}/locations/{location}/namespaces/{namespace}.

Service Description: Service Directory API for registering services. It defines the following resource model:

- The API has a collection of Namespace resources, named projects/*/locations/*/namespaces/*.

- Each Namespace has a collection of Service resources, named projects/*/locations/*/namespaces/*/services/*.

- Each Service has a collection of Endpoint resources, named projects/*/locations/*/namespaces/*/services/*/endpoints/*.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // 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
 try (RegistrationServiceClient registrationServiceClient = RegistrationServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Namespace namespace = Namespace.newBuilder().build();
   String namespaceId = "namespaceId790852566";
   Namespace response =
       registrationServiceClient.createNamespace(parent, namespace, namespaceId);
 }
 

Note: close() needs to be called on the RegistrationServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of RegistrationServiceSettings to create(). For example:

To customize credentials:

 // 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
 RegistrationServiceSettings registrationServiceSettings =
     RegistrationServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegistrationServiceClient registrationServiceClient =
     RegistrationServiceClient.create(registrationServiceSettings);
 

To customize the endpoint:

 // 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
 RegistrationServiceSettings registrationServiceSettings =
     RegistrationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 RegistrationServiceClient registrationServiceClient =
     RegistrationServiceClient.create(registrationServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // 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
 RegistrationServiceSettings registrationServiceSettings =
     RegistrationServiceSettings.newHttpJsonBuilder().build();
 RegistrationServiceClient registrationServiceClient =
     RegistrationServiceClient.create(registrationServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Service Directory API for registering services. It defines the following resource model:

• The API has a collection of Namespace resources, named projects/*/locations/*/namespaces/*.
• Each Namespace has a collection of Service resources, named projects/*/locations/*/namespaces/*/services/*.
• Each Service has a collection of Endpoint resources, named projects/*/locations/*/namespaces/*/services/*/endpoints/*.

A stub to allow clients to do synchronous rpc calls to service RegistrationService.

Service Directory API for registering services. It defines the following resource model:

• The API has a collection of Namespace resources, named projects/*/locations/*/namespaces/*.
• Each Namespace has a collection of Service resources, named projects/*/locations/*/namespaces/*/services/*.
• Each Service has a collection of Endpoint resources, named projects/*/locations/*/namespaces/*/services/*/endpoints/*.

A stub to allow clients to do ListenableFuture-style rpc calls to service RegistrationService.

Service Directory API for registering services. It defines the following resource model:

• The API has a collection of Namespace resources, named projects/*/locations/*/namespaces/*.
• Each Namespace has a collection of Service resources, named projects/*/locations/*/namespaces/*/services/*.
• Each Service has a collection of Endpoint resources, named projects/*/locations/*/namespaces/*/services/*/endpoints/*.

Base class for the server implementation of the service RegistrationService.

Service Directory API for registering services. It defines the following resource model:

• The API has a collection of Namespace resources, named projects/*/locations/*/namespaces/*.
• Each Namespace has a collection of Service resources, named projects/*/locations/*/namespaces/*/services/*.
• Each Service has a collection of Endpoint resources, named projects/*/locations/*/namespaces/*/services/*/endpoints/*.

A stub to allow clients to do asynchronous rpc calls to service RegistrationService.

Service Directory API for registering services. It defines the following resource model:

• The API has a collection of Namespace resources, named projects/*/locations/*/namespaces/*.
• Each Namespace has a collection of Service resources, named projects/*/locations/*/namespaces/*/services/*.
• Each Service has a collection of Endpoint resources, named projects/*/locations/*/namespaces/*/services/*/endpoints/*.

Settings class to configure an instance of RegistrationServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (servicedirectory.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 createNamespace 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
 RegistrationServiceSettings.Builder registrationServiceSettingsBuilder =
     RegistrationServiceSettings.newBuilder();
 registrationServiceSettingsBuilder
     .createNamespaceSettings()
     .setRetrySettings(
         registrationServiceSettingsBuilder
             .createNamespaceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 RegistrationServiceSettings registrationServiceSettings =
     registrationServiceSettingsBuilder.build();
 

Builder for RegistrationServiceSettings.

The request message for LookupService.ResolveService. Looks up a service by its name, returns the service and its endpoints.

Protobuf type google.cloud.servicedirectory.v1.ResolveServiceRequest

The request message for LookupService.ResolveService. Looks up a service by its name, returns the service and its endpoints.

Protobuf type google.cloud.servicedirectory.v1.ResolveServiceRequest

The response message for LookupService.ResolveService.

Protobuf type google.cloud.servicedirectory.v1.ResolveServiceResponse

The response message for LookupService.ResolveService.

Protobuf type google.cloud.servicedirectory.v1.ResolveServiceResponse

An individual service. A service contains a name and optional metadata. A service must exist before endpoints can be added to it.

Protobuf type google.cloud.servicedirectory.v1.Service

An individual service. A service contains a name and optional metadata. A service must exist before endpoints can be added to it.

Protobuf type google.cloud.servicedirectory.v1.Service

Builder for projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.

The request message for RegistrationService.UpdateEndpoint.

Protobuf type google.cloud.servicedirectory.v1.UpdateEndpointRequest

The request message for RegistrationService.UpdateEndpoint.

Protobuf type google.cloud.servicedirectory.v1.UpdateEndpointRequest

The request message for RegistrationService.UpdateNamespace.

Protobuf type google.cloud.servicedirectory.v1.UpdateNamespaceRequest

The request message for RegistrationService.UpdateNamespace.

Protobuf type google.cloud.servicedirectory.v1.UpdateNamespaceRequest

The request message for RegistrationService.UpdateService.

Protobuf type google.cloud.servicedirectory.v1.UpdateServiceRequest

The request message for RegistrationService.UpdateService.

Protobuf type google.cloud.servicedirectory.v1.UpdateServiceRequest

Service Directory API for looking up service data at runtime.

Service Directory API for registering services. It defines the following resource model:

• The API has a collection of Namespace resources, named projects/*/locations/*/namespaces/*.
• Each Namespace has a collection of Service resources, named projects/*/locations/*/namespaces/*/services/*.
• Each Service has a collection of Endpoint resources, named projects/*/locations/*/namespaces/*/services/*/endpoints/*.