Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

GoogleCloudApihubV1Api

import type { GoogleCloudApihubV1Api } from "https://googleapis.deno.dev/v1/apihub:v1.ts";

An API resource in the API Hub.

interface GoogleCloudApihubV1Api {
apiFunctionalRequirements?: GoogleCloudApihubV1AttributeValues;
apiRequirements?: GoogleCloudApihubV1AttributeValues;
apiStyle?: GoogleCloudApihubV1AttributeValues;
apiTechnicalRequirements?: GoogleCloudApihubV1AttributeValues;
attributes?: {
};
businessUnit?: GoogleCloudApihubV1AttributeValues;
readonly createTime?: Date;
description?: string;
displayName?: string;
documentation?: GoogleCloudApihubV1Documentation;
fingerprint?: string;
maturityLevel?: GoogleCloudApihubV1AttributeValues;
name?: string;
owner?: GoogleCloudApihubV1Owner;
selectedVersion?: string;
readonly sourceMetadata?: GoogleCloudApihubV1SourceMetadata[];
targetUser?: GoogleCloudApihubV1AttributeValues;
team?: GoogleCloudApihubV1AttributeValues;
readonly updateTime?: Date;
readonly versions?: string[];
}

§Properties

§
apiFunctionalRequirements?: GoogleCloudApihubV1AttributeValues
[src]

Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-api-functional-requirements attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.

§
apiRequirements?: GoogleCloudApihubV1AttributeValues
[src]

Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-api-requirements attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.

§
apiStyle?: GoogleCloudApihubV1AttributeValues
[src]

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.

§
apiTechnicalRequirements?: GoogleCloudApihubV1AttributeValues
[src]

Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-api-technical-requirements attribute. The value of the attribute should be a proper URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.

§
attributes?: {
}
[src]

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.

§
businessUnit?: GoogleCloudApihubV1AttributeValues
[src]

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.

§
readonly createTime?: Date
[src]

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

§
description?: string
[src]

Optional. The description of the API resource.

§
displayName?: string
[src]

Required. The display name of the API resource.

§
documentation?: GoogleCloudApihubV1Documentation
[src]

Optional. The documentation for the API resource.

§
fingerprint?: string
[src]

Optional. Fingerprint of the API resource.

§
maturityLevel?: GoogleCloudApihubV1AttributeValues
[src]

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.

§
name?: string
[src]

Identifier. The name of the API resource in the API Hub. Format: projects/{project}/locations/{location}/apis/{api}

§
owner?: GoogleCloudApihubV1Owner
[src]

Optional. Owner details for the API resource.

§
selectedVersion?: string
[src]

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}

§
readonly sourceMetadata?: GoogleCloudApihubV1SourceMetadata[]
[src]

Output only. The list of sources and metadata from the sources of the API resource.

§
targetUser?: GoogleCloudApihubV1AttributeValues
[src]

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.

§
team?: GoogleCloudApihubV1AttributeValues
[src]

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.

§
readonly updateTime?: Date
[src]

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

§
readonly versions?: string[]
[src]

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}