Class GoogleCloudApihubV1Api

An API resource in the API Hub.

Inheritance

object

GoogleCloudApihubV1Api

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.APIhub.v1.Data

Assembly: Google.Apis.APIhub.v1.dll

Syntax

public class GoogleCloudApihubV1Api : IDirectResponseSchema

Properties

ApiFunctionalRequirements

Optional. The api functional requirements associated with the API resource. Carinality is 1 for this attribute.

Declaration

[JsonProperty("apiFunctionalRequirements")]
public virtual GoogleCloudApihubV1AttributeValues ApiFunctionalRequirements { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1AttributeValues

ApiRequirements

Optional. The api requirement doc associated with the API resource. Carinality is 1 for this attribute.

Declaration

[JsonProperty("apiRequirements")]
public virtual GoogleCloudApihubV1AttributeValues ApiRequirements { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1AttributeValues

ApiStyle

Optional. The style of the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-api-style 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.

Declaration

[JsonProperty("apiStyle")]
public virtual GoogleCloudApihubV1AttributeValues ApiStyle { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1AttributeValues

ApiTechnicalRequirements

Optional. The api technical requirements associated with the API resource. Carinality is 1 for this attribute.

Declaration

[JsonProperty("apiTechnicalRequirements")]
public virtual GoogleCloudApihubV1AttributeValues ApiTechnicalRequirements { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1AttributeValues

Attributes

Optional. The list of user defined attributes associated with the API 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.

Declaration

[JsonProperty("attributes")]
public virtual IDictionary<string, GoogleCloudApihubV1AttributeValues> Attributes { get; set; }

Property Value

Type	Description
IDictionary<string, GoogleCloudApihubV1AttributeValues>

BusinessUnit

Optional. The business unit owning the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-business-unit 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.

Declaration

[JsonProperty("businessUnit")]
public virtual GoogleCloudApihubV1AttributeValues BusinessUnit { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1AttributeValues

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. The time at which the API resource was created.

Declaration

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

Property Value

Type	Description
string

Description

Optional. The description of the API resource.

Declaration

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

Property Value

Type	Description
string

DisplayName

Required. The display name of the API resource.

Declaration

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

Property Value

Type	Description
string

Documentation

Optional. The documentation for the API resource.

Declaration

[JsonProperty("documentation")]
public virtual GoogleCloudApihubV1Documentation Documentation { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1Documentation

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Fingerprint

Optional. Fingerprint of the API resource.

Declaration

[JsonProperty("fingerprint")]
public virtual string Fingerprint { get; set; }

Property Value

Type	Description
string

MaturityLevel

Optional. The maturity level of the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-maturity-level 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.

Declaration

[JsonProperty("maturityLevel")]
public virtual GoogleCloudApihubV1AttributeValues MaturityLevel { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1AttributeValues

Name

Identifier. The name of the API resource in the API Hub. Format: projects/{project}/locations/{location}/apis/{api}

Declaration

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

Property Value

Type	Description
string

Owner

Optional. Owner details for the API resource.

Declaration

[JsonProperty("owner")]
public virtual GoogleCloudApihubV1Owner Owner { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1Owner

SelectedVersion

Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}

Declaration

[JsonProperty("selectedVersion")]
public virtual string SelectedVersion { get; set; }

Property Value

Type	Description
string

SourceMetadata

Output only. The list of sources and metadata from the sources of the API resource.

Declaration

[JsonProperty("sourceMetadata")]
public virtual IList<GoogleCloudApihubV1SourceMetadata> SourceMetadata { get; set; }

Property Value

Type	Description
IList<GoogleCloudApihubV1SourceMetadata>

TargetUser

Optional. The target users for the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-target-user 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.

Declaration

[JsonProperty("targetUser")]
public virtual GoogleCloudApihubV1AttributeValues TargetUser { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1AttributeValues

Team

Optional. The team owning the API. This maps to the following system defined attribute: projects/{project}/locations/{location}/attributes/system-team 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.

Declaration

[JsonProperty("team")]
public virtual GoogleCloudApihubV1AttributeValues Team { get; set; }

Property Value

Type	Description
GoogleCloudApihubV1AttributeValues

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. The time at which the API resource was last updated.

Declaration

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

Property Value

Type	Description
string

Versions

Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is projects/{project}/locations/{location}/apis/{api}/versions/{version}

Declaration

[JsonProperty("versions")]
public virtual IList<string> Versions { get; set; }

Property Value

Type	Description
IList<string>

Implements

IDirectResponseSchema