Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization

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

Returns a new instance of GoogleCloudApigeeV1Organization.



4368
4369
4370
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4368

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

Instance Attribute Details

#analytics_region ⇒ String

Required. Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization. Corresponds to the JSON property analyticsRegion

Returns:

  • (String) 


4249
4250
4251
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4249

def analytics_region
  @analytics_region
end

#attributes ⇒ Array<String>

Not used by Apigee. Corresponds to the JSON property attributes

Returns:

  • (Array<String>) 


4254
4255
4256
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4254

def attributes
  @attributes
end

#authorized_network ⇒ String

Compute Engine network used for Service Networking to be peered with Apigee runtime instances. See Getting started with the Service Networking API. Valid only when RuntimeType is set to CLOUD. The value can be updated only when there are no runtime instances. For example: default. Apigee also supports shared VPC (that is, the host network project is not the same as the one that is peering with Apigee). See Shared VPC overview. To use a shared VPC network, use the following format: projects/host-project-id/region/ networks/network-name`. For example:projects/my-sharedvpc-host/global/ networks/mynetwork**Note:** Not supported for Apigee hybrid. Corresponds to the JSON propertyauthorizedNetwork`

Returns:

  • (String) 


4269
4270
4271
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4269

def authorized_network
  @authorized_network
end

#billing_type ⇒ String

Output only. Billing type of the Apigee organization. See Apigee pricing. Corresponds to the JSON property billingType

Returns:

  • (String) 


4275
4276
4277
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4275

def billing_type
  @billing_type
end

#ca_certificate ⇒ String

Output only. Base64-encoded public certificate for the root CA of the Apigee organization. Valid only when RuntimeType is CLOUD. Corresponds to the JSON property caCertificate NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


4282
4283
4284
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4282

def ca_certificate
  @ca_certificate
end

#created_at ⇒ Fixnum

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

Returns:

  • (Fixnum) 


4288
4289
4290
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4288

def created_at
  @created_at
end

#customer_name ⇒ String

Not used by Apigee. Corresponds to the JSON property customerName

Returns:

  • (String) 


4293
4294
4295
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4293

def customer_name
  @customer_name
end

#description ⇒ String

Description of the Apigee organization. Corresponds to the JSON property description

Returns:

  • (String) 


4298
4299
4300
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4298

def description
  @description
end

#display_name ⇒ String

Corresponds to the JSON property displayName

Returns:

  • (String) 


4303
4304
4305
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4303

def display_name
  @display_name
end

#environments ⇒ Array<String>

Output only. List of environments in the Apigee organization. Corresponds to the JSON property environments

Returns:

  • (Array<String>) 


4308
4309
4310
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4308

def environments
  @environments
end

#last_modified_at ⇒ Fixnum

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

Returns:

  • (Fixnum) 


4314
4315
4316
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4314

def last_modified_at
  @last_modified_at
end

#name ⇒ String

Output only. Name of the Apigee organization. Corresponds to the JSON property name

Returns:

  • (String) 


4319
4320
4321
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4319

def name
  @name
end

#project_id ⇒ String

Project ID associated with the Apigee organization. Corresponds to the JSON property projectId

Returns:

  • (String) 


4324
4325
4326
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4324

def project_id
  @project_id
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:



4330
4331
4332
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4330

def properties
  @properties
end

#runtime_database_encryption_key_name ⇒ String

Cloud KMS key name used for encrypting the data that is stored and replicated across runtime instances. Update is not allowed after the organization is created. If not specified, a Google-Managed encryption key will be used. Valid only when RuntimeType is CLOUD. For example: "projects/foo/ locations/us/keyRings/bar/cryptoKeys/baz". Note: Not supported for Apigee hybrid. Corresponds to the JSON property runtimeDatabaseEncryptionKeyName

Returns:

  • (String) 


4340
4341
4342
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4340

def runtime_database_encryption_key_name
  @runtime_database_encryption_key_name
end

#runtime_type ⇒ String

Required. Runtime type of the Apigee organization based on the Apigee subscription purchased. Corresponds to the JSON property runtimeType

Returns:

  • (String) 


4346
4347
4348
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4346

def runtime_type
  @runtime_type
end

#state ⇒ String

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

Returns:

  • (String) 


4352
4353
4354
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4352

def state
  @state
end

#subscription_type ⇒ String

Output only. DEPRECATED: This will eventually be replaced by BillingType. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased). See Apigee pricing . Corresponds to the JSON property subscriptionType

Returns:

  • (String) 


4361
4362
4363
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4361

def subscription_type
  @subscription_type
end

#type ⇒ String

Not used by Apigee. Corresponds to the JSON property type

Returns:

  • (String) 


4366
4367
4368
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4366

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4373

def update!(**args)
  @analytics_region = args[:analytics_region] if args.key?(:analytics_region)
  @attributes = args[:attributes] if args.key?(:attributes)
  @authorized_network = args[:authorized_network] if args.key?(:authorized_network)
  @billing_type = args[:billing_type] if args.key?(:billing_type)
  @ca_certificate = args[:ca_certificate] if args.key?(:ca_certificate)
  @created_at = args[:created_at] if args.key?(:created_at)
  @customer_name = args[:customer_name] if args.key?(:customer_name)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @environments = args[:environments] if args.key?(:environments)
  @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at)
  @name = args[:name] if args.key?(:name)
  @project_id = args[:project_id] if args.key?(:project_id)
  @properties = args[:properties] if args.key?(:properties)
  @runtime_database_encryption_key_name = args[:runtime_database_encryption_key_name] if args.key?(:runtime_database_encryption_key_name)
  @runtime_type = args[:runtime_type] if args.key?(:runtime_type)
  @state = args[:state] if args.key?(:state)
  @subscription_type = args[:subscription_type] if args.key?(:subscription_type)
  @type = args[:type] if args.key?(:type)
end