package google.cloud.apihub.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service ApiHub
apihub_service.proto:36This service provides all methods related to the API hub.
rpc CreateApi (, )
apihub_service.proto:43Create an API resource in the API hub. Once an API resource is created, versions can be added to it.
message
apihub_service.proto:545The [CreateApi][google.cloud.apihub.v1.ApiHub.CreateApi] method's request.
string parent = 1
Required. The parent resource for the API resource. Format: `projects/{project}/locations/{location}`
string api_id = 2
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]-_/.
optional api = 3
Required. The API resource to create.
rpc GetApi (, )
apihub_service.proto:52Get API resource details including the API versions contained in it.
message
apihub_service.proto:571The [GetApi][google.cloud.apihub.v1.ApiHub.GetApi] method's request.
string name = 1
Required. The name of the API resource to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}`
rpc ListApis (, )
apihub_service.proto:60List API resources in the API hub.
message
apihub_service.proto:609The [ListApis][google.cloud.apihub.v1.ApiHub.ListApis] method's request.
string parent = 1
Required. The parent, which owns this collection of API resources. Format: `projects/{project}/locations/{location}`
string filter = 2
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 `:`. 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. 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`.
int32 page_size = 3
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.
string page_token = 4
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.
message
apihub_service.proto:707The [ListApis][google.cloud.apihub.v1.ApiHub.ListApis] method's response.
repeated apis = 1
The API resources present in the API hub.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
rpc UpdateApi (, )
apihub_service.proto:86Update an API resource in the API hub. The following fields in the [API][] can be updated: * [display_name][google.cloud.apihub.v1.Api.display_name] * [description][google.cloud.apihub.v1.Api.description] * [owner][google.cloud.apihub.v1.Api.owner] * [documentation][google.cloud.apihub.v1.Api.documentation] * [target_user][google.cloud.apihub.v1.Api.target_user] * [team][google.cloud.apihub.v1.Api.team] * [business_unit][google.cloud.apihub.v1.Api.business_unit] * [maturity_level][google.cloud.apihub.v1.Api.maturity_level] * [attributes][google.cloud.apihub.v1.Api.attributes] The [update_mask][google.cloud.apihub.v1.UpdateApiRequest.update_mask] should be used to specify the fields being updated. Updating the owner field requires complete owner message and updates both owner and email fields.
message
apihub_service.proto:581The [UpdateApi][google.cloud.apihub.v1.ApiHub.UpdateApi] method's request.
optional api = 1
Required. The API resource to update. The API resource's `name` field is used to identify the API resource to update. Format: `projects/{project}/locations/{location}/apis/{api}`
optional update_mask = 2
Required. The list of fields to update.
rpc DeleteApi (, )
apihub_service.proto:96Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.
message
apihub_service.proto:595The [DeleteApi][google.cloud.apihub.v1.ApiHub.DeleteApi] method's request.
string name = 1
Required. The name of the API resource to delete. Format: `projects/{project}/locations/{location}/apis/{api}`
bool force = 2
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.
Create an API version for an API resource in the API hub.
message
apihub_service.proto:718The [CreateVersion][google.cloud.apihub.v1.ApiHub.CreateVersion] method's request.
string parent = 1
Required. The parent resource for API version. Format: `projects/{project}/locations/{location}/apis/{api}`
string version_id = 2
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, and valid characters are /[a-z][A-Z][0-9]-_/.
optional version = 3
Required. The version to create.
rpc GetVersion (, )
apihub_service.proto:115Get details about the API version of an API resource. This will include information about the specs and operations present in the API version as well as the deployments linked to it.
message
apihub_service.proto:742The [GetVersion][google.cloud.apihub.v1.ApiHub.GetVersion] method's request.
string name = 1
Required. The name of the API version to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
rpc ListVersions (, )
apihub_service.proto:123List API versions of an API resource in the API hub.
message
apihub_service.proto:785The [ListVersions][google.cloud.apihub.v1.ApiHub.ListVersions] method's request.
string parent = 1
Required. The parent which owns this collection of API versions i.e., the API resource Format: `projects/{project}/locations/{location}/apis/{api}`
string filter = 2
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: `:`. 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. 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_.
int32 page_size = 3
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.
string page_token = 4
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.
message
apihub_service.proto:872The [ListVersions][google.cloud.apihub.v1.ApiHub.ListVersions] method's response.
repeated versions = 1
The versions corresponding to an API.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Update API version. The following fields in the [version][google.cloud.apihub.v1.Version] can be updated currently: * [display_name][google.cloud.apihub.v1.Version.display_name] * [description][google.cloud.apihub.v1.Version.description] * [documentation][google.cloud.apihub.v1.Version.documentation] * [deployments][google.cloud.apihub.v1.Version.deployments] * [lifecycle][google.cloud.apihub.v1.Version.lifecycle] * [compliance][google.cloud.apihub.v1.Version.compliance] * [accreditation][google.cloud.apihub.v1.Version.accreditation] * [attributes][google.cloud.apihub.v1.Version.attributes] The [update_mask][google.cloud.apihub.v1.UpdateVersionRequest.update_mask] should be used to specify the fields being updated.
message
apihub_service.proto:754The [UpdateVersion][google.cloud.apihub.v1.ApiHub.UpdateVersion] method's request.
optional version = 1
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}`
optional update_mask = 2
Required. The list of fields to update.
Delete an API version. Version can only be deleted if all underlying specs, operations, definitions and linked deployments are deleted.
message
apihub_service.proto:769The [DeleteVersion][google.cloud.apihub.v1.ApiHub.DeleteVersion] method's request.
string name = 1
Required. The name of the version to delete. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
bool force = 2
Optional. If set to true, any specs from this version will also be deleted. Otherwise, the request will only work if the version has no specs.
rpc CreateSpec (, )
apihub_service.proto:183Add a spec to an API version in the API hub. Multiple specs can be added to an API version. Note, while adding a spec, at least one of `contents` or `source_uri` must be provided. If `contents` is provided, then `spec_type` must also be provided. On adding a spec with contents to the version, the operations present in it will be added to the version.Note that the file contents in the spec should be of the same type as defined in the `projects/{project}/locations/{location}/attributes/system-spec-type` attribute associated with spec resource. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. In order to access the information parsed from the spec, use the [GetSpec][google.cloud.apihub.v1.ApiHub.GetSpec] method. In order to access the raw contents for a particular spec, use the [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method. In order to access the operations parsed from the spec, use the [ListAPIOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method.
message
apihub_service.proto:882The [CreateSpec][google.cloud.apihub.v1.ApiHub.CreateSpec] method's request.
string parent = 1
Required. The parent resource for Spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
string spec_id = 2
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, and valid characters are /[a-z][A-Z][0-9]-_/.
optional spec = 3
Required. The spec to create.
rpc GetSpec (, )
apihub_service.proto:195Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method to retrieve the same.
message
apihub_service.proto:908The [GetSpec][google.cloud.apihub.v1.ApiHub.GetSpec] method's request.
string name = 1
Required. The name of the spec to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
Get spec contents.
message
apihub_service.proto:1034The [GetSpecContents][google.cloud.apihub.v1.ApiHub.GetSpecContents] method's request.
string name = 1
Required. The name of the spec whose contents need to be retrieved. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
rpc ListSpecs (, )
apihub_service.proto:211List specs corresponding to a particular API resource.
message
apihub_service.proto:944The [ListSpecs][ListSpecs] method's request.
string parent = 1
Required. The parent, which owns this collection of specs. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
string filter = 2
Optional. An expression that filters the list of Specs. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>`, `:` or `=`. Filters are not case sensitive. 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: `=`. 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. 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_.
int32 page_size = 3
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.
string page_token = 4
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.
message
apihub_service.proto:1023The [ListSpecs][google.cloud.apihub.v1.ApiHub.ListSpecs] method's response.
repeated specs = 1
The specs corresponding to an API.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
rpc UpdateSpec (, )
apihub_service.proto:240Update spec. The following fields in the [spec][google.cloud.apihub.v1.Spec] can be updated: * [display_name][google.cloud.apihub.v1.Spec.display_name] * [source_uri][google.cloud.apihub.v1.Spec.source_uri] * [lint_response][google.cloud.apihub.v1.Spec.lint_response] * [attributes][google.cloud.apihub.v1.Spec.attributes] * [contents][google.cloud.apihub.v1.Spec.contents] * [spec_type][google.cloud.apihub.v1.Spec.spec_type] In case of an OAS spec, updating spec contents can lead to: 1. Creation, deletion and update of operations. 2. Creation, deletion and update of definitions. 3. Update of other info parsed out from the new spec. In case of contents or source_uri being present in update mask, spec_type must also be present. Also, spec_type can not be present in update mask if contents or source_uri is not present. The [update_mask][google.cloud.apihub.v1.UpdateSpecRequest.update_mask] should be used to specify the fields being updated.
message
apihub_service.proto:919The [UpdateSpec][google.cloud.apihub.v1.ApiHub.UpdateSpec] method's request.
optional spec = 1
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}`
optional update_mask = 2
Required. The list of fields to update.
rpc DeleteSpec (, )
apihub_service.proto:251Delete a spec. Deleting a spec will also delete the associated operations from the version.
message
apihub_service.proto:933The [DeleteSpec][google.cloud.apihub.v1.ApiHub.DeleteSpec] method's request.
string name = 1
Required. The name of the spec to delete. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
Get details about a particular operation in API version.
message
apihub_service.proto:1046The [GetApiOperation][google.cloud.apihub.v1.ApiHub.GetApiOperation] method's request.
string name = 1
Required. The name of the operation to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
List operations in an API version.
message
apihub_service.proto:1060The [ListApiOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method's request.
string parent = 1
Required. The parent which owns this collection of operations i.e., the API version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
string filter = 2
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 `<`. 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. 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_.
int32 page_size = 3
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.
string page_token = 4
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.
message
apihub_service.proto:1129The [ListApiOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method's response.
repeated api_operations = 1
The operations corresponding to an API version. Only following field will be populated in the response: name, spec, details.deprecated, details.http_operation.path.path, details.http_operation.method and details.documentation.external_uri.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Get details about a definition in an API version.
message
apihub_service.proto:1143The [GetDefinition][google.cloud.apihub.v1.ApiHub.GetDefinition] method's request.
string name = 1
Required. The name of the definition to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
Create a deployment resource in the API hub. Once a deployment resource is created, it can be associated with API versions.
message
apihub_service.proto:1157The [CreateDeployment][google.cloud.apihub.v1.ApiHub.CreateDeployment] method's request.
string parent = 1
Required. The parent resource for the deployment resource. Format: `projects/{project}/locations/{location}`
string deployment_id = 2
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]-_/.
optional deployment = 3
Required. The deployment resource to create.
Get details about a deployment and the API versions linked to it.
message
apihub_service.proto:1185The [GetDeployment][google.cloud.apihub.v1.ApiHub.GetDeployment] method's request.
string name = 1
Required. The name of the deployment resource to retrieve. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
List deployment resources in the API hub.
message
apihub_service.proto:1226The [ListDeployments][google.cloud.apihub.v1.ApiHub.ListDeployments] method's request.
string parent = 1
Required. The parent, which owns this collection of deployment resources. Format: `projects/{project}/locations/{location}`
string filter = 2
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: `:`. * `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: `:`. 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. 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%_.
int32 page_size = 3
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.
string page_token = 4
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.
message
apihub_service.proto:1312The [ListDeployments][google.cloud.apihub.v1.ApiHub.ListDeployments] method's response.
repeated deployments = 1
The deployment resources present in the API hub.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Update a deployment resource in the API hub. The following fields in the [deployment resource][google.cloud.apihub.v1.Deployment] can be updated: * [display_name][google.cloud.apihub.v1.Deployment.display_name] * [description][google.cloud.apihub.v1.Deployment.description] * [documentation][google.cloud.apihub.v1.Deployment.documentation] * [deployment_type][google.cloud.apihub.v1.Deployment.deployment_type] * [resource_uri][google.cloud.apihub.v1.Deployment.resource_uri] * [endpoints][google.cloud.apihub.v1.Deployment.endpoints] * [slo][google.cloud.apihub.v1.Deployment.slo] * [environment][google.cloud.apihub.v1.Deployment.environment] * [attributes][google.cloud.apihub.v1.Deployment.attributes] The [update_mask][google.cloud.apihub.v1.UpdateDeploymentRequest.update_mask] should be used to specify the fields being updated.
message
apihub_service.proto:1198The [UpdateDeployment][google.cloud.apihub.v1.ApiHub.UpdateDeployment] method's request.
optional deployment = 1
Required. The deployment resource to update. The deployment resource's `name` field is used to identify the deployment resource to update. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
optional update_mask = 2
Required. The list of fields to update.
Delete a deployment resource in the API hub.
message
apihub_service.proto:1213The [DeleteDeployment][google.cloud.apihub.v1.ApiHub.DeleteDeployment] method's request.
string name = 1
Required. The name of the deployment resource to delete. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
Create a user defined attribute. Certain pre defined attributes are already created by the API hub. These attributes will have type as `SYSTEM_DEFINED` and can be listed via [ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method. Allowed values for the same can be updated via [UpdateAttribute][google.cloud.apihub.v1.ApiHub.UpdateAttribute] method.
message
apihub_service.proto:1323The [CreateAttribute][google.cloud.apihub.v1.ApiHub.CreateAttribute] method's request.
string parent = 1
Required. The parent resource for Attribute. Format: `projects/{project}/locations/{location}`
string attribute_id = 2
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]-_/.
optional attribute = 3
Required. The attribute to create.
rpc GetAttribute (, )
apihub_service.proto:361Get details about the attribute.
message
apihub_service.proto:1351The [GetAttribute][google.cloud.apihub.v1.ApiHub.GetAttribute] method's request.
string name = 1
Required. The name of the attribute to retrieve. Format: `projects/{project}/locations/{location}/attributes/{attribute}`
Update the attribute. The following fields in the [Attribute resource][google.cloud.apihub.v1.Attribute] can be updated: * [display_name][google.cloud.apihub.v1.Attribute.display_name] The display name can be updated for user defined attributes only. * [description][google.cloud.apihub.v1.Attribute.description] The description can be updated for user defined attributes only. * [allowed_values][google.cloud.apihub.v1.Attribute.allowed_values] To update the list of allowed values, clients need to use the fetched list of allowed values and add or remove values to or from the same list. The mutable allowed values can be updated for both user defined and System defined attributes. The immutable allowed values cannot be updated or deleted. The updated list of allowed values cannot be empty. If an allowed value that is already used by some resource's attribute is deleted, then the association between the resource and the attribute value will also be deleted. * [cardinality][google.cloud.apihub.v1.Attribute.cardinality] The cardinality can be updated for user defined attributes only. Cardinality can only be increased during an update. The [update_mask][google.cloud.apihub.v1.UpdateAttributeRequest.update_mask] should be used to specify the fields being updated.
message
apihub_service.proto:1365The [UpdateAttribute][google.cloud.apihub.v1.ApiHub.UpdateAttribute] method's request.
optional attribute = 1
Required. The attribute to update. The attribute's `name` field is used to identify the attribute to update. Format: `projects/{project}/locations/{location}/attributes/{attribute}`
optional update_mask = 2
Required. The list of fields to update.
Delete an attribute. Note: System defined attributes cannot be deleted. All associations of the attribute being deleted with any API hub resource will also get deleted.
message
apihub_service.proto:1380The [DeleteAttribute][google.cloud.apihub.v1.ApiHub.DeleteAttribute] method's request.
string name = 1
Required. The name of the attribute to delete. Format: `projects/{project}/locations/{location}/attributes/{attribute}`
List all attributes.
message
apihub_service.proto:1394The [ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method's request.
string parent = 1
Required. The parent resource for Attribute. Format: `projects/{project}/locations/{location}`
string filter = 2
Optional. An expression that filters the list of Attributes. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string or a boolean. The comparison operator must be one of: `<`, `>` or `=`. Filters are not case sensitive. 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 `<`. 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. 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_.
int32 page_size = 3
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.
string page_token = 4
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.
message
apihub_service.proto:1465The [ListAttributes][google.cloud.apihub.v1.ApiHub.ListAttributes] method's response.
repeated attributes = 1
The list of all attributes.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Search across API-Hub resources.
message
apihub_service.proto:1476The [SearchResources][google.cloud.apihub.v1.ApiHub.SearchResources] method's request.
string location = 1
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.
string query = 2
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.
string filter = 3
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_.
int32 page_size = 4
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.
string page_token = 5
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][google.cloud.apihub.v1.SearchResourcesRequest.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.
message
apihub_service.proto:1570Response for the [SearchResources][google.cloud.apihub.v1.ApiHub.SearchResources] method.
repeated search_results = 1
List of search results according to the filter and search query specified. The order of search results represents the ranking.
string next_page_token = 2
Pass this token in the [SearchResourcesRequest][google.cloud.apihub.v1.SearchResourcesRequest] to continue to list results. If all results have been returned, this field is an empty string or not present in the response.
Create an External API resource in the API hub.
message
apihub_service.proto:1729The [CreateExternalApi][google.cloud.apihub.v1.ApiHub.CreateExternalApi] method's request.
string parent = 1
Required. The parent resource for the External API resource. Format: `projects/{project}/locations/{location}`
string external_api_id = 2
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]-_/.
optional external_api = 3
Required. The External API resource to create.
Get details about an External API resource in the API hub.
message
apihub_service.proto:1758The [GetExternalApi][google.cloud.apihub.v1.ApiHub.GetExternalApi] method's request.
string name = 1
Required. The name of the External API resource to retrieve. Format: `projects/{project}/locations/{location}/externalApis/{externalApi}`
Update an External API resource in the API hub. The following fields can be updated: * [display_name][google.cloud.apihub.v1.ExternalApi.display_name] * [description][google.cloud.apihub.v1.ExternalApi.description] * [documentation][google.cloud.apihub.v1.ExternalApi.documentation] * [endpoints][google.cloud.apihub.v1.ExternalApi.endpoints] * [paths][google.cloud.apihub.v1.ExternalApi.paths] The [update_mask][google.cloud.apihub.v1.UpdateExternalApiRequest.update_mask] should be used to specify the fields being updated.
message
apihub_service.proto:1772The [UpdateExternalApi][google.cloud.apihub.v1.ApiHub.UpdateExternalApi] method's request.
optional external_api = 1
Required. The External API resource to update. The External API resource's `name` field is used to identify the External API resource to update. Format: `projects/{project}/locations/{location}/externalApis/{externalApi}`
optional update_mask = 2
Required. The list of fields to update.
Delete an External API resource in the API hub.
message
apihub_service.proto:1787The [DeleteExternalApi][google.cloud.apihub.v1.ApiHub.DeleteExternalApi] method's request.
string name = 1
Required. The name of the External API resource to delete. Format: `projects/{project}/locations/{location}/externalApis/{externalApi}`
List External API resources in the API hub.
message
apihub_service.proto:1801The [ListExternalApis][google.cloud.apihub.v1.ApiHub.ListExternalApis] method's request.
string parent = 1
Required. The parent, which owns this collection of External API resources. Format: `projects/{project}/locations/{location}`
int32 page_size = 2
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.
string page_token = 3
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.
message
apihub_service.proto:1827The [ListExternalApis][google.cloud.apihub.v1.ApiHub.ListExternalApis] method's response.
repeated external_apis = 1
The External API resources present in the API hub. Only following fields will be populated in the response: name, display_name, documentation.external_uri.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
This service provides methods for various operations related to a [Dependency][google.cloud.apihub.v1.Dependency] in the API hub.
Create a dependency between two entities in the API hub.
message
apihub_service.proto:1585The [CreateDependency][google.cloud.apihub.v1.ApiHubDependencies.CreateDependency] method's request.
string parent = 1
Required. The parent resource for the dependency resource. Format: `projects/{project}/locations/{location}`
string dependency_id = 2
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]-_`.
optional dependency = 3
Required. The dependency resource to create.
Get details about a dependency resource in the API hub.
message
apihub_service.proto:1611The [GetDependency][.ApiHubDependencies.GetDependency] method's request.
string name = 1
Required. The name of the dependency resource to retrieve. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
Update a dependency based on the [update_mask][google.cloud.apihub.v1.UpdateDependencyRequest.update_mask] provided in the request. The following fields in the [dependency][google.cloud.apihub.v1.Dependency] can be updated: * [description][google.cloud.apihub.v1.Dependency.description]
message
apihub_service.proto:1625The [UpdateDependency][google.cloud.apihub.v1.ApiHubDependencies.UpdateDependency] method's request.
optional dependency = 1
Required. The dependency resource to update. The dependency's `name` field is used to identify the dependency to update. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
optional update_mask = 2
Required. The list of fields to update.
Delete the dependency resource.
message
apihub_service.proto:1640The [DeleteDependency][google.cloud.apihub.v1.ApiHubDependencies.DeleteDependency] method's request.
string name = 1
Required. The name of the dependency resource to delete. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
List dependencies based on the provided filter and pagination parameters.
message
apihub_service.proto:1654The [ListDependencies][google.cloud.apihub.v1.ApiHubDependencies.ListDependencies] method's request.
string parent = 1
Required. The parent which owns this collection of dependency resources. Format: `projects/{project}/locations/{location}`
string filter = 2
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: `=`. 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. 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_.
int32 page_size = 3
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.
string page_token = 4
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.
message
apihub_service.proto:1717The [ListDependencies][google.cloud.apihub.v1.ApiHubDependencies.ListDependencies] method's response.
repeated dependencies = 1
The dependency resources present in the API hub. Only following field will be populated in the response: name.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
This service is used for managing plugins inside the API Hub.
rpc GetPlugin (, )
plugin_service.proto:40Get details about an API Hub plugin.
message
plugin_service.proto:119The [GetPlugin][google.cloud.apihub.v1.ApiHubPlugin.GetPlugin] method's request.
string name = 1
Required. The name of the plugin to retrieve. Format: `projects/{project}/locations/{location}/plugins/{plugin}`.
rpc EnablePlugin (, )
plugin_service.proto:49Enables a plugin. The `state` of the plugin after enabling is `ENABLED`
message
plugin_service.proto:130The [EnablePlugin][google.cloud.apihub.v1.ApiHubPlugin.EnablePlugin] method's request.
string name = 1
Required. The name of the plugin to enable. Format: `projects/{project}/locations/{location}/plugins/{plugin}`.
rpc DisablePlugin (, )
plugin_service.proto:59Disables a plugin. The `state` of the plugin after disabling is `DISABLED`
message
plugin_service.proto:141The [DisablePlugin][google.cloud.apihub.v1.ApiHubPlugin.DisablePlugin] method's request.
string name = 1
Required. The name of the plugin to disable. Format: `projects/{project}/locations/{location}/plugins/{plugin}`.
This service is used for managing the host project registrations.
Create a host project registration. A Google cloud project can be registered as a host project if it is not attached as a runtime project to another host project. A project can be registered as a host project only once. Subsequent register calls for the same project will fail.
The [CreateHostProjectRegistration][google.cloud.apihub.v1.HostProjectRegistrationService.CreateHostProjectRegistration] method's request.
string parent = 1
Required. The parent resource for the host project. Format: `projects/{project}/locations/{location}`
string host_project_registration_id = 2
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.
optional host_project_registration = 3
Required. The host project registration to register.
Get a host project registration.
The [GetHostProjectRegistration][google.cloud.apihub.v1.HostProjectRegistrationService.GetHostProjectRegistration] method's request.
string name = 1
Required. Host project registration resource name. projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration_id}
Lists host project registrations.
The [ListHostProjectRegistrations][google.cloud.apihub.v1.HostProjectRegistrationService.ListHostProjectRegistrations] method's request.
string parent = 1
Required. The parent, which owns this collection of host projects. Format: `projects/*/locations/*`
int32 page_size = 2
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.
string page_token = 3
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.
string filter = 4
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.
string order_by = 5
Optional. Hint for how to order the results.
The [ListHostProjectRegistrations][google.cloud.apihub.v1.HostProjectRegistrationService.ListHostProjectRegistrations] method's response.
repeated host_project_registrations = 1
The list of host project registrations.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
This service provides all methods related to the 1p Linter.
Get the style guide being used for linting.
message
linting_service.proto:79The [GetStyleGuide][ApiHub.GetStyleGuide] method's request.
string name = 1
Required. The name of the spec to retrieve. Format: `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`.
Update the styleGuide to be used for liniting in by API hub.
message
linting_service.proto:92The [UpdateStyleGuide][ApiHub.UpdateStyleGuide] method's request.
optional style_guide = 1
Required. The Style guide resource to update.
optional update_mask = 2
Optional. The list of fields to update.
Get the contents of the style guide.
message
linting_service.proto:102The [GetStyleGuideContents][ApiHub.GetStyleGuideContents] method's request.
string name = 1
Required. The name of the StyleGuide whose contents need to be retrieved. There is exactly one style guide resource per project per location. The expected format is `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`.
rpc LintSpec (, )
linting_service.proto:70Lints the requested spec and updates the corresponding API Spec with the lint response. This lint response will be available in all subsequent Get and List Spec calls to Core service.
message
linting_service.proto:116The [LintSpec][ApiHub.LintSpec] method's request.
string name = 1
Required. The name of the spec to be linted. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
This service is used for managing the data plane provisioning of the API hub.
Provisions instance resources for the API Hub.
message
provisioning_service.proto:77The [CreateApiHubInstance][google.cloud.apihub.v1.Provisioning.CreateApiHubInstance] method's request.
string parent = 1
Required. The parent resource for the Api Hub instance resource. Format: `projects/{project}/locations/{location}`
string api_hub_instance_id = 2
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]-_/`.
optional api_hub_instance = 3
Required. The ApiHub instance.
Gets details of a single API Hub instance.
message
provisioning_service.proto:102The [GetApiHubInstance][google.cloud.apihub.v1.Provisioning.GetApiHubInstance] method's request.
string name = 1
Required. The name of the Api Hub instance to retrieve. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
Looks up an Api Hub instance in a given GCP project. There will always be only one Api Hub instance for a GCP project across all locations.
message
provisioning_service.proto:117The [LookupApiHubInstance][google.cloud.apihub.v1.Provisioning.LookupApiHubInstance] method's request.
string parent = 1
Required. There will always be only one Api Hub instance for a GCP project across all locations. The parent resource for the Api Hub instance resource. Format: `projects/{project}/locations/{location}`
message
provisioning_service.proto:133The [LookupApiHubInstance][google.cloud.apihub.v1.Provisioning.LookupApiHubInstance] method's response.`
optional api_hub_instance = 1
API Hub instance for a project if it exists, empty otherwise.
This service is used for managing the runtime project attachments.
Attaches a runtime project to the host project.
The [CreateRuntimeProjectAttachment][google.cloud.apihub.v1.RuntimeProjectAttachmentService.CreateRuntimeProjectAttachment] method's request.
string parent = 1
Required. The parent resource for the Runtime Project Attachment. Format: `projects/{project}/locations/{location}`
string runtime_project_attachment_id = 2
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.
optional runtime_project_attachment = 3
Required. The Runtime Project Attachment to create.
Gets a runtime project attachment.
The [GetRuntimeProjectAttachment][google.cloud.apihub.v1.RuntimeProjectAttachmentService.GetRuntimeProjectAttachment] method's request.
string name = 1
Required. The name of the API resource to retrieve. Format: `projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}`
List runtime projects attached to the host project.
The [ListRuntimeProjectAttachments][google.cloud.apihub.v1.RuntimeProjectAttachmentService.ListRuntimeProjectAttachments] method's request.
string parent = 1
Required. The parent, which owns this collection of runtime project attachments. Format: `projects/{project}/locations/{location}`
int32 page_size = 2
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.
string page_token = 3
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.
string filter = 4
Optional. An expression that filters the list of RuntimeProjectAttachments. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. All standard operators as documented at https://google.aip.dev/160 are supported. The following fields in the `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.
string order_by = 5
Optional. Hint for how to order the results.
The [ListRuntimeProjectAttachments][google.cloud.apihub.v1.RuntimeProjectAttachmentService.ListRuntimeProjectAttachments] method's response.
repeated runtime_project_attachments = 1
List of runtime project attachments.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
Delete a runtime project attachment in the API Hub. This call will detach the runtime project from the host project.
The [DeleteRuntimeProjectAttachment][google.cloud.apihub.v1.RuntimeProjectAttachmentService.DeleteRuntimeProjectAttachment] method's request.
string name = 1
Required. The name of the Runtime Project Attachment to delete. Format: `projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}`
Look up a runtime project attachment. This API can be called in the context of any project.
The [LookupRuntimeProjectAttachment][google.cloud.apihub.v1.RuntimeProjectAttachmentService.LookupRuntimeProjectAttachment] method's request.
string name = 1
Required. Runtime project ID to look up runtime project attachment for. Lookup happens across all regions. Expected format: `projects/{project}/locations/{location}`.
The [ListRuntimeProjectAttachments][google.cloud.apihub.v1.RuntimeProjectAttachmentService.ListRuntimeProjectAttachments] method's response.
optional runtime_project_attachment = 1
Runtime project attachment for a project if exists, empty otherwise.
message
common_fields.proto:78An API resource in the API Hub.
Used as response type in: ApiHub.CreateApi, ApiHub.GetApi, ApiHub.UpdateApi
Used as field type in: , , ,
string name = 1
Identifier. The name of the API resource in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}`
string display_name = 2
Required. The display name of the API resource.
string description = 3
Optional. The description of the API resource.
optional documentation = 4
Optional. The documentation for the API resource.
optional owner = 5
Optional. Owner details for the API resource.
repeated string versions = 6
Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
optional create_time = 7
Output only. The time at which the API resource was created.
optional update_time = 8
Output only. The time at which the API resource was last updated.
optional target_user = 9
Optional. The target users for the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-target-user` 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.
optional team = 10
Optional. The team owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-team` 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.
optional business_unit = 11
Optional. The business unit owning the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-business-unit` 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.
optional maturity_level = 12
Optional. The maturity level of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-maturity-level` 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.
map<string, > attributes = 13
Optional. The list of user defined attributes associated with the API 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.
optional api_style = 14
Optional. The style of the API. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-api-style` 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.
string selected_version = 15
Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
message
common_fields.proto:1180An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project.
Used as response type in: Provisioning.GetApiHubInstance
Used as field type in: ,
string name = 1
Identifier. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
optional create_time = 2
Output only. Creation timestamp.
optional update_time = 3
Output only. Last update timestamp.
ApiHubInstance.State state = 4
Output only. The current state of the ApiHub instance.
string state_message = 5
Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is `FAILED`.
optional config = 6
Required. Config of the ApiHub instance.
map<string, string> labels = 7
Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
string description = 8
Optional. Description of the ApiHub instance.
message
common_fields.proto:1189Available configurations to provision an ApiHub Instance.
Used in:
string cmek_key_name = 1
Required. The Customer Managed Encryption Key (CMEK) used for data encryption. The CMEK name should follow the format of `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`, where the location must match the instance location.
State of the ApiHub Instance.
Used in:
STATE_UNSPECIFIED = 0
The default value. This value is used if the state is omitted.
INACTIVE = 1
The ApiHub instance has not been initialized or has been deleted.
CREATING = 2
The ApiHub instance is being created.
ACTIVE = 3
The ApiHub instance has been created and is ready for use.
UPDATING = 4
The ApiHub instance is being updated.
DELETING = 5
The ApiHub instance is being deleted.
FAILED = 6
The ApiHub instance encountered an error during a state change.
message
apihub_service.proto:1533ApiHubResource is one of the resources such as Api, Operation, Deployment, Definition, Spec and Version resources stored in API-Hub.
Used in:
oneof resource
api = 1
This represents Api resource in search results. Only name, display_name, description and owner fields are populated in search results.
operation = 2
This represents ApiOperation resource in search results. Only name, and description fields are populated in search results.
deployment = 3
This represents Deployment resource in search results. Only name, display_name and description fields are populated in search results.
spec = 4
This represents Spec resource in search results. Only name, display_name and description fields are populated in search results.
definition = 5
This represents Definition resource in search results. Only name field is populated in search results.
version = 6
This represents Version resource in search results. Only name, display_name and description fields are populated in search results.
message
common_fields.proto:503Represents an operation contained in an API version in the API Hub. An operation is added/updated/deleted in an API version when a new spec is added or an existing spec is updated/deleted in a version. Currently, an operation will be created only corresponding to OpenAPI spec as parsing is supported for OpenAPI spec.
Used as response type in: ApiHub.GetApiOperation
Used as field type in: ,
string name = 1
Identifier. The name of the operation. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
string spec = 2
Output only. The name of the spec from where the operation was parsed. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
optional details = 3
Output only. Operation details.
optional create_time = 4
Output only. The time at which the operation was created.
optional update_time = 5
Output only. The time at which the operation was last updated.
map<string, > attributes = 6
Optional. The list of user defined attributes associated with the API operation resource. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
message
common_fields.proto:610An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.
Used as response type in: ApiHub.CreateAttribute, ApiHub.GetAttribute, ApiHub.UpdateAttribute
Used as field type in: , ,
string name = 1
Identifier. The name of the attribute in the API Hub. Format: `projects/{project}/locations/{location}/attributes/{attribute}`
string display_name = 2
Required. The display name of the attribute.
string description = 3
Optional. The description of the attribute.
Attribute.DefinitionType definition_type = 4
Output only. The definition type of the attribute.
Attribute.Scope scope = 5
Required. The scope of the attribute. It represents the resource in the API Hub to which the attribute can be linked.
Attribute.DataType data_type = 6
Required. The type of the data of the attribute.
repeated allowed_values = 7
Optional. The list of allowed values when the attribute value is of type enum. This is required when the data_type of the attribute is ENUM. The maximum number of allowed values of an attribute will be 1000.
int32 cardinality = 8
Optional. The maximum number of values that the attribute can have when associated with an API Hub resource. Cardinality 1 would represent a single-valued attribute. It must not be less than 1 or greater than 20. If not specified, the cardinality would be set to 1 by default and represent a single-valued attribute.
bool mandatory = 9
Output only. When mandatory is true, the attribute is mandatory for the resource specified in the scope. Only System defined attributes can be mandatory.
optional create_time = 10
Output only. The time at which the attribute was created.
optional update_time = 11
Output only. The time at which the attribute was last updated.
message
common_fields.proto:620The value that can be assigned to the attribute when the data type is enum.
Used in: ,
string id = 1
Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
string display_name = 2
Required. The display name of the allowed value.
string description = 3
Optional. The detailed description of the allowed value.
bool immutable = 4
Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
Enumeration of attribute's data type.
Used in:
DATA_TYPE_UNSPECIFIED = 0
Attribute data type unspecified.
ENUM = 1
Attribute's value is of type enum.
JSON = 2
Attribute's value is of type json.
STRING = 3
Attribute's value is of type string.
Enumeration of attribute definition types.
Used in:
DEFINITION_TYPE_UNSPECIFIED = 0
Attribute definition type unspecified.
SYSTEM_DEFINED = 1
The attribute is predefined by the API Hub. Note that only the list of allowed values can be updated in this case via UpdateAttribute method.
USER_DEFINED = 2
The attribute is defined by the user.
Enumeration for the scope of the attribute representing the resource in the API Hub to which the attribute can be linked.
Used in:
SCOPE_UNSPECIFIED = 0
Scope Unspecified.
API = 1
Attribute can be linked to an API.
VERSION = 2
Attribute can be linked to an API version.
SPEC = 3
Attribute can be linked to a Spec.
API_OPERATION = 4
Attribute can be linked to an API Operation.
DEPLOYMENT = 5
Attribute can be linked to a Deployment.
DEPENDENCY = 6
Attribute can be linked to a Dependency.
DEFINITION = 7
Attribute can be linked to a definition.
EXTERNAL_API = 8
Attribute can be linked to a ExternalAPI.
PLUGIN = 9
Attribute can be linked to a Plugin.
message
common_fields.proto:914The attribute values associated with resource.
Used in: , , , , , , , ,
oneof Value
The attribute values associated with the resource.
enum_values = 2
The attribute values associated with a resource in case attribute data type is enum.
string_values = 3
The attribute values associated with a resource in case attribute data type is string.
json_values = 4
The attribute values associated with a resource in case attribute data type is JSON.
string attribute = 1
Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
message
common_fields.proto:916The attribute values of data type enum.
Used in:
repeated values = 1
Required. The attribute values in case attribute data type is enum.
message
common_fields.proto:923The attribute values of data type string or JSON.
Used in:
repeated string values = 1
Required. The attribute values in case attribute data type is string or JSON.
message
common_fields.proto:551Represents 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.
Used as response type in: ApiHub.GetDefinition
Used as field type in:
oneof value
schema = 4
Output only. The value of a schema definition.
string name = 1
Identifier. The name of the definition. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
string spec = 2
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}`
Definition.Type type = 3
Output only. The type of the definition.
optional create_time = 5
Output only. The time at which the definition was created.
optional update_time = 6
Output only. The time at which the definition was last updated.
map<string, > attributes = 7
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.
Enumeration of definition types.
Used in:
TYPE_UNSPECIFIED = 0
Definition type unspecified.
SCHEMA = 1
Definition type schema.
message
common_fields.proto:959A 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][google.cloud.apihub.v1.Operation] or between an [Operation][google.cloud.apihub.v1.Operation] and [External API][google.cloud.apihub.v1.ExternalApi].
Used as response type in: ApiHubDependencies.CreateDependency, ApiHubDependencies.GetDependency, ApiHubDependencies.UpdateDependency
Used as field type in: , ,
string name = 1
Identifier. The name of the dependency in the API Hub. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`
optional consumer = 2
Required. Immutable. The entity acting as the consumer in the dependency.
optional supplier = 3
Required. Immutable. The entity acting as the supplier in the dependency.
Dependency.State state = 4
Output only. State of the dependency.
string description = 5
Optional. Human readable description corresponding of the dependency.
Dependency.DiscoveryMode discovery_mode = 6
Output only. Discovery mode of the dependency.
optional error_detail = 7
Output only. Error details of a dependency if the system has detected it internally.
optional create_time = 8
Output only. The time at which the dependency was created.
optional update_time = 9
Output only. The time at which the dependency was last updated.
map<string, > attributes = 10
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.
Possible modes of discovering the dependency.
Used in:
DISCOVERY_MODE_UNSPECIFIED = 0
Default value. This value is unused.
MANUAL = 1
Manual mode of discovery when the dependency is defined by the user.
Possible states for a dependency.
Used in:
STATE_UNSPECIFIED = 0
Default value. This value is unused.
PROPOSED = 1
Dependency will be in a proposed state when it is newly identified by the API hub on its own.
VALIDATED = 2
Dependency will be in a validated state when it is validated by the admin or manually created in the API hub.
message
common_fields.proto:1038Reference to an entity participating in a dependency.
Used in:
oneof identifier
Required. Unique identifier for the participating entity.
string operation_resource_name = 2
The resource name of an operation in the API Hub. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
string external_api_resource_name = 3
The resource name of an external API in the API Hub. Format: `projects/{project}/locations/{location}/externalApis/{external_api}`
string display_name = 1
Output only. Display name of the entity.
message
common_fields.proto:1059Details describing error condition of a dependency.
Used in:
DependencyErrorDetail.Error error = 1
Optional. Error in the dependency.
optional error_time = 2
Optional. Timestamp at which the error was found.
Possible values representing an error in the dependency.
Used in:
ERROR_UNSPECIFIED = 0
Default value used for no error in the dependency.
SUPPLIER_NOT_FOUND = 1
Supplier entity has been deleted.
SUPPLIER_RECREATED = 2
Supplier entity has been recreated.
message
common_fields.proto:414Details 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.
Used as response type in: ApiHub.CreateDeployment, ApiHub.GetDeployment, ApiHub.UpdateDeployment
Used as field type in: , , ,
string name = 1
Identifier. The name of the deployment. Format: `projects/{project}/locations/{location}/deployments/{deployment}`
string display_name = 2
Required. The display name of the deployment.
string description = 3
Optional. The description of the deployment.
optional documentation = 4
Optional. The documentation of the deployment.
optional deployment_type = 5
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.
string resource_uri = 6
Required. A URI to the runtime resource. This URI can be used to manage the resource. For example, if the runtime resource is of type APIGEE_PROXY, then this field will contain the URI to the management UI of the proxy.
repeated string endpoints = 7
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.
repeated string api_versions = 8
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).
optional create_time = 9
Output only. The time at which the deployment was created.
optional update_time = 10
Output only. The time at which the deployment was last updated.
optional slo = 11
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.
optional environment = 12
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.
map<string, > attributes = 13
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.
message
common_fields.proto:908Documentation details.
Used in: , , , , ,
string external_uri = 1
Optional. The uri of the externally hosted documentation.
message
common_fields.proto:1254An 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.
Used as response type in: ApiHub.CreateExternalApi, ApiHub.GetExternalApi, ApiHub.UpdateExternalApi
Used as field type in: , ,
string name = 1
Identifier. Format: `projects/{project}/locations/{location}/externalApi/{externalApi}`.
string display_name = 2
Required. Display name of the external API. Max length is 63 characters (Unicode Code Points).
string description = 3
Optional. Description of the external API. Max length is 2000 characters (Unicode Code Points).
repeated string endpoints = 4
Optional. List of endpoints on which this API is accessible.
repeated string paths = 5
Optional. List of paths served by this API.
optional documentation = 6
Optional. Documentation of the external API.
map<string, > attributes = 7
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.
optional create_time = 8
Output only. Creation timestamp.
optional update_time = 9
Output only. Last update timestamp.
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.
Used as response type in: HostProjectRegistrationService.CreateHostProjectRegistration, HostProjectRegistrationService.GetHostProjectRegistration
Used as field type in: ,
string name = 1
Identifier. The name of the host project registration. Format: "projects/{project}/locations/{location}/hostProjectRegistrations/{host_project_registration}".
string gcp_project = 2
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.
optional create_time = 3
Output only. The time at which the host project registration was created.
message
common_fields.proto:836The HTTP Operation.
Used in:
optional path = 1
Output only. The path details for the Operation.
HttpOperation.Method method = 2
Output only. Operation method
Enumeration of Method types.
Used in:
METHOD_UNSPECIFIED = 0
Method unspecified.
GET = 1
Get Operation type.
PUT = 2
Put Operation type.
POST = 3
Post Operation type.
DELETE = 4
Delete Operation type.
OPTIONS = 5
Options Operation type.
HEAD = 6
Head Operation type.
PATCH = 7
Patch Operation type.
TRACE = 8
Trace Operation type.
message
common_fields.proto:1112Issue contains the details of a single issue found by the linter.
Used in:
string code = 1
Required. Rule code unique to each rule defined in linter.
repeated string path = 2
Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
string message = 3
Required. Human-readable message describing the issue found by the linter.
Severity severity = 4
Required. Severity level of the rule violation.
optional range = 5
Required. Object describing where in the file the issue was found.
message
common_fields.proto:1081LintResponse contains the response from the linter.
Used in:
repeated issues = 1
Optional. Array of issues found in the analyzed document.
repeated summary = 2
Optional. Summary of all issue types and counts for each severity level.
LintState state = 3
Required. Lint state represents success or failure for linting.
string source = 4
Required. Name of the linting application.
Linter linter = 5
Required. Name of the linter used.
optional create_time = 6
Required. Timestamp when the linting response was generated.
message
common_fields.proto:1083Count of issues with a given severity.
Used in:
Severity severity = 1
Required. Severity of the issue.
int32 count = 2
Required. Count of issues with the given severity.
Lint state represents success or failure for linting.
Used in:
LINT_STATE_UNSPECIFIED = 0
Lint state unspecified.
LINT_STATE_SUCCESS = 1
Linting was completed successfully.
LINT_STATE_ERROR = 2
Linting encountered errors.
Enumeration of linter types.
Used in: ,
LINTER_UNSPECIFIED = 0
Linter type unspecified.
SPECTRAL = 1
Linter type spectral.
OTHER = 2
Linter type other.
message
common_fields.proto:786OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in [SpecDetails][google.cloud.apihub.v1.SpecDetails].
Used in:
OpenApiSpecDetails.Format format = 1
Output only. The format of the spec.
string version = 2
Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
optional owner = 3
Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
Enumeration of spec formats.
Used in:
FORMAT_UNSPECIFIED = 0
SpecFile type unspecified.
OPEN_API_SPEC_2_0 = 1
OpenAPI Spec v2.0.
OPEN_API_SPEC_3_0 = 2
OpenAPI Spec v3.0.
OPEN_API_SPEC_3_1 = 3
OpenAPI Spec v3.1.
message
common_fields.proto:815The operation details parsed from the spec.
Used in:
oneof operation
http_operation = 4
The HTTP Operation.
string description = 1
Output only. 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.
optional documentation = 2
Output only. Additional external documentation for this operation. For OpenAPI spec, this will map to `operation.documentation` in the spec.
bool deprecated = 3
Output only. For OpenAPI spec, this will be set if `operation.deprecated`is marked as `true` in the spec.
message
common_fields.proto:1149Represents the metadata of the long-running operation.
optional create_time = 1
Output only. The time the operation was created.
optional end_time = 2
Output only. The time the operation finished running.
string target = 3
Output only. Server-defined resource path for the target of the operation.
string verb = 4
Output only. Name of the verb executed by the operation.
string status_message = 5
Output only. Human-readable status of the operation, if any.
bool requested_cancellation = 6
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][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
string api_version = 7
Output only. API version used to start the operation.
message
common_fields.proto:899Owner details.
Used in: ,
string display_name = 1
Optional. The name of the owner.
string email = 2
Required. The email of the owner.
message
common_fields.proto:875The path details derived from the spec.
Used in:
string path = 1
Output only. Complete path relative to server endpoint.
string description = 2
Output only. A short description for the path applicable to all operations.
message
plugin_service.proto:69A plugin resource in the API Hub.
Used as response type in: ApiHubPlugin.DisablePlugin, ApiHubPlugin.EnablePlugin, ApiHubPlugin.GetPlugin
string name = 1
Identifier. The name of the plugin. Format: `projects/{project}/locations/{location}/plugins/{plugin}`
string display_name = 2
Required. The display name of the plugin. Max length is 50 characters (Unicode code points).
optional type = 3
Required. 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.
string description = 4
Optional. The plugin description. Max length is 2000 characters (Unicode code points).
Plugin.State state = 5
Output only. Represents the state of the plugin.
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.
Used in:
STATE_UNSPECIFIED = 0
The default value. This value is used if the state is omitted.
ENABLED = 1
The plugin is enabled.
DISABLED = 2
The plugin is disabled.
message
common_fields.proto:1140Point within the file (line and character).
Used in:
int32 line = 1
Required. Line number (zero-indexed).
int32 character = 2
Required. Character position within the line (zero-indexed).
message
common_fields.proto:1131Object describing where in the file the issue was found.
Used in:
optional start = 1
Required. Start of the issue.
optional end = 2
Required. End of the issue.
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.
Used as response type in: RuntimeProjectAttachmentService.CreateRuntimeProjectAttachment, RuntimeProjectAttachmentService.GetRuntimeProjectAttachment
Used as field type in: , ,
string name = 1
Identifier. The resource name of a runtime project attachment. Format: "projects/{project}/locations/{location}/runtimeProjectAttachments/{runtime_project_attachment}".
string runtime_project = 2
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.
optional create_time = 3
Output only. Create time.
message
common_fields.proto:888The 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.
Used in:
string display_name = 1
Output only. The display name of the schema. This will map to the name of the schema in the spec.
bytes raw_value = 2
Output only. The raw value of the schema definition corresponding to the schema name in the spec.
message
apihub_service.proto:1562Represents the search results.
Used in:
optional resource = 1
This represents the ApiHubResource. Note: Only selected fields of the resources are populated in response.
Severity of the issue.
Used in: ,
SEVERITY_UNSPECIFIED = 0
Severity unspecified.
SEVERITY_ERROR = 1
Severity error.
SEVERITY_WARNING = 2
Severity warning.
SEVERITY_INFO = 3
Severity info.
SEVERITY_HINT = 4
Severity hint.
message
common_fields.proto:317Represents 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.
Used as response type in: ApiHub.CreateSpec, ApiHub.GetSpec, ApiHub.UpdateSpec
Used as field type in: , , ,
string name = 1
Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
string display_name = 2
Required. The display name of the spec. This can contain the file name of the spec.
optional spec_type = 3
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.
optional contents = 4
Optional. Input only. The contents of the uploaded spec.
optional details = 5
Output only. Details parsed from the spec.
string source_uri = 6
Optional. The URI of the spec source in case file is uploaded from an external version control system.
optional create_time = 7
Output only. The time at which the spec was created.
optional update_time = 8
Output only. The time at which the spec was last updated.
optional lint_response = 9
Optional. The lint response for the spec.
map<string, > attributes = 10
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.
optional documentation = 11
Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
Spec.ParsingMode parsing_mode = 12
Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
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`.
Used in:
PARSING_MODE_UNSPECIFIED = 0
Defaults to `RELAXED`.
RELAXED = 1
Parsing of the Spec on create and update is relaxed, meaning that parsing errors the spec contents will not fail the API call.
STRICT = 2
Parsing of the Spec on create and update is strict, meaning that parsing errors in the spec contents will fail the API call.
message
common_fields.proto:757The spec contents.
Used as response type in: ApiHub.GetSpecContents
Used as field type in:
bytes contents = 1
Required. The contents of the spec.
string mime_type = 2
Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
message
common_fields.proto:768SpecDetails contains the details parsed from supported spec types.
Used in:
oneof details
open_api_spec_details = 2
Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using [ListAPIOperations][google.cloud.apihub.v1.ApiHub.ListApiOperations] method.
string description = 1
Output only. The description of the spec.
message
linting_service.proto:137Represents a singleton style guide resource to be used for linting Open API specs.
Used as response type in: LintingService.GetStyleGuide, LintingService.UpdateStyleGuide
Used as field type in:
string name = 1
Identifier. The name of the style guide. Format: `projects/{project}/locations/{location}/plugins/{plugin}/styleGuide`
Linter linter = 2
Required. Target linter for the style guide.
optional contents = 3
Required. Input only. The contents of the uploaded style guide.
message
linting_service.proto:127The style guide contents.
Used as response type in: LintingService.GetStyleGuideContents
Used as field type in:
bytes contents = 1
Required. The contents of the style guide.
string mime_type = 2
Required. The mime type of the content.
message
common_fields.proto:190Represents a version of the API resource in API hub. This is also referred to as the API version.
Used as response type in: ApiHub.CreateVersion, ApiHub.GetVersion, ApiHub.UpdateVersion
Used as field type in: , , ,
string name = 1
Identifier. The name of the version. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}`
string display_name = 2
Required. The display name of the version.
string description = 3
Optional. The description of the version.
optional documentation = 4
Optional. The documentation of the version.
repeated string specs = 5
Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
repeated string api_operations = 6
Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/operations/{operation}`
repeated string definitions = 7
Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is `projects/{project}/locations/{location}/apis/{api}/versions/{version}/definitions/{definition}`
repeated string deployments = 8
Optional. The deployments linked to this API version. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is `projects/{project}/locations/{location}/deployments/{deployment}`
optional create_time = 9
Output only. The time at which the version was created.
optional update_time = 10
Output only. The time at which the version was last updated.
optional lifecycle = 11
Optional. The lifecycle of the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-lifecycle` 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.
optional compliance = 12
Optional. The compliance associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-compliance` 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.
optional accreditation = 13
Optional. The accreditations associated with the API version. This maps to the following system defined attribute: `projects/{project}/locations/{location}/attributes/system-accreditation` 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.
map<string, > attributes = 14
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.
string selected_deployment = 16
Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is `projects/{project}/locations/{location}/deployments/{deployment}`