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.



5139
5140
5141
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5139

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:



5009
5010
5011
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5009

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) 


5016
5017
5018
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5016

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:



5021
5022
5023
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5021

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) 


5026
5027
5028
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5026

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:



5031
5032
5033
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5031

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:



5036
5037
5038
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5036

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:



5041
5042
5043
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5041

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:



5046
5047
5048
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5046

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) 


5053
5054
5055
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5053

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


5058
5059
5060
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5058

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:



5063
5064
5065
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5063

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) 


5070
5071
5072
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5070

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) 


5076
5077
5078
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5076

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:



5081
5082
5083
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5081

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) 


5087
5088
5089
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5087

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) 


5093
5094
5095
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5093

def provider
  @provider
end

#pubsub_topic ⇒ String

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

Returns:

  • (String) 


5098
5099
5100
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5098

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:



5103
5104
5105
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5103

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:



5108
5109
5110
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5108

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) 


5114
5115
5116
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5114

def revision_id
  @revision_id
end

#sequence_number ⇒ Fixnum

DEPRECATED: Use revision_id. Corresponds to the JSON property sequenceNumber

Returns:

  • (Fixnum) 


5119
5120
5121
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5119

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:



5125
5126
5127
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5125

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:



5131
5132
5133
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5131

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) 


5137
5138
5139
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5137

def uid
  @uid
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5144

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