Class: Google::Apis::ApihubV1::GoogleCloudApihubV1Version

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

Overview

Represents a version of the API resource in API hub. This is also referred to as the API version.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApihubV1Version

Returns a new instance of GoogleCloudApihubV1Version.



5260
5261
5262
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5260

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

Instance Attribute Details

#accreditation ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1AttributeValues

The attribute values associated with resource. Corresponds to the JSON property accreditation

Returns:



5164
5165
5166
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5164

def accreditation
  @accreditation
end

#api_operations ⇒ Array<String>

Output only. The operations contained in the API version. These operations will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/project/locations/location/apis/api/ versions/version/operations/operation` Corresponds to the JSON propertyapiOperations`

Returns:

  • (Array<String>) 


5172
5173
5174
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5172

def api_operations
  @api_operations
end

#attributes ⇒ Hash<String,Google::Apis::ApihubV1::GoogleCloudApihubV1AttributeValues>

Optional. The list of user defined attributes associated with the Version resource. 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. Corresponds to the JSON propertyattributes`

Returns:



5180
5181
5182
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5180

def attributes
  @attributes
end

#compliance ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1AttributeValues

The attribute values associated with resource. Corresponds to the JSON property compliance

Returns:



5185
5186
5187
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5185

def compliance
  @compliance
end

#create_time ⇒ String

Output only. The time at which the version was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


5190
5191
5192
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5190

def create_time
  @create_time
end

#definitions ⇒ Array<String>

Output only. The definitions contained in the API version. These definitions will be added to the version when a new spec is added or when an existing spec is updated. Format is projects/project/locations/location/apis/api/ versions/version/definitions/definition` Corresponds to the JSON propertydefinitions`

Returns:

  • (Array<String>) 


5198
5199
5200
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5198

def definitions
  @definitions
end

#deployments ⇒ Array<String>

Optional. The deployments linked directly to this API version. Only directly- linked deployments are returned; deployments linked to this version's specs or operations are not included. Note: A particular API version could be deployed to multiple deployments (for dev deployment, UAT deployment, etc) Format is projects/project/locations/location/deployments/deployment` Corresponds to the JSON propertydeployments`

Returns:

  • (Array<String>) 


5207
5208
5209
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5207

def deployments
  @deployments
end

#description ⇒ String

Optional. The description of the version. Corresponds to the JSON property description

Returns:

  • (String) 


5212
5213
5214
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5212

def description
  @description
end

#display_name ⇒ String

Required. The display name of the version. Corresponds to the JSON property displayName

Returns:

  • (String) 


5217
5218
5219
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5217

def display_name
  @display_name
end

#documentation ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1Documentation

Documentation details. Corresponds to the JSON property documentation

Returns:



5222
5223
5224
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5222

def documentation
  @documentation
end

#lifecycle ⇒ Google::Apis::ApihubV1::GoogleCloudApihubV1AttributeValues

The attribute values associated with resource. Corresponds to the JSON property lifecycle

Returns:



5227
5228
5229
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5227

def lifecycle
  @lifecycle
end

#name ⇒ String

Identifier. The name of the version. Format: projects/project/locations/ location/apis/api/versions/version` Corresponds to the JSON propertyname`

Returns:

  • (String) 


5233
5234
5235
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5233

def name
  @name
end

#selected_deployment ⇒ String

Optional. The selected deployment for a Version resource. This can be used when special handling is needed on client side for a particular deployment linked to the version. Format is projects/project/locations/location/ deployments/deployment` Corresponds to the JSON propertyselectedDeployment`

Returns:

  • (String) 


5241
5242
5243
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5241

def selected_deployment
  @selected_deployment
end

#source_metadata ⇒ Array<Google::Apis::ApihubV1::GoogleCloudApihubV1SourceMetadata>

Output only. The list of sources and metadata from the sources of the version. Corresponds to the JSON property sourceMetadata

Returns:



5246
5247
5248
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5246

def source_metadata
  @source_metadata
end

#specs ⇒ Array<String>

Output only. The specs associated with this version. Note that an API version can be associated with multiple specs. Format is projects/project/locations/ location/apis/api/versions/version/specs/spec` Corresponds to the JSON propertyspecs`

Returns:

  • (Array<String>) 


5253
5254
5255
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5253

def specs
  @specs
end

#update_time ⇒ String

Output only. The time at which the version was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


5258
5259
5260
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5258

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
 
# File 'lib/google/apis/apihub_v1/classes.rb', line 5265

def update!(**args)
  @accreditation = args[:accreditation] if args.key?(:accreditation)
  @api_operations = args[:api_operations] if args.key?(:api_operations)
  @attributes = args[:attributes] if args.key?(:attributes)
  @compliance = args[:compliance] if args.key?(:compliance)
  @create_time = args[:create_time] if args.key?(:create_time)
  @definitions = args[:definitions] if args.key?(:definitions)
  @deployments = args[:deployments] if args.key?(:deployments)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @documentation = args[:documentation] if args.key?(:documentation)
  @lifecycle = args[:lifecycle] if args.key?(:lifecycle)
  @name = args[:name] if args.key?(:name)
  @selected_deployment = args[:selected_deployment] if args.key?(:selected_deployment)
  @source_metadata = args[:source_metadata] if args.key?(:source_metadata)
  @specs = args[:specs] if args.key?(:specs)
  @update_time = args[:update_time] if args.key?(:update_time)
end