Index
ApiHub(interface)ApiHubCollect(interface)ApiHubCurate(interface)ApiHubDependencies(interface)ApiHubInternal(interface)ApiHubPlugin(interface)HostProjectRegistrationService(interface)InsightsInternal(interface)LintingService(interface)Provisioning(interface)RuntimeProjectAttachmentService(interface)APIMetadata(message)ActionExecutionDetail(message)Api(message)ApiData(message)ApiHubInstance(message)ApiHubInstance.Config(message)ApiHubInstance.Config.EncryptionType(enum)ApiHubInstance.State(enum)ApiHubResource(message)ApiMetadataList(message)ApiOperation(message)ApplicationIntegrationEndpointDetails(message)Attribute(message)Attribute.AllowedValue(message)Attribute.DataType(enum)Attribute.DefinitionType(enum)Attribute.Scope(enum)AttributeValues(message)AttributeValues.EnumAttributeValues(message)AttributeValues.StringAttributeValues(message)AuthConfig(message)AuthConfig.ApiKeyConfig(message)AuthConfig.ApiKeyConfig.HttpElementLocation(enum)AuthConfig.Oauth2ClientCredentialsConfig(message)AuthConfig.UserPasswordConfig(message)AuthType(enum)CollectApiDataRequest(message)CollectApiDataResponse(message)CollectionType(enum)ConfigValueOption(message)ConfigVariable(message)ConfigVariable.MultiIntValues(message)ConfigVariable.MultiSelectValues(message)ConfigVariable.MultiStringValues(message)ConfigVariableTemplate(message)ConfigVariableTemplate.ValueType(enum)CreateApiHubInstanceRequest(message)CreateApiOperationRequest(message)CreateApiRequest(message)CreateAttributeRequest(message)CreateCurationRequest(message)CreateDependencyRequest(message)CreateDeploymentRequest(message)CreateExternalApiRequest(message)CreateHostProjectRegistrationRequest(message)CreatePluginInstanceRequest(message)CreatePluginRequest(message)CreateRuntimeProjectAttachmentRequest(message)CreateSpecRequest(message)CreateVersionRequest(message)Curation(message)Curation.ErrorCode(enum)Curation.LastExecutionState(enum)Curation.PluginInstanceActionID(message)CurationConfig(message)CurationConfig.CustomCuration(message)CurationType(enum)Definition(message)Definition.Type(enum)DeleteApiHubInstanceRequest(message)DeleteApiOperationRequest(message)DeleteApiRequest(message)DeleteAttributeRequest(message)DeleteCurationRequest(message)DeleteDependencyRequest(message)DeleteDeploymentRequest(message)DeleteExternalApiRequest(message)DeletePluginInstanceRequest(message)DeletePluginRequest(message)DeleteRuntimeProjectAttachmentRequest(message)DeleteSpecRequest(message)DeleteVersionRequest(message)Dependency(message)Dependency.DiscoveryMode(enum)Dependency.State(enum)DependencyEntityReference(message)DependencyErrorDetail(message)DependencyErrorDetail.Error(enum)Deployment(message)DeploymentMetadata(message)DisablePluginInstanceActionRequest(message)DisablePluginInstanceActionResponse(message)DisablePluginRequest(message)Documentation(message)EnablePluginInstanceActionRequest(message)EnablePluginInstanceActionResponse(message)EnablePluginRequest(message)Endpoint(message)ExecutePluginInstanceActionRequest(message)ExecutePluginInstanceActionResponse(message)ExecutionStatus(message)ExecutionStatus.CurrentExecutionState(enum)ExecutionStatus.LastExecution(message)ExecutionStatus.LastExecution.Result(enum)ExtendedApi(message)ExternalApi(message)GetApiHubInstanceRequest(message)GetApiOperationRequest(message)GetApiRequest(message)GetAttributeRequest(message)GetCurationRequest(message)GetDefinitionRequest(message)GetDependencyRequest(message)GetDeploymentRequest(message)GetExternalApiRequest(message)GetHostProjectRegistrationRequest(message)GetPluginInstanceRequest(message)GetPluginRequest(message)GetRuntimeProjectAttachmentRequest(message)GetSpecContentsRequest(message)GetSpecRequest(message)GetStyleGuideContentsRequest(message)GetStyleGuideRequest(message)GetVersionRequest(message)GoogleServiceAccountConfig(message)HostProjectRegistration(message)HttpOperation(message)HttpOperation.Method(enum)InsightsMetric(message)InsightsMetric.AggregationFunction(enum)Issue(message)LintResponse(message)LintResponse.SummaryEntry(message)LintSpecRequest(message)LintState(enum)Linter(enum)ListApiOperationsRequest(message)ListApiOperationsResponse(message)ListApisRequest(message)ListApisResponse(message)ListAttributesRequest(message)ListAttributesResponse(message)ListCurationsRequest(message)ListCurationsResponse(message)ListDependenciesRequest(message)ListDependenciesResponse(message)ListDeploymentsRequest(message)ListDeploymentsResponse(message)ListExternalApisRequest(message)ListExternalApisResponse(message)ListHostProjectRegistrationsRequest(message)ListHostProjectRegistrationsResponse(message)ListPluginInstancesRequest(message)ListPluginInstancesResponse(message)ListPluginsRequest(message)ListPluginsResponse(message)ListRuntimeProjectAttachmentsRequest(message)ListRuntimeProjectAttachmentsResponse(message)ListSpecsRequest(message)ListSpecsResponse(message)ListVersionsRequest(message)ListVersionsResponse(message)LookupApiHubInstanceRequest(message)LookupApiHubInstanceResponse(message)LookupRuntimeProjectAttachmentRequest(message)LookupRuntimeProjectAttachmentResponse(message)OpenApiSpecDetails(message)OpenApiSpecDetails.Format(enum)OperationDetails(message)OperationMetadata(message)Owner(message)Path(message)Plugin(message)Plugin.ConfigTemplate(message)Plugin.ConfigTemplate.AuthConfigTemplate(message)Plugin.HostingService(message)Plugin.OwnershipType(enum)Plugin.State(enum)PluginActionConfig(message)PluginActionConfig.TriggerMode(enum)PluginCategory(enum)PluginInstance(message)PluginInstance.State(enum)PluginInstanceAction(message)PluginInstanceAction.State(enum)Point(message)Range(message)RuntimeProjectAttachment(message)Schema(message)SearchResourcesRequest(message)SearchResourcesResponse(message)SearchResult(message)Secret(message)Severity(enum)SourceMetadata(message)SourceMetadata.PluginInstanceActionSource(message)SourceMetadata.SourceType(enum)Spec(message)Spec.ParsingMode(enum)SpecContents(message)SpecDetails(message)SpecMetadata(message)StyleGuide(message)StyleGuideContents(message)UpdateApiOperationRequest(message)UpdateApiRequest(message)UpdateAttributeRequest(message)UpdateCurationRequest(message)UpdateDependencyRequest(message)UpdateDeploymentRequest(message)UpdateExternalApiRequest(message)UpdateSpecRequest(message)UpdateStyleGuideRequest(message)UpdateVersionRequest(message)Version(message)VersionMetadata(message)
ApiHub
This service provides all methods related to the API hub.
| CreateApi |
|---|
Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
|
| CreateApiOperation |
|---|
Create an apiOperation in an API version. An apiOperation can be created only if the version has no apiOperations which were created by parsing a spec.
|
| CreateAttribute |
|---|
Create a user defined attribute. Certain pre defined attributes are already created by the API hub. These attributes will have type as
|
| CreateDeployment |
|---|
Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
|
| CreateExternalApi |
|---|
Create an External API resource in the API hub.
|
| CreateSpec |
|---|
Add a spec to an API version in the API hub. Multiple specs can be added to an API version. Note, while adding a spec, at least one of On adding a spec with contents to the version, the operations present in it will be added to the version.Note that the file contents in the spec should be of the same type as defined in the In order to access the information parsed from the spec, use the
|
| CreateVersion |
|---|
Create an API version for an API resource in the API hub.
|
| DeleteApi |
|---|
Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
|
| DeleteApiOperation |
|---|
Delete an operation in an API version and we can delete only the operations created via create API. If the operation was created by parsing the spec, then it can be deleted by editing or deleting the spec.
|
| DeleteAttribute |
|---|
Delete an attribute. Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.
|
| DeleteDeployment |
|---|
Delete a deployment resource in the API hub.
|
| DeleteExternalApi |
|---|
Delete an External API resource in the API hub.
|
| DeleteSpec |
|---|
Delete a spec. Deleting a spec will also delete the associated operations from the version.
|
| DeleteVersion |
|---|
Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
|
| GetApi |
|---|
Get API resource details including the API versions contained in it.
|
| GetApiOperation |
|---|
Get details about a particular operation in API version.
|
| GetAttribute |
|---|
Get details about the attribute.
|
| GetDefinition |
|---|
Get details about a definition in an API version.
|
| GetDeployment |
|---|
Get details about a deployment and the API versions linked to it.
|
| GetExternalApi |
|---|
Get details about an External API resource in the API hub.
|
| GetSpec |
|---|
Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use
|
| GetSpecContents |
|---|
Get spec contents.
|
| GetVersion |
|---|
Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.
|
| ListApiOperations |
|---|
List operations in an API version.
|
| ListApis |
|---|
List API resources in the API hub.
|
| ListAttributes |
|---|
List all attributes.
|
| ListDeployments |
|---|
List deployment resources in the API hub.
|
| ListExternalApis |
|---|
List External API resources in the API hub.
|
| ListSpecs |
|---|
List specs corresponding to a particular API resource.
|
| ListVersions |
|---|
List API versions of an API resource in the API hub.
|
| SearchResources |
|---|
Search across API-Hub resources.
|
| UpdateApi |
|---|
Update an API resource in the API hub. The following fields in the
The Updating the owner field requires complete owner message and updates both owner and email fields.
|
| UpdateApiOperation |
|---|
Update an operation in an API version. The following fields in the
The An operation can be updated only if the operation was created via
|
| UpdateAttribute |
|---|
Update the attribute. The following fields in the
The
|
| UpdateDeployment |
|---|
Update a deployment resource in the API hub. The following fields in the The
|
| UpdateExternalApi |
|---|
Update an External API resource in the API hub. The following fields can be updated: The
|
| UpdateSpec |
|---|
Update spec. The following fields in the In case of an OAS spec, updating spec contents can lead to: 1. Creation, deletion and update of operations. 2. Creation, deletion and update of definitions. 3. Update of other info parsed out from the new spec. In case of contents or source_uri being present in update mask, spec_type must also be present. Also, spec_type can not be present in update mask if contents or source_uri is not present. The
|
| UpdateVersion |
|---|
Update API version. The following fields in the The
|
ApiHubCollect
This service exposes methods used for collecting various types of data from different first party and third party sources and push it to Hub's collect layer.
| CollectApiData |
|---|
Collect API data from a source and push it to Hub's collect layer.
|
ApiHubCurate
This service is used for managing curations for processing API data consumed from collect layer.
| CreateCuration |
|---|
Create a curation resource in the API hub. Once a curation resource is created, plugin instances can start using it.
|
| DeleteCuration |
|---|
Delete a curation resource in the API hub. A curation can only be deleted if it's not being used by any plugin instance.
|
| GetCuration |
|---|
Get curation resource details.
|
| ListCurations |
|---|
List curation resources in the API hub.
|
| UpdateCuration |
|---|
Update a curation resource in the API hub. The following fields in the The
|
ApiHubDependencies
This service provides methods for various operations related to a Dependency in the API hub.
| CreateDependency |
|---|
Create a dependency between two entities in the API hub.
|
| DeleteDependency |
|---|
Delete the dependency resource.
|
| GetDependency |
|---|
Get details about a dependency resource in the API hub.
|
| ListDependencies |
|---|
List dependencies based on the provided filter and pagination parameters.
|
| UpdateDependency |
|---|
Update a dependency based on the The following fields in the
|
ApiHubPlugin
This service is used for managing plugins inside the API hub.
| CreatePlugin |
|---|
Create an API hub plugin resource in the API hub. Once a plugin is created, it can be used to create plugin instances.
|
| CreatePluginInstance |
|---|
Creates a Plugin instance in the API hub.
|
| DeletePlugin |
|---|
Delete a Plugin in API hub. Note, only user owned plugins can be deleted via this method.
|
| DeletePluginInstance |
|---|
Deletes a plugin instance in the API hub.
|
| DisablePlugin |
|---|
Disables a plugin. The
|
| DisablePluginInstanceAction |
|---|
Disables a plugin instance in the API hub.
|
| EnablePlugin |
|---|
Enables a plugin. The
|
| EnablePluginInstanceAction |
|---|
Enables a plugin instance in the API hub.
|
| ExecutePluginInstanceAction |
|---|
Executes a plugin instance in the API hub.
|
| GetPlugin |
|---|
Get an API hub plugin.
|
| GetPluginInstance |
|---|
Get an API hub plugin instance.
|
| ListPluginInstances |
|---|
List all the plugins in a given project and location.
|
| ListPlugins |
|---|
List all the plugins in a given project and location.
|
HostProjectRegistrationService
This service is used for managing the host project registrations.
| CreateHostProjectRegistration |
|---|
Create a host project registration. A Google cloud project can be registered as a host project if it is not attached as a runtime project to another host project. A project can be registered as a host project only once. Subsequent register calls for the same project will fail.
|
| GetHostProjectRegistration |
|---|
Get a host project registration.
|
| ListHostProjectRegistrations |
|---|
Lists host project registrations.
|
LintingService
This service provides all methods related to the 1p Linter.
| GetStyleGuide |
|---|
Get the style guide being used for linting.
|
| GetStyleGuideContents |
|---|
Get the contents of the style guide.
|
| LintSpec |
|---|
Lints the requested spec and updates the corresponding API Spec with the lint response. This lint response will be available in all subsequent Get and List Spec calls to Core service.
|
| UpdateStyleGuide |
|---|
Update the styleGuide to be used for liniting in by API hub.
|
Provisioning
This service is used for managing the data plane provisioning of the API hub.
| CreateApiHubInstance |
|---|
Provisions instance resources for the API hub.
|
| DeleteApiHubInstance |
|---|
Deletes the API hub instance.
|
| GetApiHubInstance |
|---|
Gets details of a single API hub instance.
|
| LookupApiHubInstance |
|---|
Looks up an Api Hub instance in a given Google Cloud project. There will always be only one Api Hub instance for a Google Cloud project across all locations.
|
RuntimeProjectAttachmentService
This service is used for managing the runtime project attachments.
| CreateRuntimeProjectAttachment |
|---|
Attaches a runtime project to the host project.
|
| DeleteRuntimeProjectAttachment |
|---|
Delete a runtime project attachment in the API hub. This call will detach the runtime project from the host project.
|
| GetRuntimeProjectAttachment |
|---|
Gets a runtime project attachment.
|
| ListRuntimeProjectAttachments |
|---|
List runtime projects attached to the host project.
|
| LookupRuntimeProjectAttachment |
|---|
Look up a runtime project attachment. This API can be called in the context of any project.
|
APIMetadata
The API metadata.
| Fields | |
|---|---|
api | Required. The API resource to be pushed to Hub's collect layer. The ID of the API resource will be generated by Hub to ensure uniqueness across all APIs across systems. |
versions[] | Optional. The list of versions present in an API resource. |
original_id |
Optional. The unique identifier of the API in the system where it was originally created. |
original_create_time | Optional. Timestamp indicating when the API was created at the source. |
original_update_time | Required. Timestamp indicating when the API was last updated at the source. |
ActionExecutionDetail
The details for the action to execute.
| Fields | |
|---|---|
action_id |
Required. The action id of the plugin to execute. |
Api
An API resource in the API hub.
| Fields | |
|---|---|
name |
Identifier. The name of the API resource in the API hub. Format: |
display_name |
Required. The display name of the API resource. |
description |
Optional. The description of the API resource. |
documentation | Optional. The documentation for the API resource. |
owner | Optional. Owner details for the API resource. |
versions[] |
Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is |
create_time | Output only. The time at which the API resource was created. |
update_time | Output only. The time at which the API resource was last updated. |
target_user | Optional. The target users for the API. This maps to the following system defined attribute: |
team | Optional. The team owning the API. This maps to the following system defined attribute: |
business_unit | Optional. The business unit owning the API. This maps to the following system defined attribute: |
maturity_level | Optional. The maturity level of the API. This maps to the following system defined attribute: |
attributes |
Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: |
api_style | Optional. The style of the API. This maps to the following system defined attribute: |
selected_version |
Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is |
api_requirements | Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute. |
fingerprint |
Optional. Fingerprint of the API resource. |
source_metadata[] | Output only. The list of sources and metadata from the sources of the API resource. |
api_functional_requirements | Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. |
api_technical_requirements | Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute. |
ApiData
The API data to be collected.
| Fields | |
|---|---|
Union field Data. The data to be collected. Data can be only one of the following: | |
api_metadata_list | Optional. The list of API metadata. |
ApiHubInstance
An ApiHubInstance represents the instance resources of the API hub. Currently, only one ApiHub instance is allowed for each project.
| Fields | |
|---|---|
name |
Identifier. Format: |
create_time | Output only. Creation timestamp. |
update_time | Output only. Last update timestamp. |
state | Output only. The current state of the ApiHub instance. |
state_message |
Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is |
config | Required. Config of the ApiHub instance. |
labels |
Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources |
description |
Optional. Description of the ApiHub instance. |
Config
Available configurations to provision an ApiHub Instance.
| Fields | |
|---|---|
cmek_key_name |
Optional. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of |
disable_search |
Optional. If true, the search will be disabled for the instance. The default value is false. |
vertex_location |
Optional. The name of the Vertex AI location where the data store is stored. |
encryption_type | Optional. Encryption type for the region. If the encryption type is CMEK, the cmek_key_name must be provided. If no encryption type is provided, GMEK will be used. |
EncryptionType
Types of data encryption.
| Enums | |
|---|---|
ENCRYPTION_TYPE_UNSPECIFIED | Encryption type unspecified. |
GMEK | Default encryption using Google managed encryption key. |
CMEK | Encryption using customer managed encryption key. |
State
State of the ApiHub Instance.
| Enums | |
|---|---|
STATE_UNSPECIFIED | The default value. This value is used if the state is omitted. |
INACTIVE | The ApiHub instance has not been initialized or has been deleted. |
CREATING | The ApiHub instance is being created. |
ACTIVE | The ApiHub instance has been created and is ready for use. |
UPDATING | The ApiHub instance is being updated. |
DELETING | The ApiHub instance is being deleted. |
FAILED | The ApiHub instance encountered an error during a state change. |
ApiHubResource
ApiHubResource is one of the resources such as Api, Operation, Deployment, Definition, Spec and Version resources stored in API-Hub.
| Fields | |
|---|---|
Union field
| |
api | This represents Api resource in search results. Only name, display_name, description and owner fields are populated in search results. |
operation | This represents ApiOperation resource in search results. Only name, description, spec and details fields are populated in search results. |
deployment | This represents Deployment resource in search results. Only name, display_name, description, deployment_type and api_versions fields are populated in search results. |
spec | This represents Spec resource in search results. Only name, display_name, description, spec_type and documentation fields are populated in search results. |
definition | This represents Definition resource in search results. Only name field is populated in search results. |
version | This represents Version resource in search results. Only name, display_name, description, lifecycle, compliance and accreditation fields are populated in search results. |
ApiMetadataList
The message to hold repeated API metadata.
| Fields | |
|---|---|
api_metadata[] | Required. The list of API metadata. |
ApiOperation
Represents an operation contained in an API version in the API hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Alternatively operations can be managed via create,update and delete APIs, creation of apiOperation can be possible only for version with no parsed operations and update/delete can be possible only for operations created via create API.
| Fields | |
|---|---|
name |
Identifier. The name of the operation. Format: |
spec |
Output only. The name of the spec will be of the format: |
details | Optional. Operation details. Note: Even though this field is optional, it is required for |
create_time | Output only. The time at which the operation was created. |
update_time | Output only. The time at which the operation was last updated. |
attributes |
Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: |
source_metadata[] | Output only. The list of sources and metadata from the sources of the API operation. |
ApplicationIntegrationEndpointDetails
The details of the Application Integration endpoint to be triggered for curation.
| Fields | |
|---|---|
uri |
Required. The endpoint URI should be a valid REST URI for triggering an Application Integration. Format: |
trigger_id |
Required. The API trigger ID of the Application Integration workflow. |
Attribute
An attribute in the API hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API hub or created by users.
| Fields | |
|---|---|
name |
Identifier. The name of the attribute in the API hub. Format: |
display_name |
Required. The display name of the attribute. |
description |
Optional. The description of the attribute. |
definition_type | Output only. The definition type of the attribute. |
scope | Required. The scope of the attribute. It represents the resource in the API hub to which the attribute can be linked. |
data_type | Required. The type of the data of the attribute. |
allowed_values[] | Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000. |
cardinality |
Optional. The maximum number of values that the attribute can have when associated with an API hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute. |
mandatory |
Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory. |
create_time | Output only. The time at which the attribute was created. |
update_time | Output only. The time at which the attribute was last updated. |
AllowedValue
The value that can be assigned to the attribute when the data type is enum.
| Fields | |
|---|---|
id |
Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/. |
display_name |
Required. The display name of the allowed value. |
description |
Optional. The detailed description of the allowed value. |
immutable |
Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes. |
DataType
Enumeration of attribute's data type.
| Enums | |
|---|---|
DATA_TYPE_UNSPECIFIED | Attribute data type unspecified. |
ENUM | Attribute's value is of type enum. |
JSON | Attribute's value is of type json. |
STRING | Attribute's value is of type string. |
URI | Attribute's value is of type uri. |
DefinitionType
Enumeration of attribute definition types.
| Enums | |
|---|---|
DEFINITION_TYPE_UNSPECIFIED | Attribute definition type unspecified. |
SYSTEM_DEFINED | The attribute is predefined by the API hub. Note that only the list of allowed values can be updated in this case via UpdateAttribute method. |
USER_DEFINED | The attribute is defined by the user. |
Scope
Enumeration for the scope of the attribute representing the resource in the API hub to which the attribute can be linked.
| Enums | |
|---|---|
SCOPE_UNSPECIFIED | Scope Unspecified. |
API | Attribute can be linked to an API. |
VERSION | Attribute can be linked to an API version. |
SPEC | Attribute can be linked to a Spec. |
API_OPERATION | Attribute can be linked to an API Operation. |
DEPLOYMENT | Attribute can be linked to a Deployment. |
DEPENDENCY | Attribute can be linked to a Dependency. |
DEFINITION | Attribute can be linked to a definition. |
EXTERNAL_API | Attribute can be linked to a ExternalAPI. |
PLUGIN | Attribute can be linked to a Plugin. |
AttributeValues
The attribute values associated with resource.
| Fields | |
|---|---|
attribute |
Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute} |
Union field Value. The attribute values associated with the resource. Value can be only one of the following: | |
enum_values | The attribute values associated with a resource in case attribute data type is enum. |
string_values | The attribute values associated with a resource in case attribute data type is string. |
json_values | The attribute values associated with a resource in case attribute data type is JSON. |
uri_values | The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name. |
EnumAttributeValues
The attribute values of data type enum.
| Fields | |
|---|---|
values[] | Required. The attribute values in case attribute data type is enum. |
StringAttributeValues
The attribute values of data type string or JSON.
| Fields | |
|---|---|
values[] |
Required. The attribute values in case attribute data type is string or JSON. |
AuthConfig
AuthConfig represents the authentication information.
| Fields | |
|---|---|
auth_type | Required. The authentication type. |
Union field config. Supported auth types. config can be only one of the following: | |
google_service_account_config | Google Service Account. |
user_password_config | User Password. |
api_key_config | Api Key Config. |
oauth2_client_credentials_config | Oauth2.0 Client Credentials. |
ApiKeyConfig
Config for authentication with API key.
| Fields | |
|---|---|
name |
Required. The parameter name of the API key. E.g. If the API request is "https://example.com/act?api_key= |
api_key | Required. The name of the SecretManager secret version resource storing the API key. Format: |
http_element_location | Required. The location of the API key. The default value is QUERY. |
HttpElementLocation
Enum of location an HTTP element can be.
| Enums | |
|---|---|
HTTP_ELEMENT_LOCATION_UNSPECIFIED | HTTP element location not specified. |
QUERY | Element is in the HTTP request query. |
HEADER | Element is in the HTTP request header. |
PATH | Element is in the HTTP request path. |
BODY | Element is in the HTTP request body. |
COOKIE | Element is in the HTTP request cookie. |
Oauth2ClientCredentialsConfig
Parameters to support Oauth 2.0 client credentials grant authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.
| Fields | |
|---|---|
client_id |
Required. The client identifier. |
client_secret | Required. Secret version reference containing the client secret. The |
UserPasswordConfig
Parameters to support Username and Password Authentication.
| Fields | |
|---|---|
username |
Required. Username. |
password | Required. Secret version reference containing the password. The |
AuthType
AuthType represents the authentication type.
| Enums | |
|---|---|
AUTH_TYPE_UNSPECIFIED | Authentication type not specified. |
NO_AUTH | No authentication. |
GOOGLE_SERVICE_ACCOUNT | Google service account authentication. |
USER_PASSWORD | Username and password authentication. |
API_KEY | API Key authentication. |
OAUTH2_CLIENT_CREDENTIALS | Oauth 2.0 client credentials grant authentication. |
CollectApiDataRequest
The CollectApiData method's request.
| Fields | |
|---|---|
location |
Required. The regional location of the API hub instance and its resources. Format: |
collection_type | Required. The type of collection. Applies to all entries in |
plugin_instance |
Required. The plugin instance collecting the API data. Format: |
action_id |
Required. The action ID to be used for collecting the API data. This should map to one of the action IDs specified in action configs in the plugin. |
api_data | Required. The API data to be collected. |
CollectApiDataResponse
This type has no fields.
The CollectApiData method's response.
CollectionType
The type of the collect request.
| Enums | |
|---|---|
COLLECTION_TYPE_UNSPECIFIED | The default value. This value is used if the collection type is omitted. |
COLLECTION_TYPE_UPSERT | The collection type is upsert. This should be used when an API is created or updated at the source. |
COLLECTION_TYPE_DELETE | The collection type is delete. This should be used when an API is deleted at the source. |
ConfigValueOption
ConfigValueOption represents an option for a config variable of type enum or multi select.
| Fields | |
|---|---|
id |
Required. Id of the option. |
display_name |
Required. Display name of the option. |
description |
Optional. Description of the option. |
ConfigVariable
ConfigVariable represents a additional configuration variable present in a PluginInstance Config or AuthConfig, based on a ConfigVariableTemplate.
| Fields | |
|---|---|
key |
Output only. Key will be the |
Union field value. The values associated with the config variable. value can be only one of the following: | |
string_value |
Optional. The config variable value in case of config variable of type string. |
int_value |
Optional. The config variable value in case of config variable of type integer. |
bool_value |
Optional. The config variable value in case of config variable of type boolean. |
secret_value | Optional. The config variable value in case of config variable of type secret. |
enum_value | Optional. The config variable value in case of config variable of type enum. |
multi_select_values | Optional. The config variable value in case of config variable of type multi select. |
multi_string_values | Optional. The config variable value in case of config variable of type multi string. |
multi_int_values | Optional. The config variable value in case of config variable of type multi integer. |
MultiIntValues
The config variable value of data type multi int.
| Fields | |
|---|---|
values[] |
Optional. The config variable value of data type multi int. |
MultiSelectValues
The config variable value of data type multi select.
| Fields | |
|---|---|
values[] | Optional. The config variable value of data type multi select. |
MultiStringValues
The config variable value of data type multi string.
| Fields | |
|---|---|
values[] |
Optional. The config variable value of data type multi string. |
ConfigVariableTemplate
ConfigVariableTemplate represents a configuration variable template present in a Plugin Config.
| Fields | |
|---|---|
id |
Required. ID of the config variable. Must be unique within the configuration. |
value_type | Required. Type of the parameter: string, int, bool etc. |
description |
Optional. Description. |
validation_regex |
Optional. Regular expression in RE2 syntax used for validating the |
required |
Optional. Flag represents that this |
enum_options[] | Optional. Enum options. To be populated if |
multi_select_options[] | Optional. Multi select options. To be populated if |
ValueType
ValueType indicates the data type of the value.
| Enums | |
|---|---|
VALUE_TYPE_UNSPECIFIED | Value type is not specified. |
STRING | Value type is string. |
INT | Value type is integer. |
BOOL | Value type is boolean. |
SECRET | Value type is secret. |
ENUM | Value type is enum. |
MULTI_SELECT | Value type is multi select. |
MULTI_STRING | Value type is multi string. |
MULTI_INT | Value type is multi int. |
CreateApiHubInstanceRequest
The CreateApiHubInstance method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource for the Api Hub instance resource. Format: |
api_hub_instance_id |
Optional. Identifier to assign to the Api Hub instance. Must be unique within scope of the parent resource. If the field is not provided, system generated id will be used. This value should be 4-40 characters, and valid characters are |
api_hub_instance | Required. The ApiHub instance. |
CreateApiOperationRequest
The CreateApiOperation method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource for the operation resource. Format: |
api_operation_id |
Optional. The ID to use for the operation resource, which will become the final component of the operation's resource name. This field is optional.
This value should be 4-500 characters, overall resource name which will be of format |
api_operation | Required. The operation resource to create. |
CreateApiRequest
The CreateApi method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource for the API resource. Format: |
api_id |
Optional. The ID to use for the API resource, which will become the final component of the API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
api | Required. The API resource to create. |
CreateAttributeRequest
The CreateAttribute method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource for Attribute. Format: |
attribute_id |
Optional. The ID to use for the attribute, which will become the final component of the attribute's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
attribute | Required. The attribute to create. |
CreateCurationRequest
The [CreateCuration][ApiHub.CreateCuration] method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource for the curation resource. Format: |
curation_id |
Optional. The ID to use for the curation resource, which will become the final component of the curations's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
curation | Required. The curation resource to create. |
CreateDependencyRequest
The CreateDependency method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource for the dependency resource. Format: |
dependency_id |
Optional. The ID to use for the dependency resource, which will become the final component of the dependency's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if duplicate id is provided by the client. * If not provided, a system generated id will be used. This value should be 4-500 characters, and valid characters are |
dependency | Required. The dependency resource to create. |
CreateDeploymentRequest
The CreateDeployment method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource for the deployment resource. Format: |
deployment_id |
Optional. The ID to use for the deployment resource, which will become the final component of the deployment's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
deployment | Required. The deployment resource to create. |
CreateExternalApiRequest
The CreateExternalApi method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource for the External API resource. Format: |
external_api_id |
Optional. The ID to use for the External API resource, which will become the final component of the External API's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
external_api | Required. The External API resource to create. |
CreateHostProjectRegistrationRequest
The CreateHostProjectRegistration method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource for the host project. Format: |
host_project_registration_id |
Required. The ID to use for the Host Project Registration, which will become the final component of the host project registration's resource name. The ID must be the same as the Google cloud project specified in the host_project_registration.gcp_project field. |
host_project_registration | Required. The host project registration to register. |
CreatePluginInstanceRequest
The CreatePluginInstance method's request.
| Fields | |
|---|---|
parent |
Required. The parent of the plugin instance resource. Format: |
plugin_instance_id |
Optional. The ID to use for the plugin instance, which will become the final component of the plugin instance's resource name. This field is optional.
This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/. |
plugin_instance | Required. The plugin instance to create. |
CreatePluginRequest
The CreatePlugin method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource where this plugin will be created. Format: |
plugin_id |
Optional. The ID to use for the Plugin resource, which will become the final component of the Plugin's resource name. This field is optional.
This value should be 4-500 characters, overall resource name which will be of format |
plugin | Required. The plugin to create. |
CreateRuntimeProjectAttachmentRequest
The CreateRuntimeProjectAttachment method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource for the Runtime Project Attachment. Format: |
runtime_project_attachment_id |
Required. The ID to use for the Runtime Project Attachment, which will become the final component of the Runtime Project Attachment's name. The ID must be the same as the project ID of the Google cloud project specified in the runtime_project_attachment.runtime_project field. |
runtime_project_attachment | Required. The Runtime Project Attachment to create. |
CreateSpecRequest
The CreateSpec method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource for Spec. Format: |
spec_id |
Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional.
This value should be 4-500 characters, overall resource name which will be of format |
spec | Required. The spec to create. |
CreateVersionRequest
The CreateVersion method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource for API version. Format: |
version_id |
Optional. The ID to use for the API version, which will become the final component of the version's resource name. This field is optional.
This value should be 4-500 characters, overall resource name which will be of format |
version | Required. The version to create. |
Curation
A curation resource in the API hub.
| Fields | |
|---|---|
name |
Identifier. The name of the curation. Format: |
display_name |
Required. The display name of the curation. |
description |
Optional. The description of the curation. |
endpoint | Required. The endpoint to be triggered for curation. |
plugin_instance_actions[] | Output only. The plugin instances and associated actions that are using the curation. Note: A particular curation could be used by multiple plugin instances or multiple actions in a plugin instance. |
last_execution_state | Output only. The last execution state of the curation. |
last_execution_error_code | Output only. The error code of the last execution of the curation. The error code is populated only when the last execution state is failed. |
last_execution_error_message |
Output only. Error message describing the failure, if any, during the last execution of the curation. |
create_time | Output only. The time at which the curation was created. |
update_time | Output only. The time at which the curation was last updated. |
ErrorCode
The error codes for failed executions.
| Enums | |
|---|---|
ERROR_CODE_UNSPECIFIED | Default unspecified error code. |
INTERNAL_ERROR | The execution failed due to an internal error. |
UNAUTHORIZED | The curation is not authorized to trigger the endpoint uri. |
LastExecutionState
The state of the last execution of the curation.
| Enums | |
|---|---|
LAST_EXECUTION_STATE_UNSPECIFIED | Default unspecified state. |
SUCCEEDED | The last curation execution was successful. |
FAILED | The last curation execution failed. |
PluginInstanceActionID
The plugin instance and associated action that is using the curation.
| Fields | |
|---|---|
plugin_instance |
Output only. Plugin instance that is using the curation. Format is |
action_id |
Output only. The action ID that is using the curation. This should map to one of the action IDs specified in action configs in the plugin. |
CurationConfig
The curation information for this plugin instance.
| Fields | |
|---|---|
curation_type | Required. The curation type for this plugin instance. |
Union field curation_config. The curation information for this plugin instance. curation_config can be only one of the following: | |
custom_curation | Optional. Custom curation information for this plugin instance. |
CustomCuration
Custom curation information for this plugin instance.
| Fields | |
|---|---|
curation |
Required. The unique name of the curation resource. This will be the name of the curation resource in the format: |
CurationType
Enum for the curation type.
| Enums | |
|---|---|
CURATION_TYPE_UNSPECIFIED | Default unspecified curation type. |
DEFAULT_CURATION_FOR_API_METADATA | Default curation for API metadata will be used. |
CUSTOM_CURATION_FOR_API_METADATA | Custom curation for API metadata will be used. |
Definition
Represents a definition for example schema, request, response definitions contained in an API version. A definition is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, definition will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec. Also, within OpenAPI spec, only schema object is supported.
| Fields | |
|---|---|
name |
Identifier. The name of the definition. Format: |
spec |
Output only. The name of the spec from where the definition was parsed. Format is |
type | Output only. The type of the definition. |
create_time | Output only. The time at which the definition was created. |
update_time | Output only. The time at which the definition was last updated. |
attributes |
Optional. The list of user defined attributes associated with the definition resource. The key is the attribute name. It will be of the format: |
Union field
| |
schema | Output only. The value of a schema definition. |
Type
Enumeration of definition types.
| Enums | |
|---|---|
TYPE_UNSPECIFIED | Definition type unspecified. |
SCHEMA | Definition type schema. |
DeleteApiHubInstanceRequest
The DeleteApiHubInstance method's request.
| Fields | |
|---|---|
name |
Required. The name of the Api Hub instance to delete. Format: |
DeleteApiOperationRequest
The DeleteApiOperation method's request.
| Fields | |
|---|---|
name |
Required. The name of the operation resource to delete. Format: |
DeleteApiRequest
The DeleteApi method's request.
| Fields | |
|---|---|
name |
Required. The name of the API resource to delete. Format: |
force |
Optional. If set to true, any versions from this API will also be deleted. Otherwise, the request will only work if the API has no versions. |
DeleteAttributeRequest
The DeleteAttribute method's request.
| Fields | |
|---|---|
name |
Required. The name of the attribute to delete. Format: |
DeleteCurationRequest
The [DeleteCuration][ApiHub.DeleteCuration] method's request.
| Fields | |
|---|---|
name |
Required. The name of the curation resource to delete. Format: |
DeleteDependencyRequest
The DeleteDependency method's request.
| Fields | |
|---|---|
name |
Required. The name of the dependency resource to delete. Format: |
DeleteDeploymentRequest
The DeleteDeployment method's request.
| Fields | |
|---|---|
name |
Required. The name of the deployment resource to delete. Format: |
DeleteExternalApiRequest
The DeleteExternalApi method's request.
| Fields | |
|---|---|
name |
Required. The name of the External API resource to delete. Format: |
DeletePluginInstanceRequest
The DeletePluginInstance method's request.
| Fields | |
|---|---|
name |
Required. The name of the plugin instance to delete. Format: |
DeletePluginRequest
The [DeletePlugin][ApiHub.DeletePlugin] method's request.
| Fields | |
|---|---|
name |
Required. The name of the Plugin resource to delete. Format: |
DeleteRuntimeProjectAttachmentRequest
The DeleteRuntimeProjectAttachment method's request.
| Fields | |
|---|---|
name |
Required. The name of the Runtime Project Attachment to delete. Format: |
DeleteSpecRequest
The DeleteSpec method's request.
| Fields | |
|---|---|
name |
Required. The name of the spec to delete. Format: |
DeleteVersionRequest
The DeleteVersion method's request.
| Fields | |
|---|---|
name |
Required. The name of the version to delete. Format: |
force |
Optional. If set to true, any specs from this version will also be deleted. Otherwise, the request will only work if the version has no specs. |
Dependency
A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two Operations or between an Operation and External API.
| Fields | |
|---|---|
name |
Identifier. The name of the dependency in the API hub. Format: |
consumer | Required. Immutable. The entity acting as the consumer in the dependency. |
supplier | Required. Immutable. The entity acting as the supplier in the dependency. |
state | Output only. State of the dependency. |
description |
Optional. Human readable description corresponding of the dependency. |
discovery_mode | Output only. Discovery mode of the dependency. |
error_detail | Output only. Error details of a dependency if the system has detected it internally. |
create_time | Output only. The time at which the dependency was created. |
update_time | Output only. The time at which the dependency was last updated. |
attributes |
Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: |
DiscoveryMode
Possible modes of discovering the dependency.
| Enums | |
|---|---|
DISCOVERY_MODE_UNSPECIFIED | Default value. This value is unused. |
MANUAL | Manual mode of discovery when the dependency is defined by the user. |
State
Possible states for a dependency.
| Enums | |
|---|---|
STATE_UNSPECIFIED | Default value. This value is unused. |
PROPOSED | Dependency will be in a proposed state when it is newly identified by the API hub on its own. |
VALIDATED | Dependency will be in a validated state when it is validated by the admin or manually created in the API hub. |
DependencyEntityReference
Reference to an entity participating in a dependency.
| Fields | |
|---|---|
display_name |
Output only. Display name of the entity. |
Union field identifier. Required. Unique identifier for the participating entity. identifier can be only one of the following: | |
operation_resource_name |
The resource name of an operation in the API hub. Format: |
external_api_resource_name |
The resource name of an external API in the API hub. Format: |
DependencyErrorDetail
Details describing error condition of a dependency.
| Fields | |
|---|---|
error | Optional. Error in the dependency. |
error_time | Optional. Timestamp at which the error was found. |
Error
Possible values representing an error in the dependency.
| Enums | |
|---|---|
ERROR_UNSPECIFIED | Default value used for no error in the dependency. |
SUPPLIER_NOT_FOUND | Supplier entity has been deleted. |
SUPPLIER_RECREATED | Supplier entity has been recreated. |
Deployment
Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.
| Fields | |
|---|---|
name |
Identifier. The name of the deployment. Format: |
display_name |
Required. The display name of the deployment. |
description |
Optional. The description of the deployment. |
documentation | Optional. The documentation of the deployment. |
deployment_type | Required. The type of deployment. This maps to the following system defined attribute: |
resource_uri |
Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy. |
endpoints[] |
Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses. |
api_versions[] |
Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs). |
create_time | Output only. The time at which the deployment was created. |
update_time | Output only. The time at which the deployment was last updated. |
slo | Optional. The SLO for this deployment. This maps to the following system defined attribute: |
environment | Optional. The environment mapping to this deployment. This maps to the following system defined attribute: |
attributes |
Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: |
source_metadata[] | Output only. The list of sources and metadata from the sources of the deployment. |
DeploymentMetadata
The metadata associated with a deployment.
| Fields | |
|---|---|
deployment | Required. The deployment resource to be pushed to Hub's collect layer. The ID of the deployment will be generated by Hub. |
original_id |
Optional. The unique identifier of the deployment in the system where it was originally created. |
original_create_time | Optional. Timestamp indicating when the deployment was created at the source. |
original_update_time | Required. Timestamp indicating when the deployment was last updated at the source. |
DisablePluginInstanceActionRequest
The DisablePluginInstanceAction method's request.
| Fields | |
|---|---|
name |
Required. The name of the plugin instance to disable. Format: |
action_id |
Required. The action id to disable. |
DisablePluginInstanceActionResponse
This type has no fields.
The DisablePluginInstanceAction method's response.
DisablePluginRequest
The DisablePlugin method's request.
| Fields | |
|---|---|
name |
Required. The name of the plugin to disable. Format: |
Documentation
Documentation details.
| Fields | |
|---|---|
external_uri |
Optional. The uri of the externally hosted documentation. |
EnablePluginInstanceActionRequest
The EnablePluginInstanceAction method's request.
| Fields | |
|---|---|
name |
Required. The name of the plugin instance to enable. Format: |
action_id |
Required. The action id to enable. |
EnablePluginInstanceActionResponse
This type has no fields.
The EnablePluginInstanceAction method's response.
EnablePluginRequest
The EnablePlugin method's request.
| Fields | |
|---|---|
name |
Required. The name of the plugin to enable. Format: |
Endpoint
The endpoint to be triggered for curation. The endpoint will be invoked with a request payload containing [ApiMetadata][google.cloud.apihub.v1.ApiHub.ApiMetadata]. Response should contain curated data in the form of [ApiMetadata][google.cloud.apihub.v1.ApiHub.ApiMetadata].
| Fields | |
|---|---|
Union field endpoint_details. The details of the endpoint to be triggered for curation. endpoint_details can be only one of the following: | |
application_integration_endpoint_details |
Required. The details of the Application Integration endpoint to be triggered for curation. |
ExecutePluginInstanceActionRequest
The ExecutePluginInstanceAction method's request.
| Fields | |
|---|---|
name |
Required. The name of the plugin instance to execute. Format: |
action_execution_detail | Required. The execution details for the action to execute. |
ExecutePluginInstanceActionResponse
This type has no fields.
The ExecutePluginInstanceAction method's response.
ExecutionStatus
The execution status for the plugin instance.
| Fields | |
|---|---|
current_execution_state | Output only. The current state of the execution. |
last_execution | Output only. The last execution of the plugin instance. |
CurrentExecutionState
Enum for the current state of the execution.
| Enums | |
|---|---|
CURRENT_EXECUTION_STATE_UNSPECIFIED | Default unspecified execution state. |
RUNNING | The plugin instance is executing. |
NOT_RUNNING | The plugin instance is not running an execution. |
LastExecution
The result of the last execution of the plugin instance.
| Fields | |
|---|---|
result | Output only. The result of the last execution of the plugin instance. |
error_message |
Output only. Error message describing the failure, if any, during the last execution. |
start_time | Output only. The last execution start time of the plugin instance. |
end_time | Output only. The last execution end time of the plugin instance. |
Result
Enum for the result of the last execution of the plugin instance.
| Enums | |
|---|---|
RESULT_UNSPECIFIED | Default unspecified execution result. |
SUCCEEDED | The plugin instance executed successfully. |
FAILED | The plugin instance execution failed. |
ExtendedApi
An extended API contains the API and its set of features which are derived from the associated data it has.
| Fields | |
|---|---|
api | The API which is extended. |
spec_count |
The number of specs across all versions. |
lint_error_count |
The number of lint errors across all specs. |
ExternalApi
An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.
| Fields | |
|---|---|
name |
Identifier. Format: |
display_name |
Required. Display name of the external API. Max length is 63 characters (Unicode Code Points). |
description |
Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points). |
endpoints[] |
Optional. List of endpoints on which this API is accessible. |
paths[] |
Optional. List of paths served by this API. |
documentation | Optional. Documentation of the external API. |
attributes |
Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: |
create_time | Output only. Creation timestamp. |
update_time | Output only. Last update timestamp. |
GetApiHubInstanceRequest
The GetApiHubInstance method's request.
| Fields | |
|---|---|
name |
Required. The name of the Api Hub instance to retrieve. Format: |
GetApiOperationRequest
The GetApiOperation method's request.
| Fields | |
|---|---|
name |
Required. The name of the operation to retrieve. Format: |
GetApiRequest
The GetApi method's request.
| Fields | |
|---|---|
name |
Required. The name of the API resource to retrieve. Format: |
GetAttributeRequest
The GetAttribute method's request.
| Fields | |
|---|---|
name |
Required. The name of the attribute to retrieve. Format: |
GetCurationRequest
The [GetCuration][ApiHub.GetCuration] method's request.
| Fields | |
|---|---|
name |
Required. The name of the curation resource to retrieve. Format: |
GetDefinitionRequest
The GetDefinition method's request.
| Fields | |
|---|---|
name |
Required. The name of the definition to retrieve. Format: |
GetDependencyRequest
The [GetDependency][.ApiHubDependencies.GetDependency] method's request.
| Fields | |
|---|---|
name |
Required. The name of the dependency resource to retrieve. Format: |
GetDeploymentRequest
The GetDeployment method's request.
| Fields | |
|---|---|
name |
Required. The name of the deployment resource to retrieve. Format: |
GetExternalApiRequest
The GetExternalApi method's request.
| Fields | |
|---|---|
name |
Required. The name of the External API resource to retrieve. Format: |
GetHostProjectRegistrationRequest
The GetHostProjectRegistration method's request.
| Fields | |
|---|---|
name |
Required. Host project registration resource name. projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration_id} |
GetPluginInstanceRequest
The GetPluginInstance method's request.
| Fields | |
|---|---|
name |
Required. The name of the plugin instance to retrieve. Format: |
GetPluginRequest
The GetPlugin method's request.
| Fields | |
|---|---|
name |
Required. The name of the plugin to retrieve. Format: |
GetRuntimeProjectAttachmentRequest
The GetRuntimeProjectAttachment method's request.
| Fields | |
|---|---|
name |
Required. The name of the API resource to retrieve. Format: |
GetSpecContentsRequest
The GetSpecContents method's request.
| Fields | |
|---|---|
name |
Required. The name of the spec whose contents need to be retrieved. Format: |
GetSpecRequest
The GetSpec method's request.
| Fields | |
|---|---|
name |
Required. The name of the spec to retrieve. Format: |
GetStyleGuideContentsRequest
The GetStyleGuideContents method's request.
| Fields | |
|---|---|
name |
Required. The name of the StyleGuide whose contents need to be retrieved. There is exactly one style guide resource per project per location. The expected format is |
GetStyleGuideRequest
The GetStyleGuide method's request.
| Fields | |
|---|---|
name |
Required. The name of the spec to retrieve. Format: |
GetVersionRequest
The GetVersion method's request.
| Fields | |
|---|---|
name |
Required. The name of the API version to retrieve. Format: |
GoogleServiceAccountConfig
Config for Google service account authentication.
| Fields | |
|---|---|
service_account |
Required. The service account to be used for authenticating request. The |
HostProjectRegistration
Host project registration refers to the registration of a Google cloud project with Api Hub as a host project. This is the project where Api Hub is provisioned. It acts as the consumer project for the Api Hub instance provisioned. Multiple runtime projects can be attached to the host project and these attachments define the scope of Api Hub.
| Fields | |
|---|---|
name |
Identifier. The name of the host project registration. Format: "projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}". |
gcp_project |
Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number. |
create_time | Output only. The time at which the host project registration was created. |
HttpOperation
The HTTP Operation.
| Fields | |
|---|---|
path | Optional. The path details for the Operation. Note: Even though this field is optional, it is required for |
method | Optional. Operation method Note: Even though this field is optional, it is required for |
Method
Enumeration of Method types.
| Enums | |
|---|---|
METHOD_UNSPECIFIED | Method unspecified. |
GET | Get Operation type. |
PUT | Put Operation type. |
POST | Post Operation type. |
DELETE | Delete Operation type. |
OPTIONS | Options Operation type. |
HEAD | Head Operation type. |
PATCH | Patch Operation type. |
TRACE | Trace Operation type. |
InsightsMetric
The metric and its aggregation function.
| Fields | |
|---|---|
metric |
Required. Name of the metric. |
aggregation | Required. Aggregation function associated with the metric. |
AggregationFunction
The aggregation function associated with the metric.
| Enums | |
|---|---|
AGGREGATION_FUNCTION_UNSPECIFIED | Unspecified Aggregation function. |
COUNT_DISTINCT | Count distinct function. |
Issue
Issue contains the details of a single issue found by the linter.
| Fields | |
|---|---|
code |
Required. Rule code unique to each rule defined in linter. |
path[] |
Required. An array of strings indicating the location in the analyzed document where the rule was triggered. |
message |
Required. Human-readable message describing the issue found by the linter. |
severity | Required. Severity level of the rule violation. |
range | Required. Object describing where in the file the issue was found. |
LintResponse
LintResponse contains the response from the linter.
| Fields | |
|---|---|
issues[] | Optional. Array of issues found in the analyzed document. |
summary[] | Optional. Summary of all issue types and counts for each severity level. |
state | Required. Lint state represents success or failure for linting. |
source |
Required. Name of the linting application. |
linter | Required. Name of the linter used. |
create_time | Required. Timestamp when the linting response was generated. |
SummaryEntry
Count of issues with a given severity.
| Fields | |
|---|---|
severity | Required. Severity of the issue. |
count |
Required. Count of issues with the given severity. |
LintSpecRequest
The LintSpec method's request.
| Fields | |
|---|---|
name |
Required. The name of the spec to be linted. Format: |
LintState
Lint state represents success or failure for linting.
| Enums | |
|---|---|
LINT_STATE_UNSPECIFIED | Lint state unspecified. |
LINT_STATE_SUCCESS | Linting was completed successfully. |
LINT_STATE_ERROR | Linting encountered errors. |
Linter
Enumeration of linter types.
| Enums | |
|---|---|
LINTER_UNSPECIFIED | Linter type unspecified. |
SPECTRAL | Linter type spectral. |
OTHER | Linter type other. |
ListApiOperationsRequest
The ListApiOperations method's request.
| Fields | |
|---|---|
parent |
Required. The parent which owns this collection of operations i.e., the API version. Format: |
filter |
Optional. An expression that filters the list of ApiOperations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: The following fields in the Expressions are combined with either Here are a few examples:
|
page_size |
Optional. The maximum number of operations to return. The service may return fewer than this value. If unspecified, at most 50 operations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
ListApiOperationsResponse
The ListApiOperations method's response.
| Fields | |
|---|---|
api_operations[] | The operations corresponding to an API version. |
next_page_token |
A token, which can be sent as |
ListApisRequest
The ListApis method's request.
| Fields | |
|---|---|
parent |
Required. The parent, which owns this collection of API resources. Format: |
filter |
Optional. An expression that filters the list of ApiResources. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: The following fields in the
Expressions are combined with either Here are a few examples:
|
page_size |
Optional. The maximum number of API resources to return. The service may return fewer than this value. If unspecified, at most 50 Apis will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
ListApisResponse
The ListApis method's response.
| Fields | |
|---|---|
apis[] | The API resources present in the API hub. |
next_page_token |
A token, which can be sent as |
ListAttributesRequest
The ListAttributes method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource for Attribute. Format: |
filter |
Optional. An expression that filters the list of Attributes. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: The following fields in the
Expressions are combined with either Here are a few examples:
|
page_size |
Optional. The maximum number of attribute resources to return. The service may return fewer than this value. If unspecified, at most 50 attributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListAttributesResponse
The ListAttributes method's response.
| Fields | |
|---|---|
attributes[] | The list of all attributes. |
next_page_token |
A token, which can be sent as |
ListCurationsRequest
The [ListCurations][ApiHub.ListCurations] method's request.
| Fields | |
|---|---|
parent |
Required. The parent, which owns this collection of curation resources. Format: |
filter |
Optional. An expression that filters the list of curation resources. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: The following fields in the
Expressions are combined with either Here are a few examples:
|
page_size |
Optional. The maximum number of curation resources to return. The service may return fewer than this value. If unspecified, at most 50 curations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
ListCurationsResponse
The [ListCurations][ApiHub.ListCurations] method's response.
| Fields | |
|---|---|
curations[] | The curation resources present in the API hub. |
next_page_token |
A token, which can be sent as |
ListDependenciesRequest
The ListDependencies method's request.
| Fields | |
|---|---|
parent |
Required. The parent which owns this collection of dependency resources. Format: |
filter |
Optional. An expression that filters the list of Dependencies. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. Allowed comparison operator is The following fields in the
Expressions are combined with either For example, |
page_size |
Optional. The maximum number of dependency resources to return. The service may return fewer than this value. If unspecified, at most 50 dependencies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListDependenciesResponse
The ListDependencies method's response.
| Fields | |
|---|---|
dependencies[] | The dependency resources present in the API hub. |
next_page_token |
A token, which can be sent as |
ListDeploymentsRequest
The ListDeployments method's request.
| Fields | |
|---|---|
parent |
Required. The parent, which owns this collection of deployment resources. Format: |
filter |
Optional. An expression that filters the list of Deployments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: The following fields in the
Expressions are combined with either Here are a few examples:
|
page_size |
Optional. The maximum number of deployment resources to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
ListDeploymentsResponse
The ListDeployments method's response.
| Fields | |
|---|---|
deployments[] | The deployment resources present in the API hub. |
next_page_token |
A token, which can be sent as |
ListExternalApisRequest
The ListExternalApis method's request.
| Fields | |
|---|---|
parent |
Required. The parent, which owns this collection of External API resources. Format: |
page_size |
Optional. The maximum number of External API resources to return. The service may return fewer than this value. If unspecified, at most 50 ExternalApis will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
ListExternalApisResponse
The ListExternalApis method's response.
| Fields | |
|---|---|
external_apis[] | The External API resources present in the API hub. |
next_page_token |
A token, which can be sent as |
ListHostProjectRegistrationsRequest
The ListHostProjectRegistrations method's request.
| Fields | |
|---|---|
parent |
Required. The parent, which owns this collection of host projects. Format: |
page_size |
Optional. The maximum number of host project registrations to return. The service may return fewer than this value. If unspecified, at most 50 host project registrations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
filter |
Optional. An expression that filters the list of HostProjectRegistrations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the
|
order_by |
Optional. Hint for how to order the results. |
ListHostProjectRegistrationsResponse
The ListHostProjectRegistrations method's response.
| Fields | |
|---|---|
host_project_registrations[] | The list of host project registrations. |
next_page_token |
A token, which can be sent as |
ListPluginInstancesRequest
The ListPluginInstances method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource where this plugin will be created. Format: |
filter |
Optional. An expression that filters the list of plugin instances. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: The following fields in the
Expressions are combined with either
|
page_size |
Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListPluginInstancesResponse
The ListPluginInstances method's response.
| Fields | |
|---|---|
plugin_instances[] | The plugin instances from the specified parent resource. |
next_page_token |
A token, which can be sent as |
ListPluginsRequest
The ListPlugins method's request.
| Fields | |
|---|---|
parent |
Required. The parent resource where this plugin will be created. Format: |
filter |
Optional. An expression that filters the list of plugins. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: The following fields in the
Expressions are combined with either
|
page_size |
Optional. The maximum number of hub plugins to return. The service may return fewer than this value. If unspecified, at most 50 hub plugins will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
ListPluginsResponse
The ListPlugins method's response.
| Fields | |
|---|---|
plugins[] | The plugins from the specified parent resource. |
next_page_token |
A token, which can be sent as |
ListRuntimeProjectAttachmentsRequest
The ListRuntimeProjectAttachments method's request.
| Fields | |
|---|---|
parent |
Required. The parent, which owns this collection of runtime project attachments. Format: |
page_size |
Optional. The maximum number of runtime project attachments to return. The service may return fewer than this value. If unspecified, at most 50 runtime project attachments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
filter |
Optional. An expression that filters the list of RuntimeProjectAttachments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the
|
order_by |
Optional. Hint for how to order the results. |
ListRuntimeProjectAttachmentsResponse
The ListRuntimeProjectAttachments method's response.
| Fields | |
|---|---|
runtime_project_attachments[] | List of runtime project attachments. |
next_page_token |
A token, which can be sent as |
ListSpecsRequest
The [ListSpecs][ListSpecs] method's request.
| Fields | |
|---|---|
parent |
Required. The parent, which owns this collection of specs. Format: |
filter |
Optional. An expression that filters the list of Specs. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: The following fields in the
Expressions are combined with either Here are a few examples:
|
page_size |
Optional. The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 specs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters provided to |
ListSpecsResponse
The ListSpecs method's response.
| Fields | |
|---|---|
specs[] | The specs corresponding to an API Version. |
next_page_token |
A token, which can be sent as |
ListVersionsRequest
The ListVersions method's request.
| Fields | |
|---|---|
parent |
Required. The parent which owns this collection of API versions i.e., the API resource Format: |
filter |
Optional. An expression that filters the list of Versions. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: The following fields in the
Expressions are combined with either Here are a few examples:
|
page_size |
Optional. The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
page_token |
Optional. A page token, received from a previous When paginating, all other parameters (except page_size) provided to |
ListVersionsResponse
The ListVersions method's response.
| Fields | |
|---|---|
versions[] | The versions corresponding to an API. |
next_page_token |
A token, which can be sent as |
LookupApiHubInstanceRequest
The LookupApiHubInstance method's request.
| Fields | |
|---|---|
parent |
Required. There will always be only one Api Hub instance for a Google Cloud project across all locations. The parent resource for the Api Hub instance resource. Format: |
LookupApiHubInstanceResponse
The LookupApiHubInstance method's response.`
| Fields | |
|---|---|
api_hub_instance | API hub instance for a project if it exists, empty otherwise. |
LookupRuntimeProjectAttachmentRequest
The LookupRuntimeProjectAttachment method's request.
| Fields | |
|---|---|
name |
Required. Runtime project ID to look up runtime project attachment for. Lookup happens across all regions. Expected format: |
LookupRuntimeProjectAttachmentResponse
The ListRuntimeProjectAttachments method's response.
| Fields | |
|---|---|
runtime_project_attachment | Runtime project attachment for a project if exists, empty otherwise. |
OpenApiSpecDetails
OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails.
| Fields | |
|---|---|
format | Output only. The format of the spec. |
version |
Output only. The version in the spec. This maps to |
owner | Output only. Owner details for the spec. This maps to |
Format
Enumeration of spec formats.
| Enums | |
|---|---|
FORMAT_UNSPECIFIED | SpecFile type unspecified. |
OPEN_API_SPEC_2_0 | OpenAPI Spec v2.0. |
OPEN_API_SPEC_3_0 | OpenAPI Spec v3.0. |
OPEN_API_SPEC_3_1 | OpenAPI Spec v3.1. |
OperationDetails
The operation details parsed from the spec.
| Fields | |
|---|---|
description |
Optional. Description of the operation behavior. For OpenAPI spec, this will map to |
documentation | Optional. Additional external documentation for this operation. For OpenAPI spec, this will map to |
deprecated |
Optional. For OpenAPI spec, this will be set if |
Union field
| |
http_operation | The HTTP Operation. |
OperationMetadata
Represents the metadata of the long-running operation.
| Fields | |
|---|---|
create_time | Output only. The time the operation was created. |
end_time | Output only. The time the operation finished running. |
target |
Output only. Server-defined resource path for the target of the operation. |
verb |
Output only. Name of the verb executed by the operation. |
status_message |
Output only. Human-readable status of the operation, if any. |
requested_cancellation |
Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have |
api_version |
Output only. API version used to start the operation. |
Owner
Owner details.
| Fields | |
|---|---|
display_name |
Optional. The name of the owner. |
email |
Required. The email of the owner. |
Path
The path details derived from the spec.
| Fields | |
|---|---|
path |
Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for |
description |
Optional. A short description for the path applicable to all operations. |
Plugin
A plugin resource in the API hub.
| Fields | |
|---|---|
name |
Identifier. The name of the plugin. Format: |
display_name |
Required. The display name of the plugin. Max length is 50 characters (Unicode code points). |
type | Optional. The type of the API. This maps to the following system defined attribute: |
description |
Optional. The plugin description. Max length is 2000 characters (Unicode code points). |
state | Output only. Represents the state of the plugin. Note this field will not be set for plugins developed via plugin framework as the state will be managed at plugin instance level. |
ownership_type | Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'. |
hosting_service | Optional. This field is optional. It is used to notify the plugin hosting service for any lifecycle changes of the plugin instance and trigger execution of plugin instance actions in case of API hub managed actions. This field should be provided if the plugin instance lifecycle of the developed plugin needs to be managed from API hub. Also, in this case the plugin hosting service interface needs to be implemented. This field should not be provided if the plugin wants to manage plugin instance lifecycle events outside of hub interface and use plugin framework for only registering of plugin and plugin instances to capture the source of data into hub. Note, in this case the plugin hosting service interface is not required to be implemented. Also, the plugin instance lifecycle actions will be disabled from API hub's UI. |
actions_config[] | Optional. The configuration of actions supported by the plugin. |
documentation | Optional. The documentation of the plugin, that explains how to set up and use the plugin. |
plugin_category | Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins. |
config_template | Optional. The configuration template for the plugin. |
create_time | Output only. Timestamp indicating when the plugin was created. |
update_time | Output only. Timestamp indicating when the plugin was last updated. |
ConfigTemplate
ConfigTemplate represents the configuration template for a plugin.
| Fields | |
|---|---|
auth_config_template | Optional. The authentication template for the plugin. |
additional_config_template[] | Optional. The list of additional configuration variables for the plugin's configuration. |
AuthConfigTemplate
AuthConfigTemplate represents the authentication template for a plugin.
| Fields | |
|---|---|
supported_auth_types[] | Required. The list of authentication types supported by the plugin. |
service_account | Optional. The service account of the plugin hosting service. This service account should be granted the required permissions on the Auth Config parameters provided while creating the plugin instances corresponding to this plugin. For example, if the plugin instance auth config requires a secret manager secret, the service account should be granted the secretmanager.versions.access permission on the corresponding secret, if the plugin instance auth config contains a service account, the service account should be granted the iam.serviceAccounts.getAccessToken permission on the corresponding service account. |
HostingService
The information related to the service implemented by the plugin developer, used to invoke the plugin's functionality.
| Fields | |
|---|---|
service_uri |
Optional. The URI of the service implemented by the plugin developer, used to invoke the plugin's functionality. This information is only required for user defined plugins. |
OwnershipType
Ownership type of the plugin.
| Enums | |
|---|---|
OWNERSHIP_TYPE_UNSPECIFIED | Default unspecified type. |
SYSTEM_OWNED | System owned plugins are defined by API hub and are available out of the box in API hub. |
USER_OWNED | User owned plugins are defined by the user and need to be explicitly added to API hub via CreatePlugin method. |
State
Possible states a plugin can have. Note that this enum may receive new values in the future. Consumers are advised to always code against the enum values expecting new states can be added later on.
| Enums | |
|---|---|
STATE_UNSPECIFIED | The default value. This value is used if the state is omitted. |
ENABLED | The plugin is enabled. |
DISABLED | The plugin is disabled. |
PluginActionConfig
PluginActionConfig represents the configuration of an action supported by a plugin.
| Fields | |
|---|---|
id |
Required. The id of the action. |
display_name |
Required. The display name of the action. |
description |
Required. The description of the operation performed by the action. |
trigger_mode | Required. The trigger mode supported by the action. |
TriggerMode
Execution mode of the action.
| Enums | |
|---|---|
TRIGGER_MODE_UNSPECIFIED | Default unspecified mode. |
API_HUB_ON_DEMAND_TRIGGER | This action can be executed by invoking ExecutePluginInstanceAction API with the given action id. To support this, the plugin hosting service should handle this action id as part of execute call. |
API_HUB_SCHEDULE_TRIGGER | This action will be executed on schedule by invoking ExecutePluginInstanceAction API with the given action id. To set the schedule, the user can provide the cron expression in the [PluginAction][PluginAction.schedule_cron_expression] field for a given plugin instance. To support this, the plugin hosting service should handle this action id as part of execute call. Note, on demand execution will be supported by default in this trigger mode. |
NON_API_HUB_MANAGED | The execution of this plugin is not handled by API hub. In this case, the plugin hosting service need not handle this action id as part of the execute call. |
PluginCategory
Enum for the plugin category.
| Enums | |
|---|---|
PLUGIN_CATEGORY_UNSPECIFIED | Default unspecified plugin type. |
API_GATEWAY | API_GATEWAY plugins represent plugins built for API Gateways like Apigee. |
API_PRODUCER | API_PRODUCER plugins represent plugins built for API Producers like Cloud Run, Application Integration etc. |
PluginInstance
Represents a plugin instance resource in the API hub. A PluginInstance is a specific instance of a hub plugin with its own configuration, state, and execution details.
| Fields | |
|---|---|
name |
Identifier. The unique name of the plugin instance resource. Format: |
display_name |
Required. The display name for this plugin instance. Max length is 255 characters. |
auth_config | Optional. The authentication information for this plugin instance. |
additional_config |
Optional. The additional information for this plugin instance corresponding to the additional config template of the plugin. This information will be sent to plugin hosting service on each call to plugin hosted service. The key will be the config_variable_template.display_name to uniquely identify the config variable. |
state | Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning). |
error_message |
Output only. Error message describing the failure, if any, during Create, Delete or ApplyConfig operation corresponding to the plugin instance.This field will only be populated if the plugin instance is in the ERROR or FAILED state. |
actions[] | Required. The action status for the plugin instance. |
create_time | Output only. Timestamp indicating when the plugin instance was created. |
update_time | Output only. Timestamp indicating when the plugin instance was last updated. |
State
State represents the state of the plugin instance.
| Enums | |
|---|---|
STATE_UNSPECIFIED | Default unspecified state. |
CREATING | The plugin instance is being created. |
ACTIVE | The plugin instance is active and ready for executions. This is the only state where executions can run on the plugin instance. |
APPLYING_CONFIG | The updated config that contains additional_config and auth_config is being applied. |
ERROR | The ERROR state can come while applying config. Users can retrigger ApplyPluginInstanceConfig to restore the plugin instance back to active state. Note, In case the ERROR state happens while applying config (auth_config, additional_config), the plugin instance will reflect the config which was trying to be applied while error happened. In order to overwrite, trigger ApplyConfig with a new config. |
FAILED | The plugin instance is in a failed state. This indicates that an unrecoverable error occurred during a previous operation (Create, Delete). |
DELETING | The plugin instance is being deleted. Delete is only possible if there is no other operation running on the plugin instance and plugin instance action. |
PluginInstanceAction
PluginInstanceAction represents an action which can be executed in the plugin instance.
| Fields | |
|---|---|
action_id |
Required. This should map to one of the |
state | Output only. The current state of the plugin action in the plugin instance. |
schedule_cron_expression |
Optional. The schedule for this plugin instance action. This can only be set if the plugin supports API_HUB_SCHEDULE_TRIGGER mode for this action. |
curation_config | Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer. |
schedule_time_zone |
Optional. The time zone for the schedule cron expression. If not provided, UTC will be used. |
Union field action_status. The status of the plugin action. action_status can be only one of the following: | |
hub_instance_action | Optional. The execution information for the plugin instance action done corresponding to an API hub instance. |
State
State represents the state of the plugin instance action.
| Enums | |
|---|---|
STATE_UNSPECIFIED | Default unspecified state. |
ENABLED | The action is enabled in the plugin instance i.e., executions can be triggered for this action. |
DISABLED | The action is disabled in the plugin instance i.e., no executions can be triggered for this action. This state indicates that the user explicitly disabled the instance, and no further action is needed unless the user wants to re-enable it. |
ENABLING | The action in the plugin instance is being enabled. |
DISABLING | The action in the plugin instance is being disabled. |
ERROR | The ERROR state can come while enabling/disabling plugin instance action. Users can retrigger enable, disable via EnablePluginInstanceAction and DisablePluginInstanceAction to restore the action back to enabled/disabled state. Note enable/disable on actions can only be triggered if plugin instance is in Active state. |
Point
Point within the file (line and character).
| Fields | |
|---|---|
line |
Required. Line number (zero-indexed). |
character |
Required. Character position within the line (zero-indexed). |
Range
Object describing where in the file the issue was found.
| Fields | |
|---|---|
start | Required. Start of the issue. |
end | Required. End of the issue. |
RuntimeProjectAttachment
Runtime project attachment represents an attachment from the runtime project to the host project. Api Hub looks for deployments in the attached runtime projects and creates corresponding resources in Api Hub for the discovered deployments.
| Fields | |
|---|---|
name |
Identifier. The resource name of a runtime project attachment. Format: "projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}". |
runtime_project |
Required. Immutable. Google cloud project name in the format: "projects/abc" or "projects/123". As input, project name with either project id or number are accepted. As output, this field will contain project number. |
create_time | Output only. Create time. |
Schema
The schema details derived from the spec. Currently, this entity is supported for OpenAPI spec only. For OpenAPI spec, this maps to the schema defined in the definitions section for OpenAPI 2.0 version and in components.schemas section for OpenAPI 3.0 and 3.1 version.
| Fields | |
|---|---|
display_name |
Output only. The display name of the schema. This will map to the name of the schema in the spec. |
raw_value |
Output only. The raw value of the schema definition corresponding to the schema name in the spec. |
SearchResourcesRequest
The SearchResources method's request.
| Fields | |
|---|---|
location |
Required. The resource name of the location which will be of the type |
query |
Required. The free text search query. This query can contain keywords which could be related to any detail of the API-Hub resources such display names, descriptions, attributes etc. |
filter |
Optional. An expression that filters the list of search results. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be The following field names are eligible for filtering: * Here are is an example:
|
page_size |
Optional. The maximum number of search results to return. The service may return fewer than this value. If unspecified at most 10 search results will be returned. If value is negative then |
page_token |
Optional. A page token, received from a previous [SearchResources][SearchResources] call. Specify this parameter to retrieve the next page of transactions. When paginating, you must specify the |
SearchResourcesResponse
Response for the SearchResources method.
| Fields | |
|---|---|
search_results[] | List of search results according to the filter and search query specified. The order of search results represents the ranking. |
next_page_token |
Pass this token in the |
SearchResult
Represents the search results.
| Fields | |
|---|---|
resource | This represents the ApiHubResource. Note: Only selected fields of the resources are populated in response. |
Secret
Secret provides a reference to entries in Secret Manager.
| Fields | |
|---|---|
secret_version |
Required. The resource name of the secret version in the format, format as: |
Severity
Severity of the issue.
| Enums | |
|---|---|
SEVERITY_UNSPECIFIED | Severity unspecified. |
SEVERITY_ERROR | Severity error. |
SEVERITY_WARNING | Severity warning. |
SEVERITY_INFO | Severity info. |
SEVERITY_HINT | Severity hint. |
SourceMetadata
SourceMetadata represents the metadata for a resource at the source.
| Fields | |
|---|---|
source_type | Output only. The type of the source. |
original_resource_id |
Output only. The unique identifier of the resource at the source. |
original_resource_create_time | Output only. The time at which the resource was created at the source. |
original_resource_update_time | Output only. The time at which the resource was last updated at the source. |
Union field source. The source of the resource. source can be only one of the following: | |
plugin_instance_action_source | Output only. The source of the resource is a plugin instance action. |
PluginInstanceActionSource
PluginInstanceActionSource represents the plugin instance action source.
| Fields | |
|---|---|
plugin_instance |
Output only. The resource name of the source plugin instance. Format is |
action_id |
Output only. The id of the plugin instance action. |
SourceType
The possible types of the source.
| Enums | |
|---|---|
SOURCE_TYPE_UNSPECIFIED | Source type not specified. |
PLUGIN | Source type plugin. |
Spec
Represents a spec associated with an API version in the API hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.
| Fields | |
|---|---|
name |
Identifier. The name of the spec. Format: |
display_name |
Required. The display name of the spec. This can contain the file name of the spec. |
spec_type | Required. The type of spec. The value should be one of the allowed values defined for Note, this field is mandatory if content is provided. |
contents | Optional. Input only. The contents of the uploaded spec. |
details | Output only. Details parsed from the spec. |
source_uri |
Optional. The URI of the spec source in case file is uploaded from an external version control system. |
create_time | Output only. The time at which the spec was created. |
update_time | Output only. The time at which the spec was last updated. |
lint_response | Optional. The lint response for the spec. |
attributes |
Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: |
documentation | Optional. The documentation of the spec. For OpenAPI spec, this will be populated from |
parsing_mode | Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing. |
source_metadata[] | Output only. The list of sources and metadata from the sources of the spec. |
ParsingMode
Specifies the parsing mode for API specifications during creation and update. - RELAXED: Parsing errors in the specification content do not fail the API call. - STRICT: Parsing errors in the specification content result in failure of the API call. If not specified, defaults to RELAXED.
| Enums | |
|---|---|
PARSING_MODE_UNSPECIFIED | Defaults to RELAXED. |
RELAXED | Parsing of the Spec on create and update is relaxed, meaning that parsing errors the spec contents will not fail the API call. |
STRICT | Parsing of the Spec on create and update is strict, meaning that parsing errors in the spec contents will fail the API call. |
SpecContents
The spec contents.
| Fields | |
|---|---|
contents |
Required. The contents of the spec. |
mime_type |
Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc. |
SpecDetails
SpecDetails contains the details parsed from supported spec types.
| Fields | |
|---|---|
description |
Output only. The description of the spec. |
Union field
| |
open_api_spec_details | Output only. Additional details apart from |
SpecMetadata
The metadata associated with a spec of the API version.
| Fields | |
|---|---|
spec | Required. The spec resource to be pushed to Hub's collect layer. The ID of the spec will be generated by Hub. |
original_id |
Optional. The unique identifier of the spec in the system where it was originally created. |
original_create_time | Optional. Timestamp indicating when the spec was created at the source. |
original_update_time | Required. Timestamp indicating when the spec was last updated at the source. |
StyleGuide
Represents a singleton style guide resource to be used for linting Open API specs.
| Fields | |
|---|---|
name |
Identifier. The name of the style guide. Format: |
linter | Required. Target linter for the style guide. |
contents | Required. Input only. The contents of the uploaded style guide. |
StyleGuideContents
The style guide contents.
| Fields | |
|---|---|
contents |
Required. The contents of the style guide. |
mime_type |
Required. The mime type of the content. |
UpdateApiOperationRequest
The UpdateApiOperation method's request.
| Fields | |
|---|---|
api_operation | Required. The apiOperation resource to update. The operation resource's |
update_mask | Required. The list of fields to update. |
UpdateApiRequest
The UpdateApi method's request.
| Fields | |
|---|---|
api | Required. The API resource to update. The API resource's |
update_mask | Required. The list of fields to update. |
UpdateAttributeRequest
The UpdateAttribute method's request.
| Fields | |
|---|---|
attribute | Required. The attribute to update. The attribute's |
update_mask | Required. The list of fields to update. |
UpdateCurationRequest
The [UpdateCuration][ApiHub.UpdateCuration] method's request.
| Fields | |
|---|---|
curation | Required. The curation resource to update. The curation resource's |
update_mask | Optional. The list of fields to update. |
UpdateDependencyRequest
The UpdateDependency method's request.
| Fields | |
|---|---|
dependency | Required. The dependency resource to update. The dependency's |
update_mask | Required. The list of fields to update. |
UpdateDeploymentRequest
The UpdateDeployment method's request.
| Fields | |
|---|---|
deployment | Required. The deployment resource to update. The deployment resource's |
update_mask | Required. The list of fields to update. |
UpdateExternalApiRequest
The UpdateExternalApi method's request.
| Fields | |
|---|---|
external_api | Required. The External API resource to update. The External API resource's |
update_mask | Required. The list of fields to update. |
UpdateSpecRequest
The UpdateSpec method's request.
| Fields | |
|---|---|
spec | Required. The spec to update. The spec's |
update_mask | Required. The list of fields to update. |
UpdateStyleGuideRequest
The UpdateStyleGuide method's request.
| Fields | |
|---|---|
style_guide | Required. The Style guide resource to update. |
update_mask | Optional. The list of fields to update. |
UpdateVersionRequest
The UpdateVersion method's request.
| Fields | |
|---|---|
version | Required. The API version to update. The version's |
update_mask | Required. The list of fields to update. |
Version
Represents a version of the API resource in API hub. This is also referred to as the API version.
| Fields | |
|---|---|
name |
Identifier. The name of the version. Format: |
display_name |
Required. The display name of the version. |
description |
Optional. The description of the version. |
documentation | Optional. The documentation of the version. |
specs[] |
Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is |
api_operations[] |
Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is |
definitions[] |
Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is |
deployments[] |
Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is |
create_time | Output only. The time at which the version was created. |
update_time | Output only. The time at which the version was last updated. |
lifecycle | Optional. The lifecycle of the API version. This maps to the following system defined attribute: |
compliance | Optional. The compliance associated with the API version. This maps to the following system defined attribute: |
accreditation | Optional. The accreditations associated with the API version. This maps to the following system defined attribute: |
attributes |
Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: |
selected_deployment |
Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is |
source_metadata[] | Output only. The list of sources and metadata from the sources of the version. |
VersionMetadata
The metadata associated with a version of the API resource.
| Fields | |
|---|---|
version | Required. Represents a version of the API resource in API hub. The ID of the version will be generated by Hub. |
specs[] | Optional. The specs associated with this version. Note that an API version can be associated with multiple specs. |
deployments[] | Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc.) |
original_id |
Optional. The unique identifier of the version in the system where it was originally created. |
original_create_time | Optional. Timestamp indicating when the version was created at the source. |
original_update_time | Required. Timestamp indicating when the version was last updated at the source. |
