View Source GoogleApi.ApigeeRegistry.V1.Model.Api (google_api_apigee_registry v0.4.0)

A top-level description of an API. Produced by producers and are commitments to provide services.

Attributes

annotations (type: map(), default: nil) - 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.
availability (type: String.t, default: nil) - A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN".
createTime (type: DateTime.t, default: nil) - Output only. Creation timestamp.
description (type: String.t, default: nil) - A detailed description.
displayName (type: String.t, default: nil) - Human-meaningful name.
labels (type: map(), default: nil) - 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.
name (type: String.t, default: nil) - Resource name.
recommendedDeployment (type: String.t, default: nil) - The recommended deployment of the API. Format: projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}
recommendedVersion (type: String.t, default: nil) - The recommended version of the API. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}
updateTime (type: DateTime.t, default: nil) - Output only. Last update timestamp.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.ApigeeRegistry.V1.Model.Api{
  annotations: map() | nil,
  availability: String.t() | nil,
  createTime: DateTime.t() | nil,
  description: String.t() | nil,
  displayName: String.t() | nil,
  labels: map() | nil,
  name: String.t() | nil,
  recommendedDeployment: String.t() | nil,
  recommendedVersion: String.t() | nil,
  updateTime: DateTime.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.