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;

name?: string;

resourceUri?: string;

slo?: GoogleCloudApihubV1AttributeValues;

readonly sourceMetadata?: GoogleCloudApihubV1SourceMetadata[];

readonly updateTime?: Date;

}

§Properties

readonly apiVersions?: string[]

[src]

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;

}

[src]

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

[src]

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

deploymentType?: GoogleCloudApihubV1AttributeValues

[src]

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

[src]

Optional. The description of the deployment.

displayName?: string

[src]

Required. The display name of the deployment.

documentation?: GoogleCloudApihubV1Documentation

[src]

Optional. The documentation of the deployment.

endpoints?: string[]

[src]

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

[src]

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.

name?: string

[src]

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

resourceUri?: string

[src]

Required. A uri that uniquely identfies the deployment within a particular gateway. For example, if the runtime resource is of type APIGEE_PROXY, then this field will be a combination of org, proxy name and environment.

slo?: GoogleCloudApihubV1AttributeValues

[src]

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.

readonly sourceMetadata?: GoogleCloudApihubV1SourceMetadata[]

[src]

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

readonly updateTime?: Date

[src]

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