Apigee Registry v1 API - Class ApiDeployment (1.0.0-beta06)

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

Reference documentation and code samples for the Apigee Registry v1 API class ApiDeployment.

Describes a service running at particular address that provides a particular version of an API. ApiDeployments have revisions which correspond to different configurations of a single deployment in time. Revision identifiers should be updated whenever the served API spec or endpoint address changes.

Inheritance

object > ApiDeployment

Namespace

Google.Cloud.ApigeeRegistry.V1

Assembly

Google.Cloud.ApigeeRegistry.V1.dll

Constructors

ApiDeployment()

public ApiDeployment()

ApiDeployment(ApiDeployment)

public ApiDeployment(ApiDeployment other)
Parameter
Name Description
other ApiDeployment

Properties

AccessGuidance

public string AccessGuidance { get; set; }

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

Property Value
Type Description
string

Annotations

public MapField<string, string> Annotations { get; }

Annotations attach non-identifying metadata to resources.

Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts.

Property Value
Type Description
MapFieldstringstring

ApiDeploymentName

public ApiDeploymentName ApiDeploymentName { get; set; }

ApiDeploymentName-typed view over the Name resource name property.

Property Value
Type Description
ApiDeploymentName

ApiSpecRevision

public string ApiSpecRevision { get; set; }

The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

Property Value
Type Description
string

ApiSpecRevisionAsApiSpecName

public ApiSpecName ApiSpecRevisionAsApiSpecName { get; set; }

ApiSpecName-typed view over the ApiSpecRevision resource name property.

Property Value
Type Description
ApiSpecName

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Creation timestamp; when the deployment resource was created.

Property Value
Type Description
Timestamp

Description

public string Description { get; set; }

A detailed description.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Human-meaningful name.

Property Value
Type Description
string

EndpointUri

public string EndpointUri { get; set; }

The address where the deployment is serving. Changes to this value will update the revision.

Property Value
Type Description
string

ExternalChannelUri

public string ExternalChannelUri { get; set; }

The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.

Property Value
Type Description
string

IntendedAudience

public string IntendedAudience { get; set; }

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

Property Value
Type Description
string

Labels

public MapField<string, string> Labels { get; }

Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one resource (System labels are excluded).

See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with apigeeregistry.googleapis.com/ and cannot be changed.

Property Value
Type Description
MapFieldstringstring

Name

public string Name { get; set; }

Resource name.

Property Value
Type Description
string

RevisionCreateTime

public Timestamp RevisionCreateTime { get; set; }

Output only. Revision creation timestamp; when the represented revision was created.

Property Value
Type Description
Timestamp

RevisionId

public string RevisionId { get; set; }

Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string.

Property Value
Type Description
string

RevisionUpdateTime

public Timestamp RevisionUpdateTime { get; set; }

Output only. Last update timestamp: when the represented revision was last modified.

Property Value
Type Description
Timestamp