Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProxyRevision

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

Overview

API proxy revision.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1ApiProxyRevision

Returns a new instance of GoogleCloudApigeeV1ApiProxyRevision.



1399
1400
1401
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1399

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

Instance Attribute Details

#archive ⇒ String

Output only. The archive that generated this proxy revision. This field is only present on proxy revisions that were generated by an archive. Proxies generated by archives cannot be updated, deleted, or deployed to other environments. Format: organizations/*/environments/*/archiveDeployments/* Corresponds to the JSON property archive

Returns:

  • (String) 


1252
1253
1254
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1252

def archive
  @archive
end

#basepaths ⇒ Array<String>

Base URL of the API proxy. Corresponds to the JSON property basepaths

Returns:

  • (Array<String>) 


1257
1258
1259
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1257

def basepaths
  @basepaths
end

#configuration_version ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ConfigVersion

Version of the API proxy configuration schema. Currently, only 4.0 is supported. Corresponds to the JSON property configurationVersion

Returns:



1263
1264
1265
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1263

def configuration_version
  @configuration_version
end

#context_info ⇒ String

Revision number, app name, and organization for the API proxy. Corresponds to the JSON property contextInfo

Returns:

  • (String) 


1268
1269
1270
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1268

def context_info
  @context_info
end

#created_at ⇒ Fixnum

Time that the API proxy revision was created in milliseconds since epoch. Corresponds to the JSON property createdAt

Returns:

  • (Fixnum) 


1273
1274
1275
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1273

def created_at
  @created_at
end

#description ⇒ String

Description of the API proxy revision. Corresponds to the JSON property description

Returns:

  • (String) 


1278
1279
1280
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1278

def description
  @description
end

#display_name ⇒ String

Human-readable name of the API proxy. Corresponds to the JSON property displayName

Returns:

  • (String) 


1283
1284
1285
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1283

def display_name
  @display_name
end

#entity_meta_data_as_properties ⇒ Hash<String,String>

Metadata describing the API proxy revision as a key-value map. Corresponds to the JSON property entityMetaDataAsProperties

Returns:

  • (Hash<String,String>) 


1288
1289
1290
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1288

def entity_meta_data_as_properties
  @entity_meta_data_as_properties
end

#has_extensible_policy ⇒ Boolean Also known as: has_extensible_policy?

Output only. This field will be marked as true if revision contains any policies marked as extensible. Corresponds to the JSON property hasExtensiblePolicy

Returns:

  • (Boolean) 


1294
1295
1296
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1294

def has_extensible_policy
  @has_extensible_policy
end

#integration_endpoints ⇒ Array<String>

List of IntegrationEndpoints in the '/integration-endpoints' directory of the API proxy. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy. Corresponds to the JSON property integrationEndpoints

Returns:

  • (Array<String>) 


1302
1303
1304
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1302

def integration_endpoints
  @integration_endpoints
end

#last_modified_at ⇒ Fixnum

Time that the API proxy revision was last modified in milliseconds since epoch. Corresponds to the JSON property lastModifiedAt

Returns:

  • (Fixnum) 


1307
1308
1309
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1307

def last_modified_at
  @last_modified_at
end

#mcp ⇒ Boolean Also known as: mcp?

Output only. Whether this proxy revision is detected as an MCP (Model Context Protocol) proxy. A proxy revision is identified as MCP if it has a proxy endpoint with the /mcp base path that routes to the MCP target URL. Corresponds to the JSON property mcp

Returns:

  • (Boolean) 


1314
1315
1316
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1314

def mcp
  @mcp
end

#name ⇒ String

Name of the API proxy. Corresponds to the JSON property name

Returns:

  • (String) 


1320
1321
1322
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1320

def name
  @name
end

#policies ⇒ Array<String>

List of policy names included in the API proxy revision.. Corresponds to the JSON property policies

Returns:

  • (Array<String>) 


1325
1326
1327
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1325

def policies
  @policies
end

#proxies ⇒ Array<String>

List of proxy names included in the API proxy revision. Corresponds to the JSON property proxies

Returns:

  • (Array<String>) 


1330
1331
1332
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1330

def proxies
  @proxies
end

#proxy_endpoints ⇒ Array<String>

List of ProxyEndpoints in the /proxies directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy. Corresponds to the JSON property proxyEndpoints

Returns:

  • (Array<String>) 


1338
1339
1340
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1338

def proxy_endpoints
  @proxy_endpoints
end

#resource_files ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFiles

List of resource files. Corresponds to the JSON property resourceFiles

Returns:



1343
1344
1345
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1343

def resource_files
  @resource_files
end

#resources ⇒ Array<String>

List of the resources included in the API proxy revision formatted as "type:/ /name". Corresponds to the JSON property resources

Returns:

  • (Array<String>) 


1349
1350
1351
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1349

def resources
  @resources
end

#revision ⇒ String

API proxy revision. Corresponds to the JSON property revision

Returns:

  • (String) 


1354
1355
1356
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1354

def revision
  @revision
end

#shared_flows ⇒ Array<String>

List of the shared flows included in the API proxy revision. Corresponds to the JSON property sharedFlows

Returns:

  • (Array<String>) 


1359
1360
1361
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1359

def shared_flows
  @shared_flows
end

#spec ⇒ String

OpenAPI Specification that is associated with the API proxy. The value is set to a URL or to a path in the specification store. Corresponds to the JSON property spec

Returns:

  • (String) 


1365
1366
1367
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1365

def spec
  @spec
end

#target_endpoints ⇒ Array<String>

List of TargetEndpoints in the /targets directory of the API proxy. Typically, this element is included only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy. Corresponds to the JSON property targetEndpoints

Returns:

  • (Array<String>) 


1373
1374
1375
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1373

def target_endpoints
  @target_endpoints
end

#target_servers ⇒ Array<String>

List of TargetServers referenced in any TargetEndpoint in the API proxy. Typically, you will see this element only when the API proxy was created using the Edge UI. This is a 'manifest' setting designed to provide visibility into the contents of the API proxy. Corresponds to the JSON property targetServers

Returns:

  • (Array<String>) 


1381
1382
1383
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1381

def target_servers
  @target_servers
end

#targets ⇒ Array<String>

List of the targets included in the API proxy revision. Corresponds to the JSON property targets

Returns:

  • (Array<String>) 


1386
1387
1388
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1386

def targets
  @targets
end

#teams ⇒ Array<String>

List of the teams included in the API proxy revision. Corresponds to the JSON property teams

Returns:

  • (Array<String>) 


1391
1392
1393
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1391

def teams
  @teams
end

#type ⇒ String

Type. Set to Application. Maintained for compatibility with the Apigee Edge API. Corresponds to the JSON property type

Returns:

  • (String) 


1397
1398
1399
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1397

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 1404

def update!(**args)
  @archive = args[:archive] if args.key?(:archive)
  @basepaths = args[:basepaths] if args.key?(:basepaths)
  @configuration_version = args[:configuration_version] if args.key?(:configuration_version)
  @context_info = args[:context_info] if args.key?(:context_info)
  @created_at = args[:created_at] if args.key?(:created_at)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @entity_meta_data_as_properties = args[:entity_meta_data_as_properties] if args.key?(:entity_meta_data_as_properties)
  @has_extensible_policy = args[:has_extensible_policy] if args.key?(:has_extensible_policy)
  @integration_endpoints = args[:integration_endpoints] if args.key?(:integration_endpoints)
  @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at)
  @mcp = args[:mcp] if args.key?(:mcp)
  @name = args[:name] if args.key?(:name)
  @policies = args[:policies] if args.key?(:policies)
  @proxies = args[:proxies] if args.key?(:proxies)
  @proxy_endpoints = args[:proxy_endpoints] if args.key?(:proxy_endpoints)
  @resource_files = args[:resource_files] if args.key?(:resource_files)
  @resources = args[:resources] if args.key?(:resources)
  @revision = args[:revision] if args.key?(:revision)
  @shared_flows = args[:shared_flows] if args.key?(:shared_flows)
  @spec = args[:spec] if args.key?(:spec)
  @target_endpoints = args[:target_endpoints] if args.key?(:target_endpoints)
  @target_servers = args[:target_servers] if args.key?(:target_servers)
  @targets = args[:targets] if args.key?(:targets)
  @teams = args[:teams] if args.key?(:teams)
  @type = args[:type] if args.key?(:type)
end