- 0.48.0 (latest)
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.1
- 0.2.2
- 0.1.1
A client to Apigee Registry API
The interfaces provided are listed below, along with usage samples.
ProvisioningClient
Service Description: The service that is used for managing the data plane provisioning of the Registry.
Sample for ProvisioningClient:
// 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()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
Instance response = provisioningClient.getInstance(name);
}
RegistryClient
Service Description: The Registry service allows teams to manage descriptions of APIs.
Sample for RegistryClient:
// 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 (RegistryClient registryClient = RegistryClient.create()) {
ApiName name = ApiName.of("[PROJECT]", "[LOCATION]", "[API]");
Api response = registryClient.getApi(name);
}
Classes
Api
A top-level description of an API. Produced by producers and are commitments to provide services.
Protobuf type google.cloud.apigeeregistry.v1.Api
Api.Builder
A top-level description of an API. Produced by producers and are commitments to provide services.
Protobuf type google.cloud.apigeeregistry.v1.Api
ApiDeployment
Describes a service running at particular address that provides a particular version of an API. ApiDeployments have revisions which correspond to different configurations of a single deployment in time. Revision identifiers should be updated whenever the served API spec or endpoint address changes.
Protobuf type google.cloud.apigeeregistry.v1.ApiDeployment
ApiDeployment.Builder
Describes a service running at particular address that provides a particular version of an API. ApiDeployments have revisions which correspond to different configurations of a single deployment in time. Revision identifiers should be updated whenever the served API spec or endpoint address changes.
Protobuf type google.cloud.apigeeregistry.v1.ApiDeployment
ApiDeploymentName
ApiDeploymentName.Builder
Builder for projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}.
ApiName
ApiName.Builder
Builder for projects/{project}/locations/{location}/apis/{api}.
ApiSpec
Describes a version of an API in a structured way. ApiSpecs provide formal descriptions that consumers can use to use a version. ApiSpec resources are intended to be fully-resolved descriptions of an ApiVersion. When specs consist of multiple files, these should be bundled together (e.g., in a zip archive) and stored as a unit. Multiple specs can exist to provide representations in different API description formats. Synchronization of these representations would be provided by tooling and background services.
Protobuf type google.cloud.apigeeregistry.v1.ApiSpec
ApiSpec.Builder
Describes a version of an API in a structured way. ApiSpecs provide formal descriptions that consumers can use to use a version. ApiSpec resources are intended to be fully-resolved descriptions of an ApiVersion. When specs consist of multiple files, these should be bundled together (e.g., in a zip archive) and stored as a unit. Multiple specs can exist to provide representations in different API description formats. Synchronization of these representations would be provided by tooling and background services.
Protobuf type google.cloud.apigeeregistry.v1.ApiSpec
ApiSpecName
ApiSpecName.Builder
Builder for projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}.
ApiVersion
Describes a particular version of an API. ApiVersions are what consumers actually use.
Protobuf type google.cloud.apigeeregistry.v1.ApiVersion
ApiVersion.Builder
Describes a particular version of an API. ApiVersions are what consumers actually use.
Protobuf type google.cloud.apigeeregistry.v1.ApiVersion
ApiVersionName
ApiVersionName.Builder
Builder for projects/{project}/locations/{location}/apis/{api}/versions/{version}.
Artifact
Artifacts of resources. Artifacts are unique (single-value) per resource
and are used to store metadata that is too large or numerous to be stored
directly on the resource. Since artifacts are stored separately from parent
resources, they should generally be used for metadata that is needed
infrequently, i.e., not for display in primary views of the resource but
perhaps displayed or downloaded upon request. The ListArtifacts
method
allows artifacts to be quickly enumerated and checked for presence without
downloading their (potentially-large) contents.
Protobuf type google.cloud.apigeeregistry.v1.Artifact
Artifact.Builder
Artifacts of resources. Artifacts are unique (single-value) per resource
and are used to store metadata that is too large or numerous to be stored
directly on the resource. Since artifacts are stored separately from parent
resources, they should generally be used for metadata that is needed
infrequently, i.e., not for display in primary views of the resource but
perhaps displayed or downloaded upon request. The ListArtifacts
method
allows artifacts to be quickly enumerated and checked for presence without
downloading their (potentially-large) contents.
Protobuf type google.cloud.apigeeregistry.v1.Artifact
ArtifactName
ArtifactName.Builder
Builder for projects/{project}/locations/{location}/artifacts/{artifact}.
ArtifactName.ProjectLocationApiArtifactBuilder
Builder for projects/{project}/locations/{location}/apis/{api}/artifacts/{artifact}.
ArtifactName.ProjectLocationApiDeploymentArtifactBuilder
Builder for projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}/artifacts/{artifact}.
ArtifactName.ProjectLocationApiVersionArtifactBuilder
Builder for projects/{project}/locations/{location}/apis/{api}/versions/{version}/artifacts/{artifact}.
ArtifactName.ProjectLocationApiVersionSpecArtifactBuilder
Builder for projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}/artifacts/{artifact}.
CreateApiDeploymentRequest
Request message for CreateApiDeployment.
Protobuf type google.cloud.apigeeregistry.v1.CreateApiDeploymentRequest
CreateApiDeploymentRequest.Builder
Request message for CreateApiDeployment.
Protobuf type google.cloud.apigeeregistry.v1.CreateApiDeploymentRequest
CreateApiRequest
Request message for CreateApi.
Protobuf type google.cloud.apigeeregistry.v1.CreateApiRequest
CreateApiRequest.Builder
Request message for CreateApi.
Protobuf type google.cloud.apigeeregistry.v1.CreateApiRequest
CreateApiSpecRequest
Request message for CreateApiSpec.
Protobuf type google.cloud.apigeeregistry.v1.CreateApiSpecRequest
CreateApiSpecRequest.Builder
Request message for CreateApiSpec.
Protobuf type google.cloud.apigeeregistry.v1.CreateApiSpecRequest
CreateApiVersionRequest
Request message for CreateApiVersion.
Protobuf type google.cloud.apigeeregistry.v1.CreateApiVersionRequest
CreateApiVersionRequest.Builder
Request message for CreateApiVersion.
Protobuf type google.cloud.apigeeregistry.v1.CreateApiVersionRequest
CreateArtifactRequest
Request message for CreateArtifact.
Protobuf type google.cloud.apigeeregistry.v1.CreateArtifactRequest
CreateArtifactRequest.Builder
Request message for CreateArtifact.
Protobuf type google.cloud.apigeeregistry.v1.CreateArtifactRequest
CreateInstanceRequest
Request message for CreateInstance.
Protobuf type google.cloud.apigeeregistry.v1.CreateInstanceRequest
CreateInstanceRequest.Builder
Request message for CreateInstance.
Protobuf type google.cloud.apigeeregistry.v1.CreateInstanceRequest
DeleteApiDeploymentRequest
Request message for DeleteApiDeployment.
Protobuf type google.cloud.apigeeregistry.v1.DeleteApiDeploymentRequest
DeleteApiDeploymentRequest.Builder
Request message for DeleteApiDeployment.
Protobuf type google.cloud.apigeeregistry.v1.DeleteApiDeploymentRequest
DeleteApiDeploymentRevisionRequest
Request message for DeleteApiDeploymentRevision.
Protobuf type google.cloud.apigeeregistry.v1.DeleteApiDeploymentRevisionRequest
DeleteApiDeploymentRevisionRequest.Builder
Request message for DeleteApiDeploymentRevision.
Protobuf type google.cloud.apigeeregistry.v1.DeleteApiDeploymentRevisionRequest
DeleteApiRequest
Request message for DeleteApi.
Protobuf type google.cloud.apigeeregistry.v1.DeleteApiRequest
DeleteApiRequest.Builder
Request message for DeleteApi.
Protobuf type google.cloud.apigeeregistry.v1.DeleteApiRequest
DeleteApiSpecRequest
Request message for DeleteApiSpec.
Protobuf type google.cloud.apigeeregistry.v1.DeleteApiSpecRequest
DeleteApiSpecRequest.Builder
Request message for DeleteApiSpec.
Protobuf type google.cloud.apigeeregistry.v1.DeleteApiSpecRequest
DeleteApiSpecRevisionRequest
Request message for DeleteApiSpecRevision.
Protobuf type google.cloud.apigeeregistry.v1.DeleteApiSpecRevisionRequest
DeleteApiSpecRevisionRequest.Builder
Request message for DeleteApiSpecRevision.
Protobuf type google.cloud.apigeeregistry.v1.DeleteApiSpecRevisionRequest
DeleteApiVersionRequest
Request message for DeleteApiVersion.
Protobuf type google.cloud.apigeeregistry.v1.DeleteApiVersionRequest
DeleteApiVersionRequest.Builder
Request message for DeleteApiVersion.
Protobuf type google.cloud.apigeeregistry.v1.DeleteApiVersionRequest
DeleteArtifactRequest
Request message for DeleteArtifact.
Protobuf type google.cloud.apigeeregistry.v1.DeleteArtifactRequest
DeleteArtifactRequest.Builder
Request message for DeleteArtifact.
Protobuf type google.cloud.apigeeregistry.v1.DeleteArtifactRequest
DeleteInstanceRequest
Request message for DeleteInstance.
Protobuf type google.cloud.apigeeregistry.v1.DeleteInstanceRequest
DeleteInstanceRequest.Builder
Request message for DeleteInstance.
Protobuf type google.cloud.apigeeregistry.v1.DeleteInstanceRequest
GetApiDeploymentRequest
Request message for GetApiDeployment.
Protobuf type google.cloud.apigeeregistry.v1.GetApiDeploymentRequest
GetApiDeploymentRequest.Builder
Request message for GetApiDeployment.
Protobuf type google.cloud.apigeeregistry.v1.GetApiDeploymentRequest
GetApiRequest
Request message for GetApi.
Protobuf type google.cloud.apigeeregistry.v1.GetApiRequest
GetApiRequest.Builder
Request message for GetApi.
Protobuf type google.cloud.apigeeregistry.v1.GetApiRequest
GetApiSpecContentsRequest
Request message for GetApiSpecContents.
Protobuf type google.cloud.apigeeregistry.v1.GetApiSpecContentsRequest
GetApiSpecContentsRequest.Builder
Request message for GetApiSpecContents.
Protobuf type google.cloud.apigeeregistry.v1.GetApiSpecContentsRequest
GetApiSpecRequest
Request message for GetApiSpec.
Protobuf type google.cloud.apigeeregistry.v1.GetApiSpecRequest
GetApiSpecRequest.Builder
Request message for GetApiSpec.
Protobuf type google.cloud.apigeeregistry.v1.GetApiSpecRequest
GetApiVersionRequest
Request message for GetApiVersion.
Protobuf type google.cloud.apigeeregistry.v1.GetApiVersionRequest
GetApiVersionRequest.Builder
Request message for GetApiVersion.
Protobuf type google.cloud.apigeeregistry.v1.GetApiVersionRequest
GetArtifactContentsRequest
Request message for GetArtifactContents.
Protobuf type google.cloud.apigeeregistry.v1.GetArtifactContentsRequest
GetArtifactContentsRequest.Builder
Request message for GetArtifactContents.
Protobuf type google.cloud.apigeeregistry.v1.GetArtifactContentsRequest
GetArtifactRequest
Request message for GetArtifact.
Protobuf type google.cloud.apigeeregistry.v1.GetArtifactRequest
GetArtifactRequest.Builder
Request message for GetArtifact.
Protobuf type google.cloud.apigeeregistry.v1.GetArtifactRequest
GetInstanceRequest
Request message for GetInstance.
Protobuf type google.cloud.apigeeregistry.v1.GetInstanceRequest
GetInstanceRequest.Builder
Request message for GetInstance.
Protobuf type google.cloud.apigeeregistry.v1.GetInstanceRequest
Instance
An Instance represents the instance resources of the Registry. Currently, only one instance is allowed for each project.
Protobuf type google.cloud.apigeeregistry.v1.Instance
Instance.Builder
An Instance represents the instance resources of the Registry. Currently, only one instance is allowed for each project.
Protobuf type google.cloud.apigeeregistry.v1.Instance
Instance.Config
Available configurations to provision an Instance.
Protobuf type google.cloud.apigeeregistry.v1.Instance.Config
Instance.Config.Builder
Available configurations to provision an Instance.
Protobuf type google.cloud.apigeeregistry.v1.Instance.Config
InstanceName
InstanceName.Builder
Builder for projects/{project}/locations/{location}/instances/{instance}.
ListApiDeploymentRevisionsRequest
Request message for ListApiDeploymentRevisions.
Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentRevisionsRequest
ListApiDeploymentRevisionsRequest.Builder
Request message for ListApiDeploymentRevisions.
Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentRevisionsRequest
ListApiDeploymentRevisionsResponse
Response message for ListApiDeploymentRevisionsResponse.
Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentRevisionsResponse
ListApiDeploymentRevisionsResponse.Builder
Response message for ListApiDeploymentRevisionsResponse.
Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentRevisionsResponse
ListApiDeploymentsRequest
Request message for ListApiDeployments.
Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentsRequest
ListApiDeploymentsRequest.Builder
Request message for ListApiDeployments.
Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentsRequest
ListApiDeploymentsResponse
Response message for ListApiDeployments.
Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentsResponse
ListApiDeploymentsResponse.Builder
Response message for ListApiDeployments.
Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentsResponse
ListApiSpecRevisionsRequest
Request message for ListApiSpecRevisions.
Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecRevisionsRequest
ListApiSpecRevisionsRequest.Builder
Request message for ListApiSpecRevisions.
Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecRevisionsRequest
ListApiSpecRevisionsResponse
Response message for ListApiSpecRevisionsResponse.
Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecRevisionsResponse
ListApiSpecRevisionsResponse.Builder
Response message for ListApiSpecRevisionsResponse.
Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecRevisionsResponse
ListApiSpecsRequest
Request message for ListApiSpecs.
Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecsRequest
ListApiSpecsRequest.Builder
Request message for ListApiSpecs.
Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecsRequest
ListApiSpecsResponse
Response message for ListApiSpecs.
Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecsResponse
ListApiSpecsResponse.Builder
Response message for ListApiSpecs.
Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecsResponse
ListApiVersionsRequest
Request message for ListApiVersions.
Protobuf type google.cloud.apigeeregistry.v1.ListApiVersionsRequest
ListApiVersionsRequest.Builder
Request message for ListApiVersions.
Protobuf type google.cloud.apigeeregistry.v1.ListApiVersionsRequest
ListApiVersionsResponse
Response message for ListApiVersions.
Protobuf type google.cloud.apigeeregistry.v1.ListApiVersionsResponse
ListApiVersionsResponse.Builder
Response message for ListApiVersions.
Protobuf type google.cloud.apigeeregistry.v1.ListApiVersionsResponse
ListApisRequest
Request message for ListApis.
Protobuf type google.cloud.apigeeregistry.v1.ListApisRequest
ListApisRequest.Builder
Request message for ListApis.
Protobuf type google.cloud.apigeeregistry.v1.ListApisRequest
ListApisResponse
Response message for ListApis.
Protobuf type google.cloud.apigeeregistry.v1.ListApisResponse
ListApisResponse.Builder
Response message for ListApis.
Protobuf type google.cloud.apigeeregistry.v1.ListApisResponse
ListArtifactsRequest
Request message for ListArtifacts.
Protobuf type google.cloud.apigeeregistry.v1.ListArtifactsRequest
ListArtifactsRequest.Builder
Request message for ListArtifacts.
Protobuf type google.cloud.apigeeregistry.v1.ListArtifactsRequest
ListArtifactsResponse
Response message for ListArtifacts.
Protobuf type google.cloud.apigeeregistry.v1.ListArtifactsResponse
ListArtifactsResponse.Builder
Response message for ListArtifacts.
Protobuf type google.cloud.apigeeregistry.v1.ListArtifactsResponse
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
OperationMetadata
Represents the metadata of the long-running operation.
Protobuf type google.cloud.apigeeregistry.v1.OperationMetadata
OperationMetadata.Builder
Represents the metadata of the long-running operation.
Protobuf type google.cloud.apigeeregistry.v1.OperationMetadata
ProvisioningClient
Service Description: The service that is used for managing the data plane provisioning of the Registry.
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 (ProvisioningClient provisioningClient = ProvisioningClient.create()) {
InstanceName name = InstanceName.of("[PROJECT]", "[LOCATION]", "[INSTANCE]");
Instance response = provisioningClient.getInstance(name);
}
Note: close() needs to be called on the ProvisioningClient 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:
- 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.
- 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.
- 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 ProvisioningSettings 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
ProvisioningSettings provisioningSettings =
ProvisioningSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ProvisioningClient provisioningClient = ProvisioningClient.create(provisioningSettings);
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
ProvisioningSettings provisioningSettings =
ProvisioningSettings.newBuilder().setEndpoint(myEndpoint).build();
ProvisioningClient provisioningClient = ProvisioningClient.create(provisioningSettings);
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
ProvisioningSettings provisioningSettings = ProvisioningSettings.newHttpJsonBuilder().build();
ProvisioningClient provisioningClient = ProvisioningClient.create(provisioningSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
ProvisioningClient.ListLocationsFixedSizeCollection
ProvisioningClient.ListLocationsPage
ProvisioningClient.ListLocationsPagedResponse
ProvisioningGrpc
The service that is used for managing the data plane provisioning of the Registry.
ProvisioningGrpc.ProvisioningBlockingStub
A stub to allow clients to do synchronous rpc calls to service Provisioning.
The service that is used for managing the data plane provisioning of the Registry.
ProvisioningGrpc.ProvisioningFutureStub
A stub to allow clients to do ListenableFuture-style rpc calls to service Provisioning.
The service that is used for managing the data plane provisioning of the Registry.
ProvisioningGrpc.ProvisioningImplBase
Base class for the server implementation of the service Provisioning.
The service that is used for managing the data plane provisioning of the Registry.
ProvisioningGrpc.ProvisioningStub
A stub to allow clients to do asynchronous rpc calls to service Provisioning.
The service that is used for managing the data plane provisioning of the Registry.
ProvisioningServiceProto
ProvisioningSettings
Settings class to configure an instance of ProvisioningClient.
The default instance has everything set to sensible defaults:
- The default service address (apigeeregistry.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 getInstance 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
ProvisioningSettings.Builder provisioningSettingsBuilder = ProvisioningSettings.newBuilder();
provisioningSettingsBuilder
.getInstanceSettings()
.setRetrySettings(
provisioningSettingsBuilder
.getInstanceSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
ProvisioningSettings provisioningSettings = provisioningSettingsBuilder.build();
ProvisioningSettings.Builder
Builder for ProvisioningSettings.
RegistryClient
Service Description: The Registry service allows teams to manage descriptions of APIs.
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 (RegistryClient registryClient = RegistryClient.create()) {
ApiName name = ApiName.of("[PROJECT]", "[LOCATION]", "[API]");
Api response = registryClient.getApi(name);
}
Note: close() needs to be called on the RegistryClient 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:
- 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.
- 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.
- 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 RegistrySettings 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
RegistrySettings registrySettings =
RegistrySettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
RegistryClient registryClient = RegistryClient.create(registrySettings);
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
RegistrySettings registrySettings =
RegistrySettings.newBuilder().setEndpoint(myEndpoint).build();
RegistryClient registryClient = RegistryClient.create(registrySettings);
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
RegistrySettings registrySettings = RegistrySettings.newHttpJsonBuilder().build();
RegistryClient registryClient = RegistryClient.create(registrySettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
RegistryClient.ListApiDeploymentRevisionsFixedSizeCollection
RegistryClient.ListApiDeploymentRevisionsPage
RegistryClient.ListApiDeploymentRevisionsPagedResponse
RegistryClient.ListApiDeploymentsFixedSizeCollection
RegistryClient.ListApiDeploymentsPage
RegistryClient.ListApiDeploymentsPagedResponse
RegistryClient.ListApiSpecRevisionsFixedSizeCollection
RegistryClient.ListApiSpecRevisionsPage
RegistryClient.ListApiSpecRevisionsPagedResponse
RegistryClient.ListApiSpecsFixedSizeCollection
RegistryClient.ListApiSpecsPage
RegistryClient.ListApiSpecsPagedResponse
RegistryClient.ListApiVersionsFixedSizeCollection
RegistryClient.ListApiVersionsPage
RegistryClient.ListApiVersionsPagedResponse
RegistryClient.ListApisFixedSizeCollection
RegistryClient.ListApisPage
RegistryClient.ListApisPagedResponse
RegistryClient.ListArtifactsFixedSizeCollection
RegistryClient.ListArtifactsPage
RegistryClient.ListArtifactsPagedResponse
RegistryClient.ListLocationsFixedSizeCollection
RegistryClient.ListLocationsPage
RegistryClient.ListLocationsPagedResponse
RegistryGrpc
The Registry service allows teams to manage descriptions of APIs.
RegistryGrpc.RegistryBlockingStub
A stub to allow clients to do synchronous rpc calls to service Registry.
The Registry service allows teams to manage descriptions of APIs.
RegistryGrpc.RegistryFutureStub
A stub to allow clients to do ListenableFuture-style rpc calls to service Registry.
The Registry service allows teams to manage descriptions of APIs.
RegistryGrpc.RegistryImplBase
Base class for the server implementation of the service Registry.
The Registry service allows teams to manage descriptions of APIs.
RegistryGrpc.RegistryStub
A stub to allow clients to do asynchronous rpc calls to service Registry.
The Registry service allows teams to manage descriptions of APIs.
RegistryModelsProto
RegistryServiceProto
RegistrySettings
Settings class to configure an instance of RegistryClient.
The default instance has everything set to sensible defaults:
- The default service address (apigeeregistry.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 getApi 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
RegistrySettings.Builder registrySettingsBuilder = RegistrySettings.newBuilder();
registrySettingsBuilder
.getApiSettings()
.setRetrySettings(
registrySettingsBuilder
.getApiSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
RegistrySettings registrySettings = registrySettingsBuilder.build();
RegistrySettings.Builder
Builder for RegistrySettings.
ReplaceArtifactRequest
Request message for ReplaceArtifact.
Protobuf type google.cloud.apigeeregistry.v1.ReplaceArtifactRequest
ReplaceArtifactRequest.Builder
Request message for ReplaceArtifact.
Protobuf type google.cloud.apigeeregistry.v1.ReplaceArtifactRequest
RollbackApiDeploymentRequest
Request message for RollbackApiDeployment.
Protobuf type google.cloud.apigeeregistry.v1.RollbackApiDeploymentRequest
RollbackApiDeploymentRequest.Builder
Request message for RollbackApiDeployment.
Protobuf type google.cloud.apigeeregistry.v1.RollbackApiDeploymentRequest
RollbackApiSpecRequest
Request message for RollbackApiSpec.
Protobuf type google.cloud.apigeeregistry.v1.RollbackApiSpecRequest
RollbackApiSpecRequest.Builder
Request message for RollbackApiSpec.
Protobuf type google.cloud.apigeeregistry.v1.RollbackApiSpecRequest
TagApiDeploymentRevisionRequest
Request message for TagApiDeploymentRevision.
Protobuf type google.cloud.apigeeregistry.v1.TagApiDeploymentRevisionRequest
TagApiDeploymentRevisionRequest.Builder
Request message for TagApiDeploymentRevision.
Protobuf type google.cloud.apigeeregistry.v1.TagApiDeploymentRevisionRequest
TagApiSpecRevisionRequest
Request message for TagApiSpecRevision.
Protobuf type google.cloud.apigeeregistry.v1.TagApiSpecRevisionRequest
TagApiSpecRevisionRequest.Builder
Request message for TagApiSpecRevision.
Protobuf type google.cloud.apigeeregistry.v1.TagApiSpecRevisionRequest
UpdateApiDeploymentRequest
Request message for UpdateApiDeployment.
Protobuf type google.cloud.apigeeregistry.v1.UpdateApiDeploymentRequest
UpdateApiDeploymentRequest.Builder
Request message for UpdateApiDeployment.
Protobuf type google.cloud.apigeeregistry.v1.UpdateApiDeploymentRequest
UpdateApiRequest
Request message for UpdateApi.
Protobuf type google.cloud.apigeeregistry.v1.UpdateApiRequest
UpdateApiRequest.Builder
Request message for UpdateApi.
Protobuf type google.cloud.apigeeregistry.v1.UpdateApiRequest
UpdateApiSpecRequest
Request message for UpdateApiSpec.
Protobuf type google.cloud.apigeeregistry.v1.UpdateApiSpecRequest
UpdateApiSpecRequest.Builder
Request message for UpdateApiSpec.
Protobuf type google.cloud.apigeeregistry.v1.UpdateApiSpecRequest
UpdateApiVersionRequest
Request message for UpdateApiVersion.
Protobuf type google.cloud.apigeeregistry.v1.UpdateApiVersionRequest
UpdateApiVersionRequest.Builder
Request message for UpdateApiVersion.
Protobuf type google.cloud.apigeeregistry.v1.UpdateApiVersionRequest
Interfaces
ApiDeploymentOrBuilder
ApiOrBuilder
ApiSpecOrBuilder
ApiVersionOrBuilder
ArtifactOrBuilder
CreateApiDeploymentRequestOrBuilder
CreateApiRequestOrBuilder
CreateApiSpecRequestOrBuilder
CreateApiVersionRequestOrBuilder
CreateArtifactRequestOrBuilder
CreateInstanceRequestOrBuilder
DeleteApiDeploymentRequestOrBuilder
DeleteApiDeploymentRevisionRequestOrBuilder
DeleteApiRequestOrBuilder
DeleteApiSpecRequestOrBuilder
DeleteApiSpecRevisionRequestOrBuilder
DeleteApiVersionRequestOrBuilder
DeleteArtifactRequestOrBuilder
DeleteInstanceRequestOrBuilder
GetApiDeploymentRequestOrBuilder
GetApiRequestOrBuilder
GetApiSpecContentsRequestOrBuilder
GetApiSpecRequestOrBuilder
GetApiVersionRequestOrBuilder
GetArtifactContentsRequestOrBuilder
GetArtifactRequestOrBuilder
GetInstanceRequestOrBuilder
Instance.ConfigOrBuilder
InstanceOrBuilder
ListApiDeploymentRevisionsRequestOrBuilder
ListApiDeploymentRevisionsResponseOrBuilder
ListApiDeploymentsRequestOrBuilder
ListApiDeploymentsResponseOrBuilder
ListApiSpecRevisionsRequestOrBuilder
ListApiSpecRevisionsResponseOrBuilder
ListApiSpecsRequestOrBuilder
ListApiSpecsResponseOrBuilder
ListApiVersionsRequestOrBuilder
ListApiVersionsResponseOrBuilder
ListApisRequestOrBuilder
ListApisResponseOrBuilder
ListArtifactsRequestOrBuilder
ListArtifactsResponseOrBuilder
OperationMetadataOrBuilder
ProvisioningGrpc.AsyncService
The service that is used for managing the data plane provisioning of the Registry.
RegistryGrpc.AsyncService
The Registry service allows teams to manage descriptions of APIs.
ReplaceArtifactRequestOrBuilder
RollbackApiDeploymentRequestOrBuilder
RollbackApiSpecRequestOrBuilder
TagApiDeploymentRevisionRequestOrBuilder
TagApiSpecRevisionRequestOrBuilder
UpdateApiDeploymentRequestOrBuilder
UpdateApiRequestOrBuilder
UpdateApiSpecRequestOrBuilder
UpdateApiVersionRequestOrBuilder
Enums
Instance.State
State of the Instance.
Protobuf enum google.cloud.apigeeregistry.v1.Instance.State