com.google.cloud.apihub.v1.package-info Maven / Gradle / Ivy
Show all versions of google-cloud-apihub 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 API hub API
*
* The interfaces provided are listed below, along with usage samples.
*
*
======================= ApiHubClient =======================
*
*
Service Description: This service provides all methods related to the API hub.
*
*
Sample for ApiHubClient:
*
*
{@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 (ApiHubClient apiHubClient = ApiHubClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* Api api = Api.newBuilder().build();
* String apiId = "apiId93021397";
* Api response = apiHubClient.createApi(parent, api, apiId);
* }
* }
*
* ======================= ApiHubDependenciesClient =======================
*
*
Service Description: This service provides methods for various operations related to a
* [Dependency][google.cloud.apihub.v1.Dependency] in the API hub.
*
*
Sample for ApiHubDependenciesClient:
*
*
{@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 (ApiHubDependenciesClient apiHubDependenciesClient = ApiHubDependenciesClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* Dependency dependency = Dependency.newBuilder().build();
* String dependencyId = "dependencyId503788998";
* Dependency response =
* apiHubDependenciesClient.createDependency(parent, dependency, dependencyId);
* }
* }
*
* ======================= HostProjectRegistrationServiceClient =======================
*
*
Service Description: This service is used for managing the host project registrations.
*
*
Sample for HostProjectRegistrationServiceClient:
*
*
{@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 (HostProjectRegistrationServiceClient hostProjectRegistrationServiceClient =
* HostProjectRegistrationServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* HostProjectRegistration hostProjectRegistration =
* HostProjectRegistration.newBuilder().build();
* String hostProjectRegistrationId = "hostProjectRegistrationId1352651365";
* HostProjectRegistration response =
* hostProjectRegistrationServiceClient.createHostProjectRegistration(
* parent, hostProjectRegistration, hostProjectRegistrationId);
* }
* }
*
* ======================= LintingServiceClient =======================
*
*
Service Description: This service provides all methods related to the 1p Linter.
*
*
Sample for LintingServiceClient:
*
*
{@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 (LintingServiceClient lintingServiceClient = LintingServiceClient.create()) {
* StyleGuideName name = StyleGuideName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]");
* StyleGuide response = lintingServiceClient.getStyleGuide(name);
* }
* }
*
* ======================= ApiHubPluginClient =======================
*
*
Service Description: This service is used for managing plugins inside the API Hub.
*
*
Sample for ApiHubPluginClient:
*
*
{@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 (ApiHubPluginClient apiHubPluginClient = ApiHubPluginClient.create()) {
* PluginName name = PluginName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]");
* Plugin response = apiHubPluginClient.getPlugin(name);
* }
* }
*
* ======================= ProvisioningClient =======================
*
*
Service Description: This service is used for managing the data plane provisioning of the API
* hub.
*
*
Sample for ProvisioningClient:
*
*
{@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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
* ApiHubInstanceName name =
* ApiHubInstanceName.of("[PROJECT]", "[LOCATION]", "[API_HUB_INSTANCE]");
* ApiHubInstance response = provisioningClient.getApiHubInstance(name);
* }
* }
*
* ======================= RuntimeProjectAttachmentServiceClient =======================
*
*
Service Description: This service is used for managing the runtime project attachments.
*
*
Sample for RuntimeProjectAttachmentServiceClient:
*
*
{@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 (RuntimeProjectAttachmentServiceClient runtimeProjectAttachmentServiceClient =
* RuntimeProjectAttachmentServiceClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* RuntimeProjectAttachment runtimeProjectAttachment =
* RuntimeProjectAttachment.newBuilder().build();
* String runtimeProjectAttachmentId = "runtimeProjectAttachmentId-753213345";
* RuntimeProjectAttachment response =
* runtimeProjectAttachmentServiceClient.createRuntimeProjectAttachment(
* parent, runtimeProjectAttachment, runtimeProjectAttachmentId);
* }
* }
*/
@Generated("by gapic-generator-java")
package com.google.cloud.apihub.v1;
import javax.annotation.Generated;