Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Instance

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

Apigee runtime instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1Instance

Returns a new instance of GoogleCloudApigeeV1Instance.



3859
3860
3861
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3859

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

Instance Attribute Details

#created_at ⇒ Fixnum

Output only. Time the instance was created in milliseconds since epoch. Corresponds to the JSON property createdAt

Returns:

  • (Fixnum) 


3781
3782
3783
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3781

def created_at
  @created_at
end

#description ⇒ String

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

Returns:

  • (String) 


3786
3787
3788
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3786

def description
  @description
end

#disk_encryption_key_name ⇒ String

Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+) Corresponds to the JSON property diskEncryptionKeyName

Returns:

  • (String) 


3793
3794
3795
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3793

def disk_encryption_key_name
  @disk_encryption_key_name
end

#display_name ⇒ String

Optional. Display name for the instance. Corresponds to the JSON property displayName

Returns:

  • (String) 


3798
3799
3800
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3798

def display_name
  @display_name
end

#host ⇒ String

Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. Corresponds to the JSON property host

Returns:

  • (String) 


3804
3805
3806
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3804

def host
  @host
end

#ip_range ⇒ String

Optional. IP range represents the customer-provided CIDR block of length 22 that will be used for the Apigee instance creation. This optional range, if provided, should be freely available as part of larger named range the customer has allocated to the Service Networking peering. If this is not provided, Apigee will automatically request for any available /22 CIDR block from Service Networking. The customer should use this CIDR block for configuring their firewall needs to allow traffic from Apigee. Input format: " a.b.c.d/22", Output format: a.b.c.d/22, e.f.g.h/28" Corresponds to the JSON property ipRange

Returns:

  • (String) 


3816
3817
3818
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3816

def ip_range
  @ip_range
end

#last_modified_at ⇒ Fixnum

Output only. Time the instance was last modified in milliseconds since epoch. Corresponds to the JSON property lastModifiedAt

Returns:

  • (Fixnum) 


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

def last_modified_at
  @last_modified_at
end

#location ⇒ String

Required. Compute Engine location where the instance resides. Corresponds to the JSON property location

Returns:

  • (String) 


3826
3827
3828
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3826

def location
  @location
end

#name ⇒ String

Required. Resource ID of the instance. Values must match the regular expression ^a-z0,30[a-z\d]$. Corresponds to the JSON property name

Returns:

  • (String) 


3832
3833
3834
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3832

def name
  @name
end

#peering_cidr_range ⇒ String

Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support SLASH_16 to SLASH_20 and defaults to SLASH_16. Evaluation organizations support only SLASH_23. Corresponds to the JSON property peeringCidrRange

Returns:

  • (String) 


3839
3840
3841
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3839

def peering_cidr_range
  @peering_cidr_range
end

#port ⇒ String

Output only. Port number of the exposed Apigee endpoint. Corresponds to the JSON property port

Returns:

  • (String) 


3844
3845
3846
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3844

def port
  @port
end

#runtime_version ⇒ String

Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments. Corresponds to the JSON property runtimeVersion

Returns:

  • (String) 


3851
3852
3853
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3851

def runtime_version
  @runtime_version
end

#state ⇒ String

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

Returns:

  • (String) 


3857
3858
3859
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3857

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3864

def update!(**args)
  @created_at = args[:created_at] if args.key?(:created_at)
  @description = args[:description] if args.key?(:description)
  @disk_encryption_key_name = args[:disk_encryption_key_name] if args.key?(:disk_encryption_key_name)
  @display_name = args[:display_name] if args.key?(:display_name)
  @host = args[:host] if args.key?(:host)
  @ip_range = args[:ip_range] if args.key?(:ip_range)
  @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at)
  @location = args[:location] if args.key?(:location)
  @name = args[:name] if args.key?(:name)
  @peering_cidr_range = args[:peering_cidr_range] if args.key?(:peering_cidr_range)
  @port = args[:port] if args.key?(:port)
  @runtime_version = args[:runtime_version] if args.key?(:runtime_version)
  @state = args[:state] if args.key?(:state)
end