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.



3962
3963
3964
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3962

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

Instance Attribute Details

#consumer_accept_list ⇒ Array<String>

Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list. Corresponds to the JSON property consumerAcceptList

Returns:

  • (Array<String>) 


3871
3872
3873
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3871

def consumer_accept_list
  @consumer_accept_list
end

#created_at ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3876
3877
3878
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3876

def created_at
  @created_at
end

#description ⇒ String

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

Returns:

  • (String) 


3881
3882
3883
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3881

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) 


3888
3889
3890
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3888

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) 


3893
3894
3895
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3893

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) 


3899
3900
3901
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3899

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) 


3911
3912
3913
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3911

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) 


3916
3917
3918
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3916

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) 


3921
3922
3923
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3921

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) 


3927
3928
3929
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3927

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) 


3934
3935
3936
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3934

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) 


3939
3940
3941
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3939

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) 


3946
3947
3948
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3946

def runtime_version
  @runtime_version
end

#service_attachment ⇒ String

Output only. Resource name of the service attachment created for the instance in the format: projects/*/regions/*/serviceAttachments/* Apigee customers can privately forward traffic to this service attachment using the PSC endpoints. Corresponds to the JSON property serviceAttachment

Returns:

  • (String) 


3954
3955
3956
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3954

def service_attachment
  @service_attachment
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) 


3960
3961
3962
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3960

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 3967

def update!(**args)
  @consumer_accept_list = args[:consumer_accept_list] if args.key?(:consumer_accept_list)
  @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)
  @service_attachment = args[:service_attachment] if args.key?(:service_attachment)
  @state = args[:state] if args.key?(:state)
end