package google.events.cloud.apihub.v1

Get desktop application:
View/edit binary Protocol Buffers messages

An API resource in the API Hub.

Used in: ApiEventData

• 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 documentation = 4

  Optional. The documentation for the API resource.

• optional Owner 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 protobuf.Timestamp create_time = 7

  Output only. The time at which the API resource was created.

• optional protobuf.Timestamp update_time = 8

  Output only. The time at which the API resource was last updated.

• optional AttributeValues 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 AttributeValues 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 AttributeValues 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 AttributeValues 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, AttributeValues> 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 AttributeValues 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}`

The CloudEvent raised when a Api is created.

• optional ApiEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Api is deleted.

• optional ApiEventData data = 1

  The data associated with the event.

The data within all Api events.

Used in: ApiCreatedEvent, ApiDeletedEvent, ApiUpdatedEvent

• optional Api payload = 1

  Optional. The Api event payload. Unset for deletion events.

An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project.

Used in: ApiHubInstanceEventData

• string name = 1

  Identifier. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.

• optional protobuf.Timestamp create_time = 2

  Output only. Creation timestamp.

• optional protobuf.Timestamp 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 ApiHubInstance.Config 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.

Available configurations to provision an ApiHub Instance.

Used in: ApiHubInstance

• 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: ApiHubInstance

• 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.

The CloudEvent raised when a ApiHubInstance is created.

• optional ApiHubInstanceEventData data = 1

  The data associated with the event.

The data within all ApiHubInstance events.

Used in: ApiHubInstanceCreatedEvent

• optional ApiHubInstance payload = 1

  The ApiHubInstance event payload.

The CloudEvent raised when a Api is updated.

• optional ApiEventData data = 1

  The data associated with the event.

An attribute in the API Hub. An attribute is a name value pair which can be attached to different resources in the API hub based on the scope of the attribute. Attributes can either be pre-defined by the API Hub or created by users.

Used in: AttributeEventData

• 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 Attribute.AllowedValue 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 protobuf.Timestamp create_time = 10

  Output only. The time at which the attribute was created.

• optional protobuf.Timestamp update_time = 11

  Output only. The time at which the attribute was last updated.

The value that can be assigned to the attribute when the data type is enum.

Used in: Attribute, AttributeValues.EnumAttributeValues

• 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: Attribute

• 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: Attribute

• 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: Attribute

• 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.

The CloudEvent raised when a Attribute is created.

• optional AttributeEventData data = 1

  The data associated with the event.

The data within all Attribute events.

Used in: AttributeCreatedEvent

• optional Attribute payload = 1

  Optional. The Attribute event payload. Unset for deletion events.

The attribute values associated with resource.

Used in: Api, Dependency, Deployment, ExternalApi, Spec, Version

• oneof Value

  The attribute values associated with the resource.

  • AttributeValues.EnumAttributeValues enum_values = 2

    The attribute values associated with a resource in case attribute data type is enum.

  • AttributeValues.StringAttributeValues string_values = 3

    The attribute values associated with a resource in case attribute data type is string.

  • AttributeValues.StringAttributeValues 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}

The attribute values of data type enum.

Used in: AttributeValues

• repeated Attribute.AllowedValue values = 1

  Required. The attribute values in case attribute data type is enum.

The attribute values of data type string or JSON.

Used in: AttributeValues

• repeated string values = 1

  Required. The attribute values in case attribute data type is string or JSON.

A dependency resource defined in the API hub describes a dependency directed from a consumer to a supplier entity. A dependency can be defined between two [Operations][google.cloud.apihub.v1.Operation] or between an [Operation][google.cloud.apihub.v1.Operation] and [External API][google.cloud.apihub.v1.ExternalApi].

Used in: DependencyEventData

• string name = 1

  Identifier. The name of the dependency in the API Hub. Format: `projects/{project}/locations/{location}/dependencies/{dependency}`

• optional DependencyEntityReference consumer = 2

  Required. Immutable. The entity acting as the consumer in the dependency.

• optional DependencyEntityReference 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 DependencyErrorDetail error_detail = 7

  Output only. Error details of a dependency if the system has detected it internally.

• optional protobuf.Timestamp create_time = 8

  Output only. The time at which the dependency was created.

• optional protobuf.Timestamp update_time = 9

  Output only. The time at which the dependency was last updated.

• map<string, AttributeValues> 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: Dependency

• 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: Dependency

• 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.

The CloudEvent raised when a Dependency is created.

• optional DependencyEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Dependency is deleted.

• optional DependencyEventData data = 1

  The data associated with the event.

Reference to an entity participating in a dependency.

Used in: Dependency

• 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.

Details describing error condition of a dependency.

Used in: Dependency

• DependencyErrorDetail.Error error = 1

  Optional. Error in the dependency.

• optional protobuf.Timestamp error_time = 2

  Optional. Timestamp at which the error was found.

Possible values representing an error in the dependency.

Used in: DependencyErrorDetail

• 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.

The data within all Dependency events.

Used in: DependencyCreatedEvent, DependencyDeletedEvent, DependencyUpdatedEvent

• optional Dependency payload = 1

  Optional. The Dependency event payload. Unset for deletion events.

The CloudEvent raised when a Dependency is updated.

• optional DependencyEventData data = 1

  The data associated with the event.

Details of the deployment where APIs are hosted. A deployment could represent an Apigee proxy, API gateway, other Google Cloud services or non-Google Cloud services as well. A deployment entity is a root level entity in the API hub and exists independent of any API.

Used in: DeploymentEventData

• 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 documentation = 4

  Optional. The documentation of the deployment.

• optional AttributeValues 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 protobuf.Timestamp create_time = 9

  Output only. The time at which the deployment was created.

• optional protobuf.Timestamp update_time = 10

  Output only. The time at which the deployment was last updated.

• optional AttributeValues 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 AttributeValues 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, AttributeValues> 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.

The CloudEvent raised when a Deployment is created.

• optional DeploymentEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Deployment is deleted.

• optional DeploymentEventData data = 1

  The data associated with the event.

The data within all Deployment events.

Used in: DeploymentCreatedEvent, DeploymentDeletedEvent, DeploymentUpdatedEvent

• optional Deployment payload = 1

  Optional. The Deployment event payload. Unset for deletion events.

The CloudEvent raised when a Deployment is updated.

• optional DeploymentEventData data = 1

  The data associated with the event.

Documentation details.

Used in: Api, Deployment, ExternalApi, Spec, Version

• string external_uri = 1

  Optional. The uri of the externally hosted documentation.

An external API represents an API being provided by external sources. This can be used to model third-party APIs and can be used to define dependencies.

Used in: ExternalApiEventData

• 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 documentation = 6

  Optional. Documentation of the external API.

• map<string, AttributeValues> 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 protobuf.Timestamp create_time = 8

  Output only. Creation timestamp.

• optional protobuf.Timestamp update_time = 9

  Output only. Last update timestamp.

The CloudEvent raised when a ExternalApi is created.

• optional ExternalApiEventData data = 1

  The data associated with the event.

The CloudEvent raised when a ExternalApi is deleted.

• optional ExternalApiEventData data = 1

  The data associated with the event.

The data within all ExternalApi events.

Used in: ExternalApiCreatedEvent, ExternalApiDeletedEvent, ExternalApiUpdatedEvent

• optional ExternalApi payload = 1

  Optional. The ExternalApi event payload. Unset for deletion events.

The CloudEvent raised when a ExternalApi is updated.

• optional ExternalApiEventData data = 1

  The data associated with the event.

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 in: HostProjectRegistrationEventData

• 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 protobuf.Timestamp create_time = 3

  Output only. The time at which the host project registration was created.

The CloudEvent raised when a HostProjectRegistration is created.

• optional HostProjectRegistrationEventData data = 1

  The data associated with the event.

The data within all HostProjectRegistration events.

Used in: HostProjectRegistrationCreatedEvent

• optional HostProjectRegistration payload = 1

  The HostProjectRegistration event payload.

Issue contains the details of a single issue found by the linter.

Used in: LintResponse

• 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 range = 5

  Required. Object describing where in the file the issue was found.

LintResponse contains the response from the linter.

Used in: Spec

• repeated Issue issues = 1

  Optional. Array of issues found in the analyzed document.

• repeated LintResponse.SummaryEntry 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 protobuf.Timestamp create_time = 6

  Required. Timestamp when the linting response was generated.

Count of issues with a given severity.

Used in: LintResponse

• 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: LintResponse

• 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: LintResponse

• LINTER_UNSPECIFIED = 0

  Linter type unspecified.

• SPECTRAL = 1

  Linter type spectral.

• OTHER = 2

  Linter type other.

OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in [SpecDetails][google.cloud.apihub.v1.SpecDetails].

Used in: SpecDetails

• 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 owner = 3

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

Enumeration of spec formats.

Used in: OpenApiSpecDetails

• 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.

Owner details.

Used in: Api, OpenApiSpecDetails

• string display_name = 1

  Optional. The name of the owner.

• string email = 2

  Required. The email of the owner.

Point within the file (line and character).

Used in: Range

• int32 line = 1

  Required. Line number (zero-indexed).

• int32 character = 2

  Required. Character position within the line (zero-indexed).

Object describing where in the file the issue was found.

Used in: Issue

• optional Point start = 1

  Required. Start of the issue.

• optional Point 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 in: RuntimeProjectAttachmentEventData

• 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 protobuf.Timestamp create_time = 3

  Output only. Create time.

The CloudEvent raised when a RuntimeProjectAttachment is created.

• optional RuntimeProjectAttachmentEventData data = 1

  The data associated with the event.

The CloudEvent raised when a RuntimeProjectAttachment is deleted.

• optional RuntimeProjectAttachmentEventData data = 1

  The data associated with the event.

The data within all RuntimeProjectAttachment events.

Used in: RuntimeProjectAttachmentCreatedEvent, RuntimeProjectAttachmentDeletedEvent

• optional RuntimeProjectAttachment payload = 1

  Optional. The RuntimeProjectAttachment event payload. Unset for deletion events.

Severity of the issue.

Used in: Issue, LintResponse.SummaryEntry

• 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.

Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.

Used in: SpecEventData

• 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 AttributeValues 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 SpecDetails 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 protobuf.Timestamp create_time = 7

  Output only. The time at which the spec was created.

• optional protobuf.Timestamp update_time = 8

  Output only. The time at which the spec was last updated.

• optional LintResponse lint_response = 9

  Optional. The lint response for the spec.

• map<string, AttributeValues> 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 documentation = 11

  Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.

The spec contents.

• 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.

The CloudEvent raised when a Spec is created.

• optional SpecEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Spec is deleted.

• optional SpecEventData data = 1

  The data associated with the event.

SpecDetails contains the details parsed from supported spec types.

Used in: Spec

• oneof details

  • OpenApiSpecDetails 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.

The data within all Spec events.

Used in: SpecCreatedEvent, SpecDeletedEvent, SpecUpdatedEvent

• optional Spec payload = 1

  Optional. The Spec event payload. Unset for deletion events.

The CloudEvent raised when a Spec is updated.

• optional SpecEventData data = 1

  The data associated with the event.

Represents a version of the API resource in API hub. This is also referred to as the API version.

Used in: VersionEventData

• 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 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 protobuf.Timestamp create_time = 9

  Output only. The time at which the version was created.

• optional protobuf.Timestamp update_time = 10

  Output only. The time at which the version was last updated.

• optional AttributeValues 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 AttributeValues 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 AttributeValues 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, AttributeValues> 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}`

The CloudEvent raised when a Version is created.

• optional VersionEventData data = 1

  The data associated with the event.

The CloudEvent raised when a Version is deleted.

• optional VersionEventData data = 1

  The data associated with the event.

The data within all Version events.

Used in: VersionCreatedEvent, VersionDeletedEvent, VersionUpdatedEvent

• optional Version payload = 1

  Optional. The Version event payload. Unset for deletion events.

The CloudEvent raised when a Version is updated.

• optional VersionEventData data = 1

  The data associated with the event.