Class Api

A top-level description of an API. Produced by producers and are commitments to provide services.

Inheritance

object

Api

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.ApigeeRegistry.v1.Data

Assembly: Google.Apis.ApigeeRegistry.v1.dll

Syntax

public class Api : IDirectResponseSchema

Properties

Annotations

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.

Declaration

[JsonProperty("annotations")]
public virtual IDictionary<string, string> Annotations { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Availability

A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".

Declaration

[JsonProperty("availability")]
public virtual string Availability { get; set; }

Property Value

Type	Description
string

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. Creation timestamp.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

Description

A detailed description.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

DisplayName

Human-meaningful name.

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Labels

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.

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Name

Resource name.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

RecommendedDeployment

The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}

Declaration

[JsonProperty("recommendedDeployment")]
public virtual string RecommendedDeployment { get; set; }

Property Value

Type	Description
string

RecommendedVersion

The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}

Declaration

[JsonProperty("recommendedVersion")]
public virtual string RecommendedVersion { get; set; }

Property Value

Type	Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

Output only. Last update timestamp.

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema