Struct ApiDeployment

pub struct ApiDeployment {

    pub name: String,
    pub display_name: String,
    pub description: String,
    pub revision_id: String,
    pub create_time: Option<Timestamp>,
    pub revision_create_time: Option<Timestamp>,
    pub revision_update_time: Option<Timestamp>,
    pub api_spec_revision: String,
    pub endpoint_uri: String,
    pub external_channel_uri: String,
    pub intended_audience: String,
    pub access_guidance: String,
    pub labels: HashMap<String, String>,
    pub annotations: HashMap<String, String>,
}

Describes a service running at particular address that provides a particular version of an API. ApiDeployments have revisions which correspond to different configurations of a single deployment in time. Revision identifiers should be updated whenever the served API spec or endpoint address changes.

Fields

name: String

Resource name.

display_name: String

Human-meaningful name.

description: String

A detailed description.

revision_id: String

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

create_time: Option<Timestamp>

Output only. Creation timestamp; when the deployment resource was created.

revision_create_time: Option<Timestamp>

Output only. Revision creation timestamp; when the represented revision was created.

revision_update_time: Option<Timestamp>

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

api_spec_revision: String

The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: apis/{api}/deployments/{deployment}

endpoint_uri: String

The address where the deployment is serving. Changes to this value will update the revision.

external_channel_uri: String

The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision.

intended_audience: String

Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision.

access_guidance: String

Text briefly describing how to access the endpoint. Changes to this value will not affect the revision.

labels: HashMap<String, String>

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.

annotations: HashMap<String, String>

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.

Trait Implementations

impl Clone for ApiDeployment

fn clone(&self) -> ApiDeployment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApiDeployment

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

Formats the value using the given formatter.

impl Default for ApiDeployment

fn default() -> Self

Returns the “default value” for a type.

impl Message for ApiDeployment

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 ApiDeployment

fn eq(&self, other: &ApiDeployment) -> 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 ApiDeployment