Package com.google.cloud.apigeeregistry.v1 (0.2.2)

An Api is a top-level description of an API. Apis are produced by producers and are commitments to provide services.

Protobuf type google.cloud.apigeeregistry.v1.Api

An Api is a top-level description of an API. Apis are produced by producers and are commitments to provide services.

Protobuf type google.cloud.apigeeregistry.v1.Api

An 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

An 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

Builder for projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}.

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

An 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

An 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

Builder for projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}.

An ApiVersion describes a particular version of an API. ApiVersions are what consumers actually use.

Protobuf type google.cloud.apigeeregistry.v1.ApiVersion

An ApiVersion describes a particular version of an API. ApiVersions are what consumers actually use.

Protobuf type google.cloud.apigeeregistry.v1.ApiVersion

Builder for projects/{project}/locations/{location}/apis/{api}/versions/{version}.

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

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

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

Builder for projects/{project}/locations/{location}/apis/{api}/artifacts/{artifact}.

Builder for projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}/artifacts/{artifact}.

Builder for projects/{project}/locations/{location}/apis/{api}/versions/{version}/artifacts/{artifact}.

Builder for projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}/artifacts/{artifact}.

Request message for CreateApiDeployment.

Protobuf type google.cloud.apigeeregistry.v1.CreateApiDeploymentRequest

Request message for CreateApiDeployment.

Protobuf type google.cloud.apigeeregistry.v1.CreateApiDeploymentRequest

Request message for CreateApi.

Protobuf type google.cloud.apigeeregistry.v1.CreateApiRequest

Request message for CreateApi.

Protobuf type google.cloud.apigeeregistry.v1.CreateApiRequest

Request message for CreateApiSpec.

Protobuf type google.cloud.apigeeregistry.v1.CreateApiSpecRequest

Request message for CreateApiSpec.

Protobuf type google.cloud.apigeeregistry.v1.CreateApiSpecRequest

Request message for CreateApiVersion.

Protobuf type google.cloud.apigeeregistry.v1.CreateApiVersionRequest

Request message for CreateApiVersion.

Protobuf type google.cloud.apigeeregistry.v1.CreateApiVersionRequest

Request message for CreateArtifact.

Protobuf type google.cloud.apigeeregistry.v1.CreateArtifactRequest

Request message for CreateArtifact.

Protobuf type google.cloud.apigeeregistry.v1.CreateArtifactRequest

Request message for CreateInstance.

Protobuf type google.cloud.apigeeregistry.v1.CreateInstanceRequest

Request message for CreateInstance.

Protobuf type google.cloud.apigeeregistry.v1.CreateInstanceRequest

Request message for DeleteApiDeployment.

Protobuf type google.cloud.apigeeregistry.v1.DeleteApiDeploymentRequest

Request message for DeleteApiDeployment.

Protobuf type google.cloud.apigeeregistry.v1.DeleteApiDeploymentRequest

Request message for DeleteApiDeploymentRevision.

Protobuf type google.cloud.apigeeregistry.v1.DeleteApiDeploymentRevisionRequest

Request message for DeleteApiDeploymentRevision.

Protobuf type google.cloud.apigeeregistry.v1.DeleteApiDeploymentRevisionRequest

Request message for DeleteApi.

Protobuf type google.cloud.apigeeregistry.v1.DeleteApiRequest

Request message for DeleteApi.

Protobuf type google.cloud.apigeeregistry.v1.DeleteApiRequest

Request message for DeleteApiSpec.

Protobuf type google.cloud.apigeeregistry.v1.DeleteApiSpecRequest

Request message for DeleteApiSpec.

Protobuf type google.cloud.apigeeregistry.v1.DeleteApiSpecRequest

Request message for DeleteApiSpecRevision.

Protobuf type google.cloud.apigeeregistry.v1.DeleteApiSpecRevisionRequest

Request message for DeleteApiSpecRevision.

Protobuf type google.cloud.apigeeregistry.v1.DeleteApiSpecRevisionRequest

Request message for DeleteApiVersion.

Protobuf type google.cloud.apigeeregistry.v1.DeleteApiVersionRequest

Request message for DeleteApiVersion.

Protobuf type google.cloud.apigeeregistry.v1.DeleteApiVersionRequest

Request message for DeleteArtifact.

Protobuf type google.cloud.apigeeregistry.v1.DeleteArtifactRequest

Request message for DeleteArtifact.

Protobuf type google.cloud.apigeeregistry.v1.DeleteArtifactRequest

Request message for DeleteInstance.

Protobuf type google.cloud.apigeeregistry.v1.DeleteInstanceRequest

Request message for DeleteInstance.

Protobuf type google.cloud.apigeeregistry.v1.DeleteInstanceRequest

Request message for GetApiDeployment.

Protobuf type google.cloud.apigeeregistry.v1.GetApiDeploymentRequest

Request message for GetApiDeployment.

Protobuf type google.cloud.apigeeregistry.v1.GetApiDeploymentRequest

Request message for GetApi.

Protobuf type google.cloud.apigeeregistry.v1.GetApiRequest

Request message for GetApi.

Protobuf type google.cloud.apigeeregistry.v1.GetApiRequest

Request message for GetApiSpecContents.

Protobuf type google.cloud.apigeeregistry.v1.GetApiSpecContentsRequest

Request message for GetApiSpecContents.

Protobuf type google.cloud.apigeeregistry.v1.GetApiSpecContentsRequest

Request message for GetApiSpec.

Protobuf type google.cloud.apigeeregistry.v1.GetApiSpecRequest

Request message for GetApiSpec.

Protobuf type google.cloud.apigeeregistry.v1.GetApiSpecRequest

Request message for GetApiVersion.

Protobuf type google.cloud.apigeeregistry.v1.GetApiVersionRequest

Request message for GetApiVersion.

Protobuf type google.cloud.apigeeregistry.v1.GetApiVersionRequest

Request message for GetArtifactContents.

Protobuf type google.cloud.apigeeregistry.v1.GetArtifactContentsRequest

Request message for GetArtifactContents.

Protobuf type google.cloud.apigeeregistry.v1.GetArtifactContentsRequest

Request message for GetArtifact.

Protobuf type google.cloud.apigeeregistry.v1.GetArtifactRequest

Request message for GetArtifact.

Protobuf type google.cloud.apigeeregistry.v1.GetArtifactRequest

Request message for GetInstance.

Protobuf type google.cloud.apigeeregistry.v1.GetInstanceRequest

Request message for GetInstance.

Protobuf type google.cloud.apigeeregistry.v1.GetInstanceRequest

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

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

Available configurations to provision an Instance.

Protobuf type google.cloud.apigeeregistry.v1.Instance.Config

Available configurations to provision an Instance.

Protobuf type google.cloud.apigeeregistry.v1.Instance.Config

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

Request message for ListApiDeploymentRevisions.

Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentRevisionsRequest

Request message for ListApiDeploymentRevisions.

Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentRevisionsRequest

Response message for ListApiDeploymentRevisionsResponse.

Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentRevisionsResponse

Response message for ListApiDeploymentRevisionsResponse.

Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentRevisionsResponse

Request message for ListApiDeployments.

Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentsRequest

Request message for ListApiDeployments.

Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentsRequest

Response message for ListApiDeployments.

Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentsResponse

Response message for ListApiDeployments.

Protobuf type google.cloud.apigeeregistry.v1.ListApiDeploymentsResponse

Request message for ListApiSpecRevisions.

Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecRevisionsRequest

Request message for ListApiSpecRevisions.

Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecRevisionsRequest

Response message for ListApiSpecRevisionsResponse.

Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecRevisionsResponse

Response message for ListApiSpecRevisionsResponse.

Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecRevisionsResponse

Request message for ListApiSpecs.

Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecsRequest

Request message for ListApiSpecs.

Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecsRequest

Response message for ListApiSpecs.

Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecsResponse

Response message for ListApiSpecs.

Protobuf type google.cloud.apigeeregistry.v1.ListApiSpecsResponse

Request message for ListApiVersions.

Protobuf type google.cloud.apigeeregistry.v1.ListApiVersionsRequest

Request message for ListApiVersions.

Protobuf type google.cloud.apigeeregistry.v1.ListApiVersionsRequest

Response message for ListApiVersions.

Protobuf type google.cloud.apigeeregistry.v1.ListApiVersionsResponse

Response message for ListApiVersions.

Protobuf type google.cloud.apigeeregistry.v1.ListApiVersionsResponse

Request message for ListApis.

Protobuf type google.cloud.apigeeregistry.v1.ListApisRequest

Request message for ListApis.

Protobuf type google.cloud.apigeeregistry.v1.ListApisRequest

Response message for ListApis.

Protobuf type google.cloud.apigeeregistry.v1.ListApisResponse

Response message for ListApis.

Protobuf type google.cloud.apigeeregistry.v1.ListApisResponse

Request message for ListArtifacts.

Protobuf type google.cloud.apigeeregistry.v1.ListArtifactsRequest

Request message for ListArtifacts.

Protobuf type google.cloud.apigeeregistry.v1.ListArtifactsRequest

Response message for ListArtifacts.

Protobuf type google.cloud.apigeeregistry.v1.ListArtifactsResponse

Response message for ListArtifacts.

Protobuf type google.cloud.apigeeregistry.v1.ListArtifactsResponse

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

Represents the metadata of the long-running operation.

Protobuf type google.cloud.apigeeregistry.v1.OperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.apigeeregistry.v1.OperationMetadata

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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:

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 ProvisioningSettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ProvisioningSettings provisioningSettings =
     ProvisioningSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ProvisioningClient provisioningClient = ProvisioningClient.create(provisioningSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 ProvisioningSettings provisioningSettings =
     ProvisioningSettings.newBuilder()
         .setTransportChannelProvider(
             ProvisioningSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 ProvisioningClient provisioningClient = ProvisioningClient.create(provisioningSettings);
 

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

The service that is used for managing the data plane provisioning of the Registry.

The service that is used for managing the data plane provisioning of the Registry.

The service that is used for managing the data plane provisioning of the Registry.

The service that is used for managing the data plane provisioning of the Registry.

The service that is used for managing the data plane provisioning of the Registry.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 ProvisioningSettings.Builder provisioningSettingsBuilder = ProvisioningSettings.newBuilder();
 provisioningSettingsBuilder
     .getInstanceSettings()
     .setRetrySettings(
         provisioningSettingsBuilder
             .getInstanceSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ProvisioningSettings provisioningSettings = provisioningSettingsBuilder.build();
 

Builder for ProvisioningSettings.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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:

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 RegistrySettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 RegistrySettings registrySettings =
     RegistrySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 RegistryClient registryClient = RegistryClient.create(registrySettings);
 

To customize the endpoint:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 RegistrySettings registrySettings =
     RegistrySettings.newBuilder()
         .setTransportChannelProvider(
             RegistrySettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 RegistryClient registryClient = RegistryClient.create(registrySettings);
 

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

The Registry service allows teams to manage descriptions of APIs.

The Registry service allows teams to manage descriptions of APIs.

The Registry service allows teams to manage descriptions of APIs.

The Registry service allows teams to manage descriptions of APIs.

The Registry service allows teams to manage descriptions of APIs.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 RegistrySettings.Builder registrySettingsBuilder = RegistrySettings.newBuilder();
 registrySettingsBuilder
     .getApiSettings()
     .setRetrySettings(
         registrySettingsBuilder
             .getApiSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 RegistrySettings registrySettings = registrySettingsBuilder.build();
 

Builder for RegistrySettings.

Request message for ReplaceArtifact.

Protobuf type google.cloud.apigeeregistry.v1.ReplaceArtifactRequest

Request message for ReplaceArtifact.

Protobuf type google.cloud.apigeeregistry.v1.ReplaceArtifactRequest

Request message for RollbackApiDeployment.

Protobuf type google.cloud.apigeeregistry.v1.RollbackApiDeploymentRequest

Request message for RollbackApiDeployment.

Protobuf type google.cloud.apigeeregistry.v1.RollbackApiDeploymentRequest

Request message for RollbackApiSpec.

Protobuf type google.cloud.apigeeregistry.v1.RollbackApiSpecRequest

Request message for RollbackApiSpec.

Protobuf type google.cloud.apigeeregistry.v1.RollbackApiSpecRequest

Request message for TagApiDeploymentRevision.

Protobuf type google.cloud.apigeeregistry.v1.TagApiDeploymentRevisionRequest

Request message for TagApiDeploymentRevision.

Protobuf type google.cloud.apigeeregistry.v1.TagApiDeploymentRevisionRequest

Request message for TagApiSpecRevision.

Protobuf type google.cloud.apigeeregistry.v1.TagApiSpecRevisionRequest

Request message for TagApiSpecRevision.

Protobuf type google.cloud.apigeeregistry.v1.TagApiSpecRevisionRequest

Request message for UpdateApiDeployment.

Protobuf type google.cloud.apigeeregistry.v1.UpdateApiDeploymentRequest

Request message for UpdateApiDeployment.

Protobuf type google.cloud.apigeeregistry.v1.UpdateApiDeploymentRequest

Request message for UpdateApi.

Protobuf type google.cloud.apigeeregistry.v1.UpdateApiRequest

Request message for UpdateApi.

Protobuf type google.cloud.apigeeregistry.v1.UpdateApiRequest

Request message for UpdateApiSpec.

Protobuf type google.cloud.apigeeregistry.v1.UpdateApiSpecRequest

Request message for UpdateApiSpec.

Protobuf type google.cloud.apigeeregistry.v1.UpdateApiSpecRequest

Request message for UpdateApiVersion.

Protobuf type google.cloud.apigeeregistry.v1.UpdateApiVersionRequest

Request message for UpdateApiVersion.

Protobuf type google.cloud.apigeeregistry.v1.UpdateApiVersionRequest

State of the Instance.

Protobuf enum google.cloud.apigeeregistry.v1.Instance.State