Class: Google::Apis::ApigeeregistryV1::ApiDeployment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/apigeeregistry_v1/classes.rb,
lib/google/apis/apigeeregistry_v1/representations.rb,
lib/google/apis/apigeeregistry_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ApiDeployment

Returns a new instance of ApiDeployment.



211
212
213
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 211

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#access_guidance ⇒ String

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

Returns:

  • (String) 


124
125
126
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 124

def access_guidance
  @access_guidance
end

#annotations ⇒ Hash<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. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


132
133
134
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 132

def annotations
  @annotations
end

#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: projects/project/locations/location/apis/api/versions/version/ specs/spec@revision` Corresponds to the JSON propertyapiSpecRevision`

Returns:

  • (String) 


140
141
142
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 140

def api_spec_revision
  @api_spec_revision
end

#create_time ⇒ String

Output only. Creation timestamp; when the deployment resource was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


145
146
147
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 145

def create_time
  @create_time
end

#description ⇒ String

A detailed description. Corresponds to the JSON property description

Returns:

  • (String) 


150
151
152
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 150

def description
  @description
end

#display_name ⇒ String

Human-meaningful name. Corresponds to the JSON property displayName

Returns:

  • (String) 


155
156
157
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 155

def display_name
  @display_name
end

#endpoint_uri ⇒ String

The address where the deployment is serving. Changes to this value will update the revision. Corresponds to the JSON property endpointUri

Returns:

  • (String) 


161
162
163
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 161

def endpoint_uri
  @endpoint_uri
end

#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. Corresponds to the JSON property externalChannelUri

Returns:

  • (String) 


167
168
169
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 167

def external_channel_uri
  @external_channel_uri
end

#intended_audience ⇒ String

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

Returns:

  • (String) 


173
174
175
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 173

def intended_audience
  @intended_audience
end

#labels ⇒ Hash<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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


185
186
187
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 185

def labels
  @labels
end

#name ⇒ String

Resource name. Corresponds to the JSON property name

Returns:

  • (String) 


190
191
192
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 190

def name
  @name
end

#revision_create_time ⇒ String

Output only. Revision creation timestamp; when the represented revision was created. Corresponds to the JSON property revisionCreateTime

Returns:

  • (String) 


196
197
198
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 196

def revision_create_time
  @revision_create_time
end

#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. Corresponds to the JSON property revisionId

Returns:

  • (String) 


203
204
205
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 203

def revision_id
  @revision_id
end

#revision_update_time ⇒ String

Output only. Last update timestamp: when the represented revision was last modified. Corresponds to the JSON property revisionUpdateTime

Returns:

  • (String) 


209
210
211
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 209

def revision_update_time
  @revision_update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 216

def update!(**args)
  @access_guidance = args[:access_guidance] if args.key?(:access_guidance)
  @annotations = args[:annotations] if args.key?(:annotations)
  @api_spec_revision = args[:api_spec_revision] if args.key?(:api_spec_revision)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @endpoint_uri = args[:endpoint_uri] if args.key?(:endpoint_uri)
  @external_channel_uri = args[:external_channel_uri] if args.key?(:external_channel_uri)
  @intended_audience = args[:intended_audience] if args.key?(:intended_audience)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @revision_create_time = args[:revision_create_time] if args.key?(:revision_create_time)
  @revision_id = args[:revision_id] if args.key?(:revision_id)
  @revision_update_time = args[:revision_update_time] if args.key?(:revision_update_time)
end