Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment

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

Returns a new instance of GoogleCloudApigeeV1Environment.



3821
3822
3823
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3821

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

Instance Attribute Details

#api_proxy_type ⇒ String

Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. Corresponds to the JSON property apiProxyType

Returns:

  • (String) 


3740
3741
3742
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3740

def api_proxy_type
  @api_proxy_type
end

#created_at ⇒ Fixnum

Output only. Creation time of this environment as milliseconds since epoch. Corresponds to the JSON property createdAt

Returns:

  • (Fixnum) 


3745
3746
3747
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3745

def created_at
  @created_at
end

#deployment_type ⇒ String

Optional. Deployment type supported by the environment. The deployment type can be set when creating the environment and cannot be changed. When you enable archive deployment, you will be prevented from performing a subset of actions within the environment, including: * Managing the deployment of API proxy or shared flow revisions * Creating, updating, or deleting resource files * Creating, updating, or deleting target servers Corresponds to the JSON property deploymentType

Returns:

  • (String) 


3756
3757
3758
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3756

def deployment_type
  @deployment_type
end

#description ⇒ String

Optional. Description of the environment. Corresponds to the JSON property description

Returns:

  • (String) 


3761
3762
3763
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3761

def description
  @description
end

#display_name ⇒ String

Optional. Display name for this environment. Corresponds to the JSON property displayName

Returns:

  • (String) 


3766
3767
3768
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3766

def display_name
  @display_name
end

#forward_proxy_uri ⇒ String

Optional. URI of the forward proxy to be applied to the runtime instances in this environment. Must be in the format of scheme://hostname:port. Note that the scheme must be one of "http" or "https", and the port must be supplied. To remove a forward proxy setting, update the field to an empty value. Note: At this time, PUT operations to add forwardProxyUri to an existing environment fail if the environment has nodeConfig set up. To successfully add the forwardProxyUri setting in this case, include the NodeConfig details with the request. Corresponds to the JSON property forwardProxyUri

Returns:

  • (String) 


3778
3779
3780
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3778

def forward_proxy_uri
  @forward_proxy_uri
end

#has_attached_flow_hooks ⇒ Boolean Also known as: has_attached_flow_hooks?

Corresponds to the JSON property hasAttachedFlowHooks

Returns:

  • (Boolean) 


3783
3784
3785
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3783

def has_attached_flow_hooks
  @has_attached_flow_hooks
end

#last_modified_at ⇒ Fixnum

Output only. Last modification time of this environment as milliseconds since epoch. Corresponds to the JSON property lastModifiedAt

Returns:

  • (Fixnum) 


3790
3791
3792
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3790

def last_modified_at
  @last_modified_at
end

#name ⇒ String

Required. Name of the environment. Values must match the regular expression ^[ .\\pAlnum-_]1,255$ Corresponds to the JSON property name

Returns:

  • (String) 


3796
3797
3798
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3796

def name
  @name
end

#node_config ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1NodeConfig

NodeConfig for setting the min/max number of nodes associated with the environment. Corresponds to the JSON property nodeConfig

Returns:



3802
3803
3804
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3802

def node_config
  @node_config
end

#properties ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1Properties

Message for compatibility with legacy Edge specification for Java Properties object in JSON. Corresponds to the JSON property properties

Returns:



3808
3809
3810
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3808

def properties
  @properties
end

#state ⇒ String

Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use. Corresponds to the JSON property state

Returns:

  • (String) 


3814
3815
3816
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3814

def state
  @state
end

#type ⇒ String

Optional. EnvironmentType selected for the environment. Corresponds to the JSON property type

Returns:

  • (String) 


3819
3820
3821
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3819

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3826

def update!(**args)
  @api_proxy_type = args[:api_proxy_type] if args.key?(:api_proxy_type)
  @created_at = args[:created_at] if args.key?(:created_at)
  @deployment_type = args[:deployment_type] if args.key?(:deployment_type)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @forward_proxy_uri = args[:forward_proxy_uri] if args.key?(:forward_proxy_uri)
  @has_attached_flow_hooks = args[:has_attached_flow_hooks] if args.key?(:has_attached_flow_hooks)
  @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at)
  @name = args[:name] if args.key?(:name)
  @node_config = args[:node_config] if args.key?(:node_config)
  @properties = args[:properties] if args.key?(:properties)
  @state = args[:state] if args.key?(:state)
  @type = args[:type] if args.key?(:type)
end