Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentConfig

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1EnvironmentConfig

Returns a new instance of GoogleCloudApigeeV1EnvironmentConfig.



3508
3509
3510
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3508

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

Instance Attribute Details

#arc_config_location ⇒ String

The location for the config blob of API Runtime Control, aka Envoy Adapter, for op-based authentication as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways. Corresponds to the JSON property arcConfigLocation

Returns:

  • (String) 


3390
3391
3392
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3390

def arc_config_location
  @arc_config_location
end

#create_time ⇒ String

Time that the environment configuration was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


3395
3396
3397
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3395

def create_time
  @create_time
end

#data_collectors ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1DataCollectorConfig>

List of data collectors used by the deployments in the environment. Corresponds to the JSON property dataCollectors

Returns:



3400
3401
3402
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3400

def data_collectors
  @data_collectors
end

#debug_mask ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask

Debug mask that applies to all deployments in the environment. Corresponds to the JSON property debugMask

Returns:



3405
3406
3407
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3405

def debug_mask
  @debug_mask
end

#deployment_groups ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentGroupConfig>

List of deployment groups in the environment. Corresponds to the JSON property deploymentGroups

Returns:



3410
3411
3412
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3410

def deployment_groups
  @deployment_groups
end

#deployments ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentConfig>

List of deployments in the environment. Corresponds to the JSON property deployments

Returns:



3415
3416
3417
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3415

def deployments
  @deployments
end

#env_scoped_revision_id ⇒ Fixnum

Revision ID for environment-scoped resources (e.g. target servers, keystores) in this config. This ID will increment any time a resource not scoped to a deployment group changes. Corresponds to the JSON property envScopedRevisionId

Returns:

  • (Fixnum) 


3422
3423
3424
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3422

def env_scoped_revision_id
  @env_scoped_revision_id
end

#feature_flags ⇒ Hash<String,String>

Feature flags inherited from the organization and environment. Corresponds to the JSON property featureFlags

Returns:

  • (Hash<String,String>) 


3427
3428
3429
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3427

def feature_flags
  @feature_flags
end

#flowhooks ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHookConfig>

List of flow hooks in the environment. Corresponds to the JSON property flowhooks

Returns:



3432
3433
3434
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3432

def flowhooks
  @flowhooks
end

#forward_proxy_uri ⇒ String

The forward proxy's url to be used by the runtime. When set, runtime will send requests to the target via the given forward proxy. This is only used by programmable gateways. Corresponds to the JSON property forwardProxyUri

Returns:

  • (String) 


3439
3440
3441
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3439

def forward_proxy_uri
  @forward_proxy_uri
end

#gateway_config_location ⇒ String

The location for the gateway config blob as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways. Corresponds to the JSON property gatewayConfigLocation

Returns:

  • (String) 


3445
3446
3447
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3445

def gateway_config_location
  @gateway_config_location
end

#keystores ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeystoreConfig>

List of keystores in the environment. Corresponds to the JSON property keystores

Returns:



3450
3451
3452
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3450

def keystores
  @keystores
end

#name ⇒ String

Name of the environment configuration in the following format: organizations/ org/environments/env/configs/config` Corresponds to the JSON propertyname`

Returns:

  • (String) 


3456
3457
3458
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3456

def name
  @name
end

#provider ⇒ String

Used by the Control plane to add context information to help detect the source of the document during diagnostics and debugging. Corresponds to the JSON property provider

Returns:

  • (String) 


3462
3463
3464
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3462

def provider
  @provider
end

#pubsub_topic ⇒ String

Name of the PubSub topic for the environment. Corresponds to the JSON property pubsubTopic

Returns:

  • (String) 


3467
3468
3469
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3467

def pubsub_topic
  @pubsub_topic
end

#resource_references ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReferenceConfig>

List of resource references in the environment. Corresponds to the JSON property resourceReferences

Returns:



3472
3473
3474
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3472

def resource_references
  @resource_references
end

#resources ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceConfig>

List of resource versions in the environment. Corresponds to the JSON property resources

Returns:



3477
3478
3479
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3477

def resources
  @resources
end

#revision_id ⇒ Fixnum

Revision ID of the environment configuration. The higher the value, the more recently the configuration was deployed. Corresponds to the JSON property revisionId

Returns:

  • (Fixnum) 


3483
3484
3485
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3483

def revision_id
  @revision_id
end

#sequence_number ⇒ Fixnum

DEPRECATED: Use revision_id. Corresponds to the JSON property sequenceNumber

Returns:

  • (Fixnum) 


3488
3489
3490
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3488

def sequence_number
  @sequence_number
end

#targets ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServerConfig>

List of target servers in the environment. Disabled target servers are not displayed. Corresponds to the JSON property targets

Returns:



3494
3495
3496
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3494

def targets
  @targets
end

#trace_config ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1RuntimeTraceConfig

NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed trace in an environment. Corresponds to the JSON property traceConfig

Returns:



3500
3501
3502
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3500

def trace_config
  @trace_config
end

#uid ⇒ String

Unique ID for the environment configuration. The ID will only change if the environment is deleted and recreated. Corresponds to the JSON property uid

Returns:

  • (String) 


3506
3507
3508
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3506

def uid
  @uid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3513

def update!(**args)
  @arc_config_location = args[:arc_config_location] if args.key?(:arc_config_location)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data_collectors = args[:data_collectors] if args.key?(:data_collectors)
  @debug_mask = args[:debug_mask] if args.key?(:debug_mask)
  @deployment_groups = args[:deployment_groups] if args.key?(:deployment_groups)
  @deployments = args[:deployments] if args.key?(:deployments)
  @env_scoped_revision_id = args[:env_scoped_revision_id] if args.key?(:env_scoped_revision_id)
  @feature_flags = args[:feature_flags] if args.key?(:feature_flags)
  @flowhooks = args[:flowhooks] if args.key?(:flowhooks)
  @forward_proxy_uri = args[:forward_proxy_uri] if args.key?(:forward_proxy_uri)
  @gateway_config_location = args[:gateway_config_location] if args.key?(:gateway_config_location)
  @keystores = args[:keystores] if args.key?(:keystores)
  @name = args[:name] if args.key?(:name)
  @provider = args[:provider] if args.key?(:provider)
  @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic)
  @resource_references = args[:resource_references] if args.key?(:resource_references)
  @resources = args[:resources] if args.key?(:resources)
  @revision_id = args[:revision_id] if args.key?(:revision_id)
  @sequence_number = args[:sequence_number] if args.key?(:sequence_number)
  @targets = args[:targets] if args.key?(:targets)
  @trace_config = args[:trace_config] if args.key?(:trace_config)
  @uid = args[:uid] if args.key?(:uid)
end