Show / Hide Table of Contents

Class GoogleCloudApihubV1Spec

Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.

Inheritance
object
GoogleCloudApihubV1Spec
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 GoogleCloudApihubV1Spec : IDirectResponseSchema

Properties

Attributes

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

Contents

Optional. Input only. The contents of the uploaded spec.

Declaration
[JsonProperty("contents")]
public virtual GoogleCloudApihubV1SpecContents Contents { get; set; }
Property Value
Type Description
GoogleCloudApihubV1SpecContents

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 spec was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

Details

Output only. Details parsed from the spec.

Declaration
[JsonProperty("details")]
public virtual GoogleCloudApihubV1SpecDetails Details { get; set; }
Property Value
Type Description
GoogleCloudApihubV1SpecDetails

DisplayName

Required. The display name of the spec. This can contain the file name of the spec.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

Documentation

Optional. The documentation of the spec. For OpenAPI spec, this will be populated from externalDocs in OpenAPI spec.

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

LintResponse

Optional. The lint response for the spec.

Declaration
[JsonProperty("lintResponse")]
public virtual GoogleCloudApihubV1LintResponse LintResponse { get; set; }
Property Value
Type Description
GoogleCloudApihubV1LintResponse

Name

Identifier. The name of the spec. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

ParsingMode

Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.

Declaration
[JsonProperty("parsingMode")]
public virtual string ParsingMode { get; set; }
Property Value
Type Description
string

SourceMetadata

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

Declaration
[JsonProperty("sourceMetadata")]
public virtual IList<GoogleCloudApihubV1SourceMetadata> SourceMetadata { get; set; }
Property Value
Type Description
IList<GoogleCloudApihubV1SourceMetadata>

SourceUri

Optional. The URI of the spec source in case file is uploaded from an external version control system.

Declaration
[JsonProperty("sourceUri")]
public virtual string SourceUri { get; set; }
Property Value
Type Description
string

SpecType

Required. The type of spec. The value should be one of the allowed values defined for projects/{project}/locations/{location}/attributes/system-spec-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. Note, this field is mandatory if content is provided.

Declaration
[JsonProperty("specType")]
public virtual GoogleCloudApihubV1AttributeValues SpecType { 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 spec was last updated.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX