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.



4506
4507
4508
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4506

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

Instance Attribute Details

#addons_config ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1RuntimeAddonsConfig

RuntimeAddonsConfig defines the runtime configurations for add-ons in an environment. Corresponds to the JSON property addonsConfig

Returns:



4376
4377
4378
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4376

def addons_config
  @addons_config
end

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


4383
4384
4385
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4383

def arc_config_location
  @arc_config_location
end

#client_ip_resolution_config ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentConfigClientIpResolutionConfig

Configuration for resolving the client ip. Corresponds to the JSON property clientIpResolutionConfig

Returns:



4388
4389
4390
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4388

def client_ip_resolution_config
  @client_ip_resolution_config
end

#create_time ⇒ String

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

Returns:

  • (String) 


4393
4394
4395
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4393

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:



4398
4399
4400
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4398

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:



4403
4404
4405
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4403

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:



4408
4409
4410
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4408

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:



4413
4414
4415
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4413

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) 


4420
4421
4422
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4420

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


4425
4426
4427
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4425

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:



4430
4431
4432
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4430

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) 


4437
4438
4439
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4437

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) 


4443
4444
4445
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4443

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:



4448
4449
4450
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4448

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) 


4454
4455
4456
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4454

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) 


4460
4461
4462
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4460

def provider
  @provider
end

#pubsub_topic ⇒ String

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

Returns:

  • (String) 


4465
4466
4467
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4465

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:



4470
4471
4472
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4470

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:



4475
4476
4477
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4475

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) 


4481
4482
4483
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4481

def revision_id
  @revision_id
end

#sequence_number ⇒ Fixnum

DEPRECATED: Use revision_id. Corresponds to the JSON property sequenceNumber

Returns:

  • (Fixnum) 


4486
4487
4488
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4486

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:



4492
4493
4494
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4492

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:



4498
4499
4500
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4498

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) 


4504
4505
4506
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4504

def uid
  @uid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4511

def update!(**args)
  @addons_config = args[:addons_config] if args.key?(:addons_config)
  @arc_config_location = args[:arc_config_location] if args.key?(:arc_config_location)
  @client_ip_resolution_config = args[:client_ip_resolution_config] if args.key?(:client_ip_resolution_config)
  @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