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.



4121
4122
4123
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4121

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


4030
4031
4032
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4030

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) 


4035
4036
4037
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4035

def created_at
  @created_at
end

#description ⇒ String

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

Returns:

  • (String) 


4040
4041
4042
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4040

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) 


4047
4048
4049
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4047

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) 


4052
4053
4054
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4052

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) 


4058
4059
4060
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4058

def host
  @host
end

#ip_range ⇒ String

Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the / 22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: a.b.c.d/22 or e.f.g.h/28 or a.b.c.d/22,e.f.g.h/28 Corresponds to the JSON property ipRange

Returns:

  • (String) 


4070
4071
4072
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4070

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) 


4075
4076
4077
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4075

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) 


4080
4081
4082
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4080

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) 


4086
4087
4088
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4086

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) 


4093
4094
4095
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4093

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) 


4098
4099
4100
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4098

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) 


4105
4106
4107
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4105

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) 


4113
4114
4115
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4113

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) 


4119
4120
4121
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4119

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4126

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