Class: Google::Apis::ApigeeregistryV1::ApiVersion

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 particular version of an API. ApiVersions are what consumers actually use.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ApiVersion

Returns a new instance of ApiVersion.



422
423
424
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 422

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

Instance Attribute Details

#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>) 


375
376
377
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 375

def annotations
  @annotations
end

#create_time ⇒ String

Output only. Creation timestamp. Corresponds to the JSON property createTime

Returns:

  • (String) 


380
381
382
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 380

def create_time
  @create_time
end

#description ⇒ String

A detailed description. Corresponds to the JSON property description

Returns:

  • (String) 


385
386
387
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 385

def description
  @description
end

#display_name ⇒ String

Human-meaningful name. Corresponds to the JSON property displayName

Returns:

  • (String) 


390
391
392
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 390

def display_name
  @display_name
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>) 


402
403
404
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 402

def labels
  @labels
end

#name ⇒ String

Resource name. Corresponds to the JSON property name

Returns:

  • (String) 


407
408
409
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 407

def name
  @name
end

#state ⇒ String

A user-definable description of the lifecycle phase of this API version. Format: free-form, but we expect single words that describe API maturity, e.g., "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION", "DEPRECATED", " RETIRED". Corresponds to the JSON property state

Returns:

  • (String) 


415
416
417
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 415

def state
  @state
end

#update_time ⇒ String

Output only. Last update timestamp. Corresponds to the JSON property updateTime

Returns:

  • (String) 


420
421
422
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 420

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



427
428
429
430
431
432
433
434
435
436
 
# File 'lib/google/apis/apigeeregistry_v1/classes.rb', line 427

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @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)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
end