Struct Spec

pub struct Spec {
    pub name: String,
    pub display_name: String,
    pub spec_type: Option<AttributeValues>,
    pub contents: Option<SpecContents>,
    pub details: Option<SpecDetails>,
    pub source_uri: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub lint_response: Option<LintResponse>,
    pub attributes: HashMap<String, AttributeValues>,
    pub documentation: Option<Documentation>,
    pub parsing_mode: i32,
}

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.

Fields

name: String

Identifier. The name of the spec.

Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}

display_name: String

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

spec_type: Option<AttributeValues>

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.

contents: Option<SpecContents>

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

details: Option<SpecDetails>

Output only. Details parsed from the spec.

source_uri: String

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

create_time: Option<Timestamp>

Output only. The time at which the spec was created.

update_time: Option<Timestamp>

Output only. The time at which the spec was last updated.

lint_response: Option<LintResponse>

Optional. The lint response for the spec.

attributes: HashMap<String, AttributeValues>

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.

documentation: Option<Documentation>

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

parsing_mode: i32

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

Implementations

impl Spec

pub fn parsing_mode(&self) -> ParsingMode

Returns the enum value of parsing_mode, or the default if the field is set to an invalid enum value.

pub fn set_parsing_mode(&mut self, value: ParsingMode)

Sets parsing_mode to the provided enum value.

Trait Implementations

impl Clone for Spec

fn clone(&self) -> Spec

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Spec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Spec

fn default() -> Self

Returns the “default value” for a type.

impl Message for Spec

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Spec

fn eq(&self, other: &Spec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Spec