API hub v1 API - Class Deployment (1.0.0)

public sealed class Deployment : IMessage<Deployment>, IEquatable<Deployment>, IDeepCloneable<Deployment>, IBufferMessage, IMessage

Reference documentation and code samples for the API hub v1 API class Deployment.

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.

Inheritance

object > Deployment

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Constructors

Deployment()

public Deployment()

Deployment(Deployment)

public Deployment(Deployment other)
Parameter
Name Description
other Deployment

Properties

ApiVersions

public RepeatedField<string> ApiVersions { get; }

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

Property Value
Type Description
RepeatedFieldstring

Attributes

public MapField<string, AttributeValues> Attributes { get; }

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.

Property Value
Type Description
MapFieldstringAttributeValues

CreateTime

public Timestamp CreateTime { get; set; }

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

Property Value
Type Description
Timestamp

DeploymentName

public DeploymentName DeploymentName { get; set; }

DeploymentName-typed view over the Name resource name property.

Property Value
Type Description
DeploymentName

DeploymentType

public AttributeValues DeploymentType { get; set; }

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.

Property Value
Type Description
AttributeValues

Description

public string Description { get; set; }

Optional. The description of the deployment.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Required. The display name of the deployment.

Property Value
Type Description
string

Documentation

public Documentation Documentation { get; set; }

Optional. The documentation of the deployment.

Property Value
Type Description
Documentation

Endpoints

public RepeatedField<string> Endpoints { get; }

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.

Property Value
Type Description
RepeatedFieldstring

Environment

public AttributeValues Environment { get; set; }

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.

Property Value
Type Description
AttributeValues

Name

public string Name { get; set; }

Identifier. The name of the deployment.

Format: projects/{project}/locations/{location}/deployments/{deployment}

Property Value
Type Description
string

ResourceUri

public string ResourceUri { get; set; }

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.

Property Value
Type Description
string

Slo

public AttributeValues Slo { get; set; }

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.

Property Value
Type Description
AttributeValues

UpdateTime

public Timestamp UpdateTime { get; set; }

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

Property Value
Type Description
Timestamp