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

GoogleCloudApihubV1Deployment

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

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.

interface GoogleCloudApihubV1Deployment {

readonly apiVersions?: string[];

attributes?: {

[key: string]: GoogleCloudApihubV1AttributeValues;

};

readonly createTime?: Date;

deploymentType?: GoogleCloudApihubV1AttributeValues;

description?: string;

displayName?: string;

documentation?: GoogleCloudApihubV1Documentation;

endpoints?: string[];

environment?: GoogleCloudApihubV1AttributeValues;

managementUrl?: GoogleCloudApihubV1AttributeValues;

name?: string;

resourceUri?: string;

slo?: GoogleCloudApihubV1AttributeValues;

sourceEnvironment?: string;

readonly sourceMetadata?: GoogleCloudApihubV1SourceMetadata[];

sourceProject?: string;

sourceUri?: GoogleCloudApihubV1AttributeValues;

readonly updateTime?: Date;

}

§Properties

readonly apiVersions?: string[]

Output only. The API versions linked to this deployment. Note: A particular deployment could be linked to multiple different API versions (of same or different APIs).

attributes?: {

[key: string]: GoogleCloudApihubV1AttributeValues;

}

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.

readonly createTime?: Date

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

deploymentType?: GoogleCloudApihubV1AttributeValues

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.

description?: string

Optional. The description of the deployment.

displayName?: string

Required. The display name of the deployment.

documentation?: GoogleCloudApihubV1Documentation

Optional. The documentation of the deployment.

endpoints?: string[]

Required. The endpoints at which this deployment resource is listening for API requests. This could be a list of complete URIs, hostnames or an IP addresses.

environment?: GoogleCloudApihubV1AttributeValues

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.

managementUrl?: GoogleCloudApihubV1AttributeValues

Optional. The uri where users can navigate to for the management of the deployment. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-management-url The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URL.

name?: string

Identifier. The name of the deployment. Format: projects/{project}/locations/{location}/deployments/{deployment}

resourceUri?: string

Required. The resource URI identifies the deployment within its gateway. For Apigee gateways, its recommended to use the format: organizations/{org}/environments/{env}/apis/{api}. For ex: if a proxy with name orders is deployed in staging environment of cymbal organization, the resource URI would be: organizations/cymbal/environments/staging/apis/orders.

slo?: GoogleCloudApihubV1AttributeValues

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.

sourceEnvironment?: string

Optional. The environment at source for the deployment. For example: prod, dev, staging, etc.

readonly sourceMetadata?: GoogleCloudApihubV1SourceMetadata[]

Output only. The list of sources and metadata from the sources of the deployment.

sourceProject?: string

Optional. The project to which the deployment belongs. For GCP gateways, this will refer to the project identifier. For others like Edge/OPDK, this will refer to the org identifier.

sourceUri?: GoogleCloudApihubV1AttributeValues

Optional. The uri where additional source specific information for this deployment can be found. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-source-uri The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. The value of the attribute should be a valid URI, and in case of Cloud Storage URI, it should point to a Cloud Storage object, not a directory.

readonly updateTime?: Date

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