GetSpecResult

data class GetSpecResult(val annotations: Map<String, String>, val contents: String, val createTime: String, val description: String, val filename: String, val hash: String, val labels: Map<String, String>, val mimeType: String, val name: String, val revisionCreateTime: String, val revisionId: String, val revisionUpdateTime: String, val sizeBytes: Int, val sourceUri: String)

Constructors

Link copied to clipboard
constructor(annotations: Map<String, String>, contents: String, createTime: String, description: String, filename: String, hash: String, labels: Map<String, String>, mimeType: String, name: String, revisionCreateTime: String, revisionId: String, revisionUpdateTime: String, sizeBytes: Int, sourceUri: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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.

Link copied to clipboard

Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents.

Link copied to clipboard

Creation timestamp; when the spec resource was created.

Link copied to clipboard

A detailed description.

Link copied to clipboard

A possibly-hierarchical name used to refer to the spec from other specs.

Link copied to clipboard

A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec.

Link copied to clipboard

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.

Link copied to clipboard

A style (format) descriptor for this spec that is specified as a Media Type (https://en.wikipedia.org/wiki/Media_type). Possible values include application/vnd.apigee.proto, application/vnd.apigee.openapi, and application/vnd.apigee.graphql, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip").

Link copied to clipboard

Resource name.

Link copied to clipboard

Revision creation timestamp; when the represented revision was created.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec.

Link copied to clipboard

The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved.