Package google.cloud.apihub.v1

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secrete}/versions/{version} . The secretmanager.versions.access permission should be granted to the service account accessing the secret.

http_element_location

HttpElementLocation

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

Fields
`client_id`	`string` Required. The client identifier.
`client_secret`	`Secret` Required. Secret version reference containing the client secret. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.

client_id

string

Required. The client identifier.

client_secret

Required. Secret version reference containing the client secret. The secretmanager.versions.access permission should be granted to the service account accessing the secret.

UserPasswordConfig

Parameters to support Username and Password Authentication.

Fields

Fields
`username`	`string` Required. Username.
`password`	`Secret` Required. Secret version reference containing the password. The `secretmanager.versions.access` permission should be granted to the service account accessing the secret.

username

string

Required. Username.

password

Required. Secret version reference containing the password. The secretmanager.versions.access permission should be granted to the service account accessing the secret.

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`	`string` Required. The regional location of the API hub instance and its resources. Format: `projects/{project}/locations/{location}`
`collection_type`	`CollectionType` Required. The type of collection. Applies to all entries in `api_data` .
`plugin_instance`	`string` Required. The plugin instance collecting the API data. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}` .
`action_id`	`string` 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`	`ApiData` 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

Fields
`id`	`string` Required. Id of the option.
`display_name`	`string` Required. Display name of the option.
`description`	`string` Optional. Description of the option.

id

string

Required. Id of the option.

display_name

string

Required. Display name of the option.

description

string

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

string

Output only. Key will be the id to uniquely identify the config variable.

Union field value . The values associated with the config variable. value can be only one of the following:

string_value

string

Optional. The config variable value in case of config variable of type string.

int_value

int64

Optional. The config variable value in case of config variable of type integer.

bool_value

bool

Optional. The config variable value in case of config variable of type boolean.

secret_value

HostProjectRegistration

Optional. The config variable value in case of config variable of type secret.

enum_value

ConfigValueOption

Optional. The config variable value in case of config variable of type enum.

multi_select_values

MultiSelectValues

Optional. The config variable value in case of config variable of type multi select.

multi_string_values

MultiStringValues

Optional. The config variable value in case of config variable of type multi string.

multi_int_values

MultiIntValues

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

Fields
`values[]`	`int32` Optional. The config variable value of data type multi int.

values[]

int32

Optional. The config variable value of data type multi int.

MultiSelectValues

The config variable value of data type multi select.

Fields

Fields
`values[]`	`ConfigValueOption` Optional. The config variable value of data type multi select.

values[]

ConfigValueOption

Optional. The config variable value of data type multi select.

MultiStringValues

The config variable value of data type multi string.

Fields

Fields
`values[]`	`string` Optional. The config variable value of data type multi string.

values[]

string

Optional. The config variable value of data type multi string.

ConfigVariableTemplate

ConfigVariableTemplate represents a configuration variable template present in a Plugin Config.

Fields
`id`	`string` Required. ID of the config variable. Must be unique within the configuration.
`value_type`	`ValueType` Required. Type of the parameter: string, int, bool etc.
`description`	`string` Optional. Description.
`validation_regex`	`string` Optional. Regular expression in RE2 syntax used for validating the `value` of a `ConfigVariable` .
`required`	`bool` Optional. Flag represents that this `ConfigVariable` must be provided for a PluginInstance.
`enum_options[]`	`ConfigValueOption` Optional. Enum options. To be populated if `ValueType` is `ENUM` .
`multi_select_options[]`	`ConfigValueOption` Optional. Multi select options. To be populated if `ValueType` is `MULTI_SELECT` .

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

Fields
`parent`	`string` Required. The parent resource for the Api Hub instance resource. Format: `projects/{project}/locations/{location}`
`api_hub_instance_id`	`string` 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 `/[a-z][A-Z][0-9]-_/` .
`api_hub_instance`	`ApiHubInstance` Required. The ApiHub instance.

parent

string

Required. The parent resource for the Api Hub instance resource. Format: projects/{project}/locations/{location}

api_hub_instance_id

string

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 /[a-z][A-Z][0-9]-_/ .

api_hub_instance

ApiHubInstance

Required. The ApiHub instance.

CreateApiOperationRequest

The CreateApiOperation method's request.

Fields

parent

string

Required. The parent resource for the operation resource. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

api_operation_id

string

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.

If provided, the same will be used. The service will throw an error if the specified id is already used by another operation resource in the API hub.
If not provided, a system generated id will be used.

This value should be 4-500 characters, overall resource name which will be of format projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation} , its length is limited to 700 characters, and valid characters are /[a-z][A-Z][0-9]-_/.

api_operation

ApiOperation

Required. The operation resource to create.

CreateApiRequest

The CreateApi method's request.

Fields

parent

string

Required. The parent resource for the API resource. Format: projects/{project}/locations/{location}

api_id

string

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.

If provided, the same will be used. The service will throw an error if the specified id is already used by another API resource in the API hub.
If not provided, a system generated id will be used.

This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/.

api

Api

Required. The API resource to create.

CreateAttributeRequest

The CreateAttribute method's request.

Fields

parent

string

Required. The parent resource for Attribute. Format: projects/{project}/locations/{location}

attribute_id

string

Optional. The ID to use for the attribute, which will become the final component of the attribute's resource name. This field is optional.

If provided, the same will be used. The service will throw an error if the specified id is already used by another attribute resource in the API hub.
If not provided, a system generated id will be used.

This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/.

attribute

Attribute

Required. The attribute to create.

CreateCurationRequest

The [CreateCuration][ApiHub.CreateCuration] method's request.

Fields

parent

string

Required. The parent resource for the curation resource. Format: projects/{project}/locations/{location}

curation_id

string

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.

If provided, the same will be used. The service will throw an error if the specified ID is already used by another curation resource in the API hub.
If not provided, a system generated ID will be used.

This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/.

curation

Curation

Required. The curation resource to create.

CreateDependencyRequest

The CreateDependency method's request.

Fields

Fields
`parent`	`string` Required. The parent resource for the dependency resource. Format: `projects/{project}/locations/{location}`
`dependency_id`	`string` 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 `[a-z][A-Z][0-9]-_` .
`dependency`	`Dependency` Required. The dependency resource to create.

parent

string

Required. The parent resource for the dependency resource. Format: projects/{project}/locations/{location}

dependency_id

string

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 [a-z][A-Z][0-9]-_ .

dependency

Dependency

Required. The dependency resource to create.

CreateDeploymentRequest

The CreateDeployment method's request.

Fields

parent

string

Required. The parent resource for the deployment resource. Format: projects/{project}/locations/{location}

deployment_id

string

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.

If provided, the same will be used. The service will throw an error if the specified id is already used by another deployment resource in the API hub.
If not provided, a system generated id will be used.

This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/.

deployment

Deployment

Required. The deployment resource to create.

CreateExternalApiRequest

The CreateExternalApi method's request.

Fields

parent

string

Required. The parent resource for the External API resource. Format: projects/{project}/locations/{location}

external_api_id

string

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.

If provided, the same will be used. The service will throw an error if the specified id is already used by another External API resource in the API hub.
If not provided, a system generated id will be used.

This value should be 4-500 characters, and valid characters are /[a-z][A-Z][0-9]-_/.

external_api

ExternalApi

Required. The External API resource to create.

CreateHostProjectRegistrationRequest

The CreateHostProjectRegistration method's request.

Fields

Fields
`parent`	`string` Required. The parent resource for the host project. Format: `projects/{project}/locations/{location}`
`host_project_registration_id`	`string` 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`	`HostProjectRegistration` Required. The host project registration to register.

parent

string

Required. The parent resource for the host project. Format: projects/{project}/locations/{location}

host_project_registration_id

string

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

string

Required. The parent of the plugin instance resource. Format: projects/{project}/locations/{location}/plugins/{plugin}

plugin_instance_id

string

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.

If provided, the same will be used. The service will throw an error if the specified id is already used by another plugin instance in the plugin resource.
If not provided, a system generated id will be used.

This value should be 4-63 characters, and valid characters are /[a-z][A-Z][0-9]-_/.

plugin_instance

PluginInstance

Required. The plugin instance to create.

CreatePluginRequest

The CreatePlugin method's request.

Fields

parent

string

Required. The parent resource where this plugin will be created. Format: projects/{project}/locations/{location} .

plugin_id

string

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.

If provided, the same will be used. The service will throw an error if the specified id is already used by another Plugin resource in the API hub instance.
If not provided, a system generated id will be used.

This value should be 4-63 characters, overall resource name which will be of format projects/{project}/locations/{location}/plugins/{plugin} , its length is limited to 1000 characters and valid characters are /[a-z][A-Z][0-9]-_/.

plugin

RuntimeProjectAttachment

Required. The plugin to create.

CreateRuntimeProjectAttachmentRequest

The CreateRuntimeProjectAttachment method's request.

Fields

Fields
`parent`	`string` Required. The parent resource for the Runtime Project Attachment. Format: `projects/{project}/locations/{location}`
`runtime_project_attachment_id`	`string` 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`	`RuntimeProjectAttachment` Required. The Runtime Project Attachment to create.

parent

string

Required. The parent resource for the Runtime Project Attachment. Format: projects/{project}/locations/{location}

runtime_project_attachment_id

string

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

string

Required. The parent resource for Spec. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

spec_id

string

Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional.

If provided, the same will be used. The service will throw an error if the specified id is already used by another spec in the API resource.
If not provided, a system generated id will be used.

This value should be 4-500 characters, overall resource name which will be of format projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec} , its length is limited to 1000 characters and valid characters are /[a-z][A-Z][0-9]-_/.

spec

Spec

Required. The spec to create.

CreateVersionRequest

The CreateVersion method's request.

Fields

parent

string

Required. The parent resource for API version. Format: projects/{project}/locations/{location}/apis/{api}

version_id

string

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.

If provided, the same will be used. The service will throw an error if the specified id is already used by another version in the API resource.
If not provided, a system generated id will be used.

This value should be 4-500 characters, overall resource name which will be of format projects/{project}/locations/{location}/apis/{api}/versions/{version} , its length is limited to 700 characters and valid characters are /[a-z][A-Z][0-9]-_/.

version

Version

Required. The version to create.

Curation

A curation resource in the API Hub.

Fields
`name`	`string` Identifier. The name of the curation. Format: `projects/{project}/locations/{location}/curations/{curation}`
`display_name`	`string` Required. The display name of the curation.
`description`	`string` Optional. The description of the curation.
`endpoint`	`Endpoint` Required. The endpoint to be triggered for curation.
`plugin_instance_actions[]`	`PluginInstanceActionID` 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`	`LastExecutionState` Output only. The last execution state of the curation.
`last_execution_error_code`	`ErrorCode` 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`	`string` Output only. Error message describing the failure, if any, during the last execution of the curation.
`create_time`	`Timestamp` Output only. The time at which the curation was created.
`update_time`	`Timestamp` 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

Fields
`plugin_instance`	`string` Output only. Plugin instance that is using the curation. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
`action_id`	`string` 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.

plugin_instance

string

Output only. Plugin instance that is using the curation. Format is projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

action_id

string

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

CurationType

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

CustomCuration

Optional. Custom curation information for this plugin instance.

CustomCuration

Custom curation information for this plugin instance.

Fields

Fields
`curation`	`string` Required. The unique name of the curation resource. This will be the name of the curation resource in the format: `projects/{project}/locations/{location}/curations/{curation}`

curation

string

Required. The unique name of the curation resource. This will be the name of the curation resource in the format: projects/{project}/locations/{location}/curations/{curation}

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

string

Identifier. The name of the definition.

Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}

spec

string

Output only. The name of the spec from where the definition was parsed. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

type

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

map<string, AttributeValues >

Optional. The list of user defined attributes associated with the definition resource. The key is the attribute name. It will be of the format: projects/{project}/locations/{location}/attributes/{attribute} . The value is the attribute values associated with the resource.

Union field value .

value can be only one of the following:

schema

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

Fields
`name`	`string` Required. The name of the Api Hub instance to delete. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}` .

name

string

Required. The name of the Api Hub instance to delete. Format: projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance} .

DeleteApiOperationRequest

The DeleteApiOperation method's request.

Fields

Fields
`name`	`string` Required. The name of the operation resource to delete. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`

name

string

Required. The name of the operation resource to delete. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

DeleteApiRequest

The DeleteApi method's request.

Fields

Fields
`name`	`string` Required. The name of the API resource to delete. Format: `projects/{project}/locations/{location}/apis/{api}`
`force`	`bool` 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.

name

string

Required. The name of the API resource to delete. Format: projects/{project}/locations/{location}/apis/{api}

force

bool

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

Fields
`name`	`string` Required. The name of the attribute to delete. Format: `projects/{project}/locations/{location}/attributes/{attribute}`

name

string

Required. The name of the attribute to delete. Format: projects/{project}/locations/{location}/attributes/{attribute}

DeleteCurationRequest

The [DeleteCuration][ApiHub.DeleteCuration] method's request.

Fields

Fields
`name`	`string` Required. The name of the curation resource to delete. Format: `projects/{project}/locations/{location}/curations/{curation}`

name

string

Required. The name of the curation resource to delete. Format: projects/{project}/locations/{location}/curations/{curation}

DeleteDependencyRequest

The DeleteDependency method's request.

Fields

Fields
`name`	`string` Required. The name of the dependency resource to delete. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`

name

string

Required. The name of the dependency resource to delete. Format: projects/{project}/locations/{location}/dependencies/{dependency}

DeleteDeploymentRequest

The DeleteDeployment method's request.

Fields

Fields
`name`	`string` Required. The name of the deployment resource to delete. Format: `projects/{project}/locations/{location}/deployments/{deployment}`

name

string

Required. The name of the deployment resource to delete. Format: projects/{project}/locations/{location}/deployments/{deployment}

DeleteExternalApiRequest

The DeleteExternalApi method's request.

Fields

Fields
`name`	`string` Required. The name of the External API resource to delete. Format: `projects/{project}/locations/{location}/externalApis/{externalApi}`

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`	`string` Identifier. The name of the dependency in the API Hub. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
`consumer`	`DependencyEntityReference` Required. Immutable. The entity acting as the consumer in the dependency.
`supplier`	`DependencyEntityReference` Required. Immutable. The entity acting as the supplier in the dependency.
`state`	`State` Output only. State of the dependency.
`description`	`string` Optional. Human readable description corresponding of the dependency.
`discovery_mode`	`DiscoveryMode` Output only. Discovery mode of the dependency.
`error_detail`	`DependencyErrorDetail` Output only. Error details of a dependency if the system has detected it internally.
`create_time`	`Timestamp` Output only. The time at which the dependency was created.
`update_time`	`Timestamp` Output only. The time at which the dependency was last updated.
`attributes`	`map<string, AttributeValues >` Optional. The list of user defined attributes associated with the dependency resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}` . The value is the attribute values associated with the resource.

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

string

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

string

The resource name of an operation in the API Hub.

Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}

external_api_resource_name

string

The resource name of an external API in the API Hub.

Format: projects/{project}/locations/{location}/externalApis/{external_api}

DependencyErrorDetail

Details describing error condition of a dependency.

Fields

error

Error

Optional. Error in the dependency.

error_time

ApplicationIntegrationEndpointDetails

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`	`string` Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
`display_name`	`string` Required. The display name of the deployment.
`description`	`string` Optional. The description of the deployment.
`documentation`	`Documentation` Optional. The documentation of the deployment.
`deployment_type`	`AttributeValues` Required. The type of deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-deployment-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
`resource_uri`	`string` Required. The resource URI identifies the deployment within its gateway. For Apigee gateways, its recommended to use the format: organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy with name `orders` is deployed in `staging` environment of `cymbal` organization, the resource URI would be: `organizations/cymbal/environments/staging/apis/orders` .
`endpoints[]`	`string` 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[]`	`string` 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`	`Timestamp` Output only. The time at which the deployment was created.
`update_time`	`Timestamp` Output only. The time at which the deployment was last updated.
`slo`	`AttributeValues` Optional. The SLO for this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-slo` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
`environment`	`AttributeValues` Optional. The environment mapping to this deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-environment` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute.
`attributes`	`map<string, AttributeValues >` Optional. The list of user defined attributes associated with the deployment resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}` . The value is the attribute values associated with the resource.
`source_metadata[]`	`SourceMetadata` Output only. The list of sources and metadata from the sources of the deployment.
`management_url`	`AttributeValues` Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-management-url` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URL.
`source_uri`	`AttributeValues` Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-source-uri` The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.
`source_project`	`string` Optional. The project to which the deployment belongs. For Google Cloud gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier.
`source_environment`	`string` Optional. The environment at source for the deployment. For example: prod, dev, staging, etc.

DeploymentMetadata

The metadata associated with a deployment.

Fields
`deployment`	`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`	`string` Optional. The unique identifier of the deployment in the system where it was originally created.
`original_create_time`	`Timestamp` Optional. Timestamp indicating when the deployment was created at the source.
`original_update_time`	`Timestamp` Required. Timestamp indicating when the deployment was last updated at the source.

DisablePluginInstanceActionRequest

The DisablePluginInstanceAction method's request.

Fields

name

string

Required. The name of the plugin instance to disable. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

action_id

The EnablePluginInstanceAction method's request.

Fields

name

string

Required. The name of the plugin instance to enable. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

action_id

string

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

string

Required. The name of the plugin to enable. Format: projects/{project}/locations/{location}/plugins/{plugin} .

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.

EnumerateExtendedApisRequest

The [EnumerateExtendedApis][InsightsService.EnumerateExtendedApis] method's request.

Fields

parent

string

Required. The parent resource name. Format: projects/{project}/locations/{location} .

filter

string

Optional. The filter expression. The following fields in the Api are eligible for filtering:

api.display_name - The display name of the Api. Allowed comparison operators: = .
api.owner.email - The email of the team which owns the Api. Allowed comparison operators: = .
api.create_time - The time at which the Api was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and < .
api.target_user.enum_values.values.id - The allowed value id of the target users attribute associated with the Api. Allowed comparison operator is : .
api.target_user.enum_values.values.display_name - The allowed value display name of the target users attribute associated with the Api. Allowed comparison operator is : .
api.team.enum_values.values.id - The allowed value id of the team attribute associated with the Api. Allowed comparison operator is : .
api.team.enum_values.values.display_name - The allowed value display name of the team attribute associated with the Api. Allowed comparison operator is : .
api.business_unit.enum_values.values.id - The allowed value id of the business unit attribute associated with the Api. Allowed comparison operator is : .
api.business_unit.enum_values.values.display_name - The allowed value display name of the business unit attribute associated with the Api. Allowed comparison operator is : .
api.maturity_level.enum_values.values.id - The allowed value id of the maturity level attribute associated with the Api. Allowed comparison operator is : .
api.maturity_level.enum_values.values.display_name - The allowed value display name of the maturity level attribute associated with the Api. Allowed comparison operator is : .
api.api_style.enum_values.values.id - The allowed value id of the api style attribute associated with the Api. Allowed comparison operator is : .
api.api_style.enum_values.values.display_name - The allowed value display name of the api style attribute associated with the Api. Allowed comparison operator is : .
spec_count - The number of specs associated with the API. Allowed comparison operator is = .
lint_error_count - The number of lint errors associated with the API. Allowed comparison operator is = .

Expressions are combined with either AND logic operator or OR logical operator but not both of them together i.e. only one of the AND or OR operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then INVALID_ARGUMENT error is returned by the API. A filter function isNull is also supported which can check whether a field is null or not.

Here are a few examples:

owner.email = \"apihub@google.com\" - - The owner team email is _apihub@google.com_ .
owner.email = \"apihub@google.com\" AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The owner team email is _apihub@google.com_ and the api was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC .
owner.email = \"apihub@google.com\" OR team.enum_values.values.id: apihub-team-id - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the id of the allowed value associated with the team attribute is apihub-team-id .
owner.email = \"apihub@google.com\" OR team.enum_values.values.display_name: ApiHub Team - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the display name of the allowed value associated with the team attribute is ApiHub Team .
isNull(\"team\") = \"true\" - The filter string specifies the APIs where the team attribute is null.

page_size

int32

Optional. The maximum number of results to return. Default to 100.

page_token

string

Optional. A page token, received from a previous EnumerateExtendedApis call. Provide this to retrieve the subsequent page.

EnumerateExtendedApisResponse

The [EnumerateExtendedApis][InsightsService.EnumerateExtendedApis] method's response.

Fields

extended_apis[]

ExtendedApi

The list of extended API.

next_page_token

string

Next page token.

ExecutePluginInstanceActionRequest

The ExecutePluginInstanceAction method's request.

Fields

name

string

Required. The name of the plugin instance to execute. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

action_execution_detail

ActionExecutionDetail

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

CurrentExecutionState

Output only. The current state of the execution.

last_execution

LastExecution

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`	`Result` Output only. The result of the last execution of the plugin instance.
`error_message`	`string` Output only. Error message describing the failure, if any, during the last execution.
`start_time`	`Timestamp` Output only. The last execution start time of the plugin instance.
`end_time`	`Timestamp` 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

Api

The API which is extended.

spec_count

int32

The number of specs across all versions.

lint_error_count

int32

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`	`string` Identifier. Format: `projects/{project}/locations/{location}/externalApi/{externalApi}` .
`display_name`	`string` Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
`description`	`string` Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
`endpoints[]`	`string` Optional. List of endpoints on which this API is accessible.
`paths[]`	`string` Optional. List of paths served by this API.
`documentation`	`Documentation` Optional. Documentation of the external API.
`attributes`	`map<string, AttributeValues >` Optional. The list of user defined attributes associated with the Version resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}` . The value is the attribute values associated with the resource.
`create_time`	`Timestamp` Output only. Creation timestamp.
`update_time`	`Timestamp` Output only. Last update timestamp.

GatewayType

Enum for the gateway type.

Enums
`GATEWAY_TYPE_UNSPECIFIED`	The gateway type is not specified.
`APIGEE_X_AND_HYBRID`	The gateway type is Apigee X and Hybrid.
`APIGEE_EDGE_PUBLIC_CLOUD`	The gateway type is Apigee Edge Public Cloud.
`APIGEE_EDGE_PRIVATE_CLOUD`	The gateway type is Apigee Edge Private Cloud.
`CLOUD_API_GATEWAY`	The gateway type is Cloud API Gateway.
`CLOUD_ENDPOINTS`	The gateway type is Cloud Endpoints.
`API_DISCOVERY`	The gateway type is API Discovery.
`OTHERS`	The gateway type for any other types of gateways.

GoogleServiceAccountConfig

Config for Google service account authentication.

Fields

service_account

string

Required. The service account to be used for authenticating request.

The iam.serviceAccounts.getAccessToken permission should be granted on this service account to the impersonator service account.

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

string

Identifier. The name of the host project registration. Format: "projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}".

gcp_project

string

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

Path

Optional. The path details for the Operation. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.

method

Method

Optional. Operation method Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.

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.

InitializeSystemOwnedPluginRequest

The InitializeSystemOwnedPlugin method's request.

Fields

parent

string

Required. The parent resource where this plugin will be created. Format: projects/{project}/locations/{location} .

plugin_id

string

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.

If provided, the same will be used. The service will throw an error if the specified id is already used by another Plugin resource in the API hub instance.
If not provided, a system generated id will be used.

This value should be 4-500 characters, overall resource name which will be of format projects/{project}/locations/{location}/plugins/{plugin} , its length is limited to 1000 characters and valid characters are /[a-z][A-Z][0-9]-_/.

plugin

Required. The plugin to create.

InitializeSystemOwnedPluginResponse

The InitializeSystemOwnedPlugin method's response.

Fields

plugin

HostProjectRegistration

The plugin created.

InsightsMetric

The metric and its aggregation function.

Fields

metric

string

Required. Name of the metric.

aggregation

AggregationFunction

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`	`string` Required. Rule code unique to each rule defined in linter.
`path[]`	`string` Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
`message`	`string` Required. Human-readable message describing the issue found by the linter.
`severity`	`Severity` Required. Severity level of the rule violation.
`range`	`Range` Required. Object describing where in the file the issue was found.

LintResponse

LintResponse contains the response from the linter.

Fields
`issues[]`	`Issue` Optional. Array of issues found in the analyzed document.
`summary[]`	`SummaryEntry` Optional. Summary of all issue types and counts for each severity level.
`state`	`LintState` Required. Lint state represents success or failure for linting.
`source`	`string` Required. Name of the linting application.
`linter`	`Linter` Required. Name of the linter used.
`create_time`	`Timestamp` Required. Timestamp when the linting response was generated.

SummaryEntry

Count of issues with a given severity.

Fields

severity

Severity

Required. Severity of the issue.

count

int32

Required. Count of issues with the given severity.

LintSpecRequest

The LintSpec method's request.

Fields

name

string

Required. The name of the spec to be linted. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

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

string

Required. The parent which owns this collection of operations i.e., the API version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

filter

string

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: < , > or = . Filters are not case sensitive.

The following fields in the ApiOperation are eligible for filtering: * name - The ApiOperation resource name. Allowed comparison operators: = . * details.http_operation.path.path - The http operation's complete path relative to server endpoint. Allowed comparison operators: = . * details.http_operation.method - The http operation method type. Allowed comparison operators: = . * details.deprecated - Indicates if the ApiOperation is deprecated. Allowed values are True / False indicating the deprycation status of the ApiOperation. Allowed comparison operators: = . * create_time - The time at which the ApiOperation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and < . * attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name.

Here are a few examples:

details.deprecated = True - The ApiOperation is deprecated.
details.http_operation.method = GET AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The method of the http operation of the ApiOperation is GET and the spec was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC .
details.http_operation.method = GET OR details.http_operation.method = POST . - The http operation of the method of ApiOperation is GET or POST .
details.deprecated = True AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test - The filter string specifies that the ApiOperation is deprecated and the value of the user defined attribute of type string is test .

page_size

int32

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

string

Optional. A page token, received from a previous ListApiOperations call. Provide this to retrieve the subsequent page.

When paginating, all other parameters (except page_size) provided to ListApiOperations must match the call that provided the page token.

ListApiOperationsResponse

The ListApiOperations method's response.

Fields

api_operations[]

ApiOperation

The operations corresponding to an API version.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListApisRequest

The ListApis method's request.

Fields

parent

string

Required. The parent, which owns this collection of API resources. Format: projects/{project}/locations/{location}

filter

string

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: < , > , : or = . Filters are not case sensitive.

The following fields in the ApiResource are eligible for filtering:

owner.email - The email of the team which owns the ApiResource. Allowed comparison operators: = .
create_time - The time at which the ApiResource was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and < .
display_name - The display name of the ApiResource. Allowed comparison operators: = .
target_user.enum_values.values.id - The allowed value id of the target users attribute associated with the ApiResource. Allowed comparison operator is : .
target_user.enum_values.values.display_name - The allowed value display name of the target users attribute associated with the ApiResource. Allowed comparison operator is : .
team.enum_values.values.id - The allowed value id of the team attribute associated with the ApiResource. Allowed comparison operator is : .
team.enum_values.values.display_name - The allowed value display name of the team attribute associated with the ApiResource. Allowed comparison operator is : .
business_unit.enum_values.values.id - The allowed value id of the business unit attribute associated with the ApiResource. Allowed comparison operator is : .
business_unit.enum_values.values.display_name - The allowed value display name of the business unit attribute associated with the ApiResource. Allowed comparison operator is : .
maturity_level.enum_values.values.id - The allowed value id of the maturity level attribute associated with the ApiResource. Allowed comparison operator is : .
maturity_level.enum_values.values.display_name - The allowed value display name of the maturity level attribute associated with the ApiResource. Allowed comparison operator is : .
api_style.enum_values.values.id - The allowed value id of the api style attribute associated with the ApiResource. Allowed comparison operator is : .
api_style.enum_values.values.display_name - The allowed value display name of the api style attribute associated with the ApiResource. Allowed comparison operator is : .
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name.
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name
The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name.
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name.
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name.

A filter function is also supported in the filter string. The filter function is id(name) . The id(name) function returns the id of the resource name. For example, id(name) = \"api-1\" is equivalent to name = \"projects/test-project-id/locations/test-location-id/apis/api-1\" provided the parent is projects/test-project-id/locations/test-location-id .

Here are a few examples:

owner.email = \"apihub@google.com\" - - The owner team email is _apihub@google.com_ .
owner.email = \"apihub@google.com\" AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The owner team email is _apihub@google.com_ and the api was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC .
owner.email = \"apihub@google.com\" OR team.enum_values.values.id: apihub-team-id - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the id of the allowed value associated with the team attribute is apihub-team-id .
owner.email = \"apihub@google.com\" OR team.enum_values.values.display_name: ApiHub Team - The filter string specifies the APIs where the owner team email is _apihub@google.com_ or the display name of the allowed value associated with the team attribute is ApiHub Team .
owner.email = \"apihub@google.com\" AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id: test_enum_id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/1765\0f90-4a29-5431-b3d0-d5532da3764c.string_values.values: test_string_value - The filter string specifies the APIs where the owner team email is _apihub@google.com_ and the id of the allowed value associated with the user defined attribute of type enum is test_enum_id and the value of the user defined attribute of type string is test ..

page_size

int32

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

string

Optional. A page token, received from a previous ListApis call. Provide this to retrieve the subsequent page.

When paginating, all other parameters (except page_size) provided to ListApis must match the call that provided the page token.

ListApisResponse

The ListApis method's response.

Fields

apis[]

Api

The API resources present in the API hub.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListAttributesRequest

The ListAttributes method's request.

Fields

parent

string

Required. The parent resource for Attribute. Format: projects/{project}/locations/{location}

filter

string

Optional. An expression that filters the list of Attributes.

The following fields in the Attribute are eligible for filtering:

display_name - The display name of the Attribute. Allowed comparison operators: = .
definition_type - The definition type of the attribute. Allowed comparison operators: = .
scope - The scope of the attribute. Allowed comparison operators: = .
data_type - The type of the data of the attribute. Allowed comparison operators: = .
mandatory - Denotes whether the attribute is mandatory or not. Allowed comparison operators: = .
create_time - The time at which the Attribute was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and < .

Here are a few examples:

display_name = production - - The display name of the attribute is production .
(display_name = production) AND (create_time < \"2021-08-15T14:50:00Z\") AND (create_time > \"2021-08-10T12:00:00Z\") - The display name of the attribute is production and the attribute was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC .
display_name = production OR scope = api - The attribute where the display name is production or the scope is api .

page_size

int32

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

string

Optional. A page token, received from a previous ListAttributes call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAttributes must match the call that provided the page token.

ListAttributesResponse

The ListAttributes method's response.

Fields

attributes[]

Attribute

The list of all attributes.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListCurationsRequest

The [ListCurations][ApiHub.ListCurations] method's request.

Fields

parent

string

Required. The parent, which owns this collection of curation resources. Format: projects/{project}/locations/{location}

filter

string

Optional. An expression that filters the list of curation resources.

The following fields in the curation resource are eligible for filtering:

create_time - The time at which the curation was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and < .
display_name - The display name of the curation. Allowed comparison operators: = .
state - The state of the curation. Allowed comparison operators: = .

Here are a few examples:

create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The curation resource was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC .

page_size

int32

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

string

Optional. A page token, received from a previous ListCurations call. Provide this to retrieve the subsequent page.

When paginating, all other parameters (except page_size) provided to ListCurations must match the call that provided the page token.

ListCurationsResponse

The [ListCurations][ApiHub.ListCurations] method's response.

Fields

curations[]

Curation

The curation resources present in the API hub.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListDependenciesRequest

The ListDependencies method's request.

Fields

parent

string

Required. The parent which owns this collection of dependency resources. Format: projects/{project}/locations/{location}

filter

string

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 = . Filters are not case sensitive.

The following fields in the Dependency are eligible for filtering:

consumer.operation_resource_name - The operation resource name for the consumer entity involved in a dependency. Allowed comparison operators: = .
consumer.external_api_resource_name - The external api resource name for the consumer entity involved in a dependency. Allowed comparison operators: = .
supplier.operation_resource_name - The operation resource name for the supplier entity involved in a dependency. Allowed comparison operators: = .
supplier.external_api_resource_name - The external api resource name for the supplier entity involved in a dependency. Allowed comparison operators: = .

For example, consumer.operation_resource_name = \"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\" OR supplier.operation_resource_name = \"projects/p1/locations/global/apis/a1/versions/v1/operations/o1\" - The dependencies with either consumer or supplier operation resource name as projects/p1/locations/global/apis/a1/versions/v1/operations/o1 .

page_size

int32

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

string

Optional. A page token, received from a previous ListDependencies call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListDependencies must match the call that provided the page token.

ListDependenciesResponse

The ListDependencies method's response.

Fields

dependencies[]

Dependency

The dependency resources present in the API hub.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListDeploymentsRequest

The ListDeployments method's request.

Fields

parent

string

Required. The parent, which owns this collection of deployment resources. Format: projects/{project}/locations/{location}

filter

string

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: < , > or = . Filters are not case sensitive.

The following fields in the Deployments are eligible for filtering:

display_name - The display name of the Deployment. Allowed comparison operators: = .
create_time - The time at which the Deployment was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and < .
resource_uri - A URI to the deployment resource. Allowed comparison operators: = .
api_versions - The API versions linked to this deployment. Allowed comparison operators: : .
source_project - The project/organization at source for the deployment. Allowed comparison operators: = .
source_environment - The environment at source for the deployment. Allowed comparison operators: = .
deployment_type.enum_values.values.id - The allowed value id of the deployment_type attribute associated with the Deployment. Allowed comparison operators: : .
deployment_type.enum_values.values.display_name - The allowed value display name of the deployment_type attribute associated with the Deployment. Allowed comparison operators: : .
slo.string_values.values -The allowed string value of the slo attribute associated with the deployment. Allowed comparison operators: : .
environment.enum_values.values.id - The allowed value id of the environment attribute associated with the deployment. Allowed comparison operators: : .
environment.enum_values.values.display_name - The allowed value display name of the environment attribute associated with the deployment. Allowed comparison operators: : .
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name.
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name
The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name.
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name.
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name.

A filter function is also supported in the filter string. The filter function is id(name) . The id(name) function returns the id of the resource name. For example, id(name) = \"deployment-1\" is equivalent to name = \"projects/test-project-id/locations/test-location-id/deployments/deployment-1\" provided the parent is projects/test-project-id/locations/test-location-id .

Here are a few examples:

environment.enum_values.values.id: staging-id - The allowed value id of the environment attribute associated with the Deployment is staging-id .
environment.enum_values.values.display_name: \"Staging Deployment\" - The allowed value display name of the environment attribute associated with the Deployment is Staging Deployment .
environment.enum_values.values.id: production-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The allowed value id of the environment attribute associated with the Deployment is production-id and Deployment was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC .
environment.enum_values.values.id: production-id OR slo.string_values.values: \"99.99%\"
The allowed value id of the environment attribute Deployment is production-id or string value of the slo attribute is 99.99% .
environment.enum_values.values.id: staging-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test - The filter string specifies that the allowed value id of the environment attribute associated with the Deployment is staging-id and the value of the user defined attribute of type string is test .

page_size

int32

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

string

Optional. A page token, received from a previous ListDeployments call. Provide this to retrieve the subsequent page.

When paginating, all other parameters (except page_size) provided to ListDeployments must match the call that provided the page token.

ListDeploymentsResponse

The ListDeployments method's response.

Fields

deployments[]

Deployment

The deployment resources present in the API hub.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListExternalApisRequest

The ListExternalApis method's request.

Fields

parent

string

Required. The parent, which owns this collection of External API resources. Format: projects/{project}/locations/{location}

page_size

int32

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

string

Optional. A page token, received from a previous ListExternalApis call. Provide this to retrieve the subsequent page.

When paginating, all other parameters (except page_size) provided to ListExternalApis must match the call that provided the page token.

ListExternalApisResponse

The ListExternalApis method's response.

Fields

external_apis[]

ExternalApi

The External API resources present in the API hub.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListHostProjectRegistrationsRequest

The ListHostProjectRegistrations method's request.

Fields

parent

string

Required. The parent, which owns this collection of host projects. Format: projects/*/locations/*

page_size

int32

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

string

Optional. A page token, received from a previous ListHostProjectRegistrations call. Provide this to retrieve the subsequent page.

When paginating, all other parameters (except page_size) provided to ListHostProjectRegistrations must match the call that provided the page token.

filter

string

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 HostProjectRegistration are eligible for filtering:

name - The name of the HostProjectRegistration.
create_time - The time at which the HostProjectRegistration was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format.
gcp_project - The Google cloud project associated with the HostProjectRegistration.

order_by

string

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

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListPluginInstancesRequest

The ListPluginInstances method's request.

Fields

parent

string

Required. The parent resource where this plugin will be created. Format: projects/{project}/locations/{location}/plugins/{plugin} . To list plugin instances for multiple plugins, use the - character instead of the plugin ID.

filter

string

Optional. An expression that filters the list of plugin instances.

The following fields in the PluginInstances are eligible for filtering:

state - The state of the Plugin Instance. Allowed comparison operators: = .

A filter function is also supported in the filter string. The filter function is id(name) . The id(name) function returns the id of the resource name. For example, id(name) = \"plugin-instance-1\" is equivalent to name = \"projects/test-project-id/locations/test-location-id/plugins/plugin-1/instances/plugin-instance-1\" provided the parent is projects/test-project-id/locations/test-location-id/plugins/plugin-1 .

state = ENABLED - The plugin instance is in enabled state.

page_size

int32

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

string

Optional. A page token, received from a previous ListPluginInstances call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListPluginInstances must match the call that provided the page token.

ListPluginInstancesResponse

The ListPluginInstances method's response.

Fields

plugin_instances[]

PluginInstance

The plugin instances from the specified parent resource.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListPluginsRequest

The ListPlugins method's request.

Fields

parent

string

Required. The parent resource where this plugin will be created. Format: projects/{project}/locations/{location} .

filter

string

Optional. An expression that filters the list of plugins.

The following fields in the Plugins are eligible for filtering:

plugin_category - The category of the Plugin. Allowed comparison operators: = .

plugin_category = ON_RAMP - The plugin is of category on ramp.

page_size

int32

page_token

string

Optional. A page token, received from a previous ListPlugins call. Provide this to retrieve the subsequent page.

When paginating, all other parameters (except page_size) provided to ListPlugins must match the call that provided the page token.

ListPluginsResponse

The ListPlugins method's response.

Fields

plugins[]

RuntimeProjectAttachment

The plugins from the specified parent resource.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListRuntimeProjectAttachmentsRequest

The ListRuntimeProjectAttachments method's request.

Fields

parent

string

Required. The parent, which owns this collection of runtime project attachments. Format: projects/{project}/locations/{location}

page_size

int32

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

string

Optional. A page token, received from a previous ListRuntimeProjectAttachments call. Provide this to retrieve the subsequent page.

When paginating, all other parameters (except page_size) provided to ListRuntimeProjectAttachments must match the call that provided the page token.

filter

string

Optional. An expression that filters the list of RuntimeProjectAttachments.

The following fields in the RuntimeProjectAttachment are eligible for filtering:

name - The name of the RuntimeProjectAttachment.
create_time - The time at which the RuntimeProjectAttachment was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format.
runtime_project - The Google cloud project associated with the RuntimeProjectAttachment.

order_by

string

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

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListSpecsRequest

The [ListSpecs][ListSpecs] method's request.

Fields

parent

string

Required. The parent, which owns this collection of specs. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

filter

string

Optional. An expression that filters the list of Specs.

The following fields in the Spec are eligible for filtering:

display_name - The display name of the Spec. Allowed comparison operators: = .
create_time - The time at which the Spec was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and < .
spec_type.enum_values.values.id - The allowed value id of the spec_type attribute associated with the Spec. Allowed comparison operators: : .
spec_type.enum_values.values.display_name - The allowed value display name of the spec_type attribute associated with the Spec. Allowed comparison operators: : .
lint_response.json_values.values - The json value of the lint_response attribute associated with the Spec. Allowed comparison operators: : .
mime_type - The MIME type of the Spec. Allowed comparison operators: = .
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name.
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name
The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name.
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name.
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name.

Here are a few examples:

spec_type.enum_values.values.id: rest-id - The filter string specifies that the id of the allowed value associated with the spec_type attribute is rest-id .
spec_type.enum_values.values.display_name: \"Rest Display Name\" - The filter string specifies that the display name of the allowed value associated with the spec_type attribute is Rest Display Name .
spec_type.enum_values.values.id: grpc-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The id of the allowed value associated with the spec_type attribute is grpc-id and the spec was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC .
spec_type.enum_values.values.id: rest-id OR spec_type.enum_values.values.id: grpc-id
The id of the allowed value associated with the spec_type attribute is rest-id or grpc-id .
spec_type.enum_values.values.id: rest-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id: test - The filter string specifies that the id of the allowed value associated with the spec_type attribute is rest-id and the id of the allowed value associated with the user defined attribute of type enum is test .

page_size

int32

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

string

Optional. A page token, received from a previous ListSpecs call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListSpecs must match the call that provided the page token.

ListSpecsResponse

The ListSpecs method's response.

Fields

specs[]

Spec

The specs corresponding to an API Version.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListVersionsRequest

The ListVersions method's request.

Fields

parent

string

Required. The parent which owns this collection of API versions i.e., the API resource Format: projects/{project}/locations/{location}/apis/{api}

filter

string

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: < , > or = . Filters are not case sensitive.

The following fields in the Version are eligible for filtering:

display_name - The display name of the Version. Allowed comparison operators: = .
create_time - The time at which the Version was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: > and < .
lifecycle.enum_values.values.id - The allowed value id of the lifecycle attribute associated with the Version. Allowed comparison operators: : .
lifecycle.enum_values.values.display_name - The allowed value display name of the lifecycle attribute associated with the Version. Allowed comparison operators: : .
compliance.enum_values.values.id - The allowed value id of the compliances attribute associated with the Version. Allowed comparison operators: : .
compliance.enum_values.values.display_name - The allowed value display name of the compliances attribute associated with the Version. Allowed comparison operators: : .
accreditation.enum_values.values.id - The allowed value id of the accreditations attribute associated with the Version. Allowed comparison operators: : .
accreditation.enum_values.values.display_name - The allowed value display name of the accreditations attribute associated with the Version. Allowed comparison operators: : .
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name.
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name
The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name.
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name.
attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is : . Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name.

Here are a few examples:

lifecycle.enum_values.values.id: preview-id - The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is preview-id .
lifecycle.enum_values.values.display_name: \"Preview Display Name\" - The filter string specifies that the display name of the allowed value associated with the lifecycle attribute of the Version is Preview Display Name .
lifecycle.enum_values.values.id: preview-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\" - The id of the allowed value associated with the lifecycle attribute of the Version is preview-id and it was created before 2021-08-15 14:50:00 UTC and after 2021-08-10 12:00:00 UTC .
compliance.enum_values.values.id: gdpr-id OR compliance.enum_values.values.id: pci-dss-id
The id of the allowed value associated with the compliance attribute is gdpr-id or pci-dss-id .
lifecycle.enum_values.values.id: preview-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.string_values.values: test - The filter string specifies that the id of the allowed value associated with the lifecycle attribute of the Version is preview-id and the value of the user defined attribute of type string is test .

page_size

int32

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

string

Optional. A page token, received from a previous ListVersions call. Provide this to retrieve the subsequent page.

When paginating, all other parameters (except page_size) provided to ListVersions must match the call that provided the page token.

ListVersionsResponse

The ListVersions method's response.

Fields

versions[]

string

Output only. The version in the spec. This maps to info.version in OpenAPI spec.

owner

Owner

Output only. Owner details for the spec. This maps to info.contact in OpenAPI spec.

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

string

Optional. Description of the operation behavior. For OpenAPI spec, this will map to operation.description in the spec, in case description is empty, operation.summary will be used.

documentation

Documentation

Optional. Additional external documentation for this operation. For OpenAPI spec, this will map to operation.documentation in the spec.

deprecated

bool

Optional. For OpenAPI spec, this will be set if operation.deprecated is marked as true in the spec.

Union field operation .

operation can be only one of the following:

http_operation

HttpOperation

The HTTP Operation.

OperationMetadata

Represents the metadata of the long-running operation.

Fields
`create_time`	`Timestamp` Output only. The time the operation was created.
`end_time`	`Timestamp` Output only. The time the operation finished running.
`target`	`string` Output only. Server-defined resource path for the target of the operation.
`verb`	`string` Output only. Name of the verb executed by the operation.
`status_message`	`string` Output only. Human-readable status of the operation, if any.
`requested_cancellation`	`bool` Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have `Operation.error` value with a `google.rpc.Status.code` of 1, corresponding to `Code.CANCELLED` .
`api_version`	`string` Output only. API version used to start the operation.

Owner

Owner details.

Fields

display_name

string

Optional. The name of the owner.

email

string

Required. The email of the owner.

Path

The path details derived from the spec.

Fields

path

string

Optional. Complete path relative to server endpoint. Note: Even though this field is optional, it is required for CreateApiOperation API and we will fail the request if not provided.

description

string

Optional. A short description for the path applicable to all operations.

Plugin

A plugin resource in the API Hub.

Fields
`name`	`string` Identifier. The name of the plugin. Format: `projects/{project}/locations/{location}/plugins/{plugin}`
`display_name`	`string` Required. The display name of the plugin. Max length is 50 characters (Unicode code points).
`type`	`AttributeValues` Optional. The type of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-plugin-type` attribute. The number of allowed values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. All values should be from the list of allowed values defined for the attribute. Note this field is not required for plugins developed via plugin framework.
`description`	`string` Optional. The plugin description. Max length is 2000 characters (Unicode code points).
`state`	`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`	`OwnershipType` Output only. The type of the plugin, indicating whether it is 'SYSTEM_OWNED' or 'USER_OWNED'.
`hosting_service`	`HostingService` 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[]`	`PluginActionConfig` Optional. The configuration of actions supported by the plugin.
`documentation`	`Documentation` Optional. The documentation of the plugin, that explains how to set up and use the plugin.
`plugin_category`	`PluginCategory` Optional. The category of the plugin, identifying its primary category or purpose. This field is required for all plugins.
`config_template`	`ConfigTemplate` Optional. The configuration template for the plugin.
`create_time`	`Timestamp` Output only. Timestamp indicating when the plugin was created.
`update_time`	`Timestamp` Output only. Timestamp indicating when the plugin was last updated.
`gateway_type`	`GatewayType` Optional. The type of the gateway.

ConfigTemplate

ConfigTemplate represents the configuration template for a plugin.

Fields

auth_config_template

AuthConfigTemplate

Optional. The authentication template for the plugin.

additional_config_template[]

ConfigVariableTemplate

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[]

AuthType

Required. The list of authentication types supported by the plugin.

service_account

GoogleServiceAccountConfig

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

string

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`	`string` Required. The id of the action.
`display_name`	`string` Required. The display name of the action.
`description`	`string` Required. The description of the operation performed by the action.
`trigger_mode`	`TriggerMode` 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`	`string` Identifier. The unique name of the plugin instance resource. Format: `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
`display_name`	`string` Required. The display name for this plugin instance. Max length is 255 characters.
`auth_config`	`AuthConfig` Optional. The authentication information for this plugin instance.
`additional_config`	`map<string, ConfigVariable >` 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`	`State` Output only. The current state of the plugin instance (e.g., enabled, disabled, provisioning).
`error_message`	`string` 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[]`	`PluginInstanceAction` Required. The action status for the plugin instance.
`create_time`	`Timestamp` Output only. Timestamp indicating when the plugin instance was created.
`update_time`	`Timestamp` Output only. Timestamp indicating when the plugin instance was last updated.
`source_project_id`	`string` Optional. The source project id of the plugin instance. This will be the id of runtime project in case of Google Cloud based plugins and org id in case of non Google Cloud based plugins. This field will be a required field for Google provided on-ramp plugins.

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

string

Required. This should map to one of the action id specified in actions_config in the plugin.

state

State

Output only. The current state of the plugin action in the plugin instance.

schedule_cron_expression

string

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

CurationConfig

Optional. This configuration should be provided if the plugin action is publishing data to API hub curate layer.

schedule_time_zone

string

Optional. The time zone for the schedule cron expression. If not provided, UTC will be used.

service_account

string

Optional. The service account used to publish data. Note, the service account will only be accepted for non Google Cloud plugins like OPDK.

resource_config

ResourceConfig

Output only. The configuration of resources created for a given plugin instance action. Note these will be returned only in case of Non-Google Cloud plugins like OPDK.

Union field action_status . The status of the plugin action. action_status can be only one of the following:

hub_instance_action

Object describing where in the file the issue was found.

Fields

start

Point

Required. Start of the issue.

end

Point

Required. End of the issue.

RemoveSystemOwnedPluginRequest

The [RemoveSystemOwnedPlugin][ApiHub.RemoveSystemOwnedPlugin] method's request.

Fields

name

string

Required. The name of the Plugin resource to delete. Format: projects/{project}/locations/{location}/plugins/{plugin}

force

bool

Optional. If set to true, any plugin instances for this plugin will also be deleted (otherwise, the request will only work if the plugin has no plugin instances.)

RemoveSystemOwnedPluginResponse

This type has no fields.

The [RemoveSystemOwnedPlugin][ApiHub.RemoveSystemOwnedPlugin] method's response.

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

string

Identifier. The resource name of a runtime project attachment. Format: "projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}".

runtime_project

string

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

string

Output only. The display name of the schema. This will map to the name of the schema in the spec.

raw_value

bytes

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

string

Required. The resource name of the location which will be of the type projects/{project_id}/locations/{location_id} . This field is used to identify the instance of API-Hub in which resources should be searched.

query

string

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

string

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 = . Filters are not case sensitive.

The following field names are eligible for filtering: * resource_type - The type of resource in the search results. Must be one of the following: Api , ApiOperation , Deployment , Definition , Spec or Version . This field can only be specified once in the filter.

Here are is an example:

resource_type = Api - The resource_type is Api .

page_size

int32

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 INVALID_ARGUMENT error is returned. The maximum value is 25; values above 25 will be coerced to 25. While paginating, you can specify a new page size parameter for each page of search results to be listed.

page_token

string

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 page_token parameter and all the other parameters except page_size should be specified with the same value which was used in the previous call. If the other fields are set with a different value than the previous call then INVALID_ARGUMENT error is returned.

SearchResourcesResponse

Response for the SearchResources method.

Fields

search_results[]

SearchResult

List of search results according to the filter and search query specified. The order of search results represents the ranking.

next_page_token

string

Pass this token in the SearchResourcesRequest to continue to list results. If all results have been returned, this field is an empty string or not present in the response.

SearchResult

Represents the search results.

Fields

resource

ApiHubResource

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

string

Required. The resource name of the secret version in the format, format as: projects/*/secrets/*/versions/* .

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

SourceType

Output only. The type of the source.

original_resource_id

string

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

PluginInstanceActionSource

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

string

Output only. The resource name of the source plugin instance. Format is projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

action_id

string

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`	`string` Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
`display_name`	`string` Required. The display name of the spec. This can contain the file name of the spec.
`spec_type`	`AttributeValues` Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
`contents`	`SpecContents` Optional. Input only. The contents of the uploaded spec.
`details`	`SpecDetails` Output only. Details parsed from the spec.
`source_uri`	`string` Optional. The URI of the spec source in case file is uploaded from an external version control system.
`create_time`	`Timestamp` Output only. The time at which the spec was created.
`update_time`	`Timestamp` Output only. The time at which the spec was last updated.
`lint_response`	`LintResponse` Optional. The lint response for the spec.
`attributes`	`map<string, AttributeValues >` Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}` . The value is the attribute values associated with the resource.
`documentation`	`Documentation` Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
`parsing_mode`	`ParsingMode` Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
`source_metadata[]`	`SourceMetadata` 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

bytes

Required. The contents of the spec.

mime_type

string

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

string

Output only. The description of the spec.

Union field details .

details can be only one of the following:

open_api_spec_details

OpenApiSpecDetails

Output only. Additional details apart from OperationDetails parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.

SpecMetadata

The metadata associated with a spec of the API version.

Fields
`spec`	`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`	`string` Optional. The unique identifier of the spec in the system where it was originally created.
`original_create_time`	`Timestamp` Optional. Timestamp indicating when the spec was created at the source.
`original_update_time`	`Timestamp` 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

string

Identifier. The name of the style guide.

Format: projects/{project}/locations/{location}/plugins/{plugin}/styleGuide

linter

Linter

Required. Target linter for the style guide.

contents

StyleGuideContents

Required. Input only. The contents of the uploaded style guide.

The UpdatePluginInstance method's request.

Fields

plugin_instance

PluginInstance

Required. The plugin instance to update.

update_mask

Optional. The list of fields to update.

UpdateSpecRequest

The UpdateSpec method's request.

Fields

spec

Spec

Required. The spec to update.

The spec's name field is used to identify the spec to update. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

update_mask

Required. The list of fields to update.

UpdateStyleGuideRequest

The UpdateStyleGuide method's request.

Fields

style_guide

StyleGuide

Required. The Style guide resource to update.

update_mask

Optional. The list of fields to update.

UpdateVersionRequest

The UpdateVersion method's request.

Fields

version

Version

Required. The API version to update.

The version's name field is used to identify the API version to update. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

update_mask