com.google.cloud.servicedirectory.v1.package-info Maven / Gradle / Ivy
Show all versions of google-cloud-servicedirectory Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* A client to Service Directory API
*
* The interfaces provided are listed below, along with usage samples.
*
*
======================= LookupServiceClient =======================
*
*
Service Description: Service Directory API for looking up service data at runtime.
*
*
Sample for LookupServiceClient:
*
*
{@code
* // 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);
* }
* }
*
* ======================= RegistrationServiceClient =======================
*
*
Service Description: Service Directory API for registering services. It defines the following
* resource model:
*
*
- The API has a collection of [Namespace][google.cloud.servicedirectory.v1.Namespace]
* resources, named `projects/*/locations/*/namespaces/*`.
*
*
- Each Namespace has a collection of [Service][google.cloud.servicedirectory.v1.Service]
* resources, named `projects/*/locations/*/namespaces/*/services/*`.
*
*
- Each Service has a collection of [Endpoint][google.cloud.servicedirectory.v1.Endpoint]
* resources, named
* `projects/*/locations/*/namespaces/*/services/*/endpoints/*`.
*
*
Sample for RegistrationServiceClient:
*
*
{@code
* // 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);
* }
* }
*/
@Generated("by gapic-generator-java")
package com.google.cloud.servicedirectory.v1;
import javax.annotation.Generated;