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.



5384
5385
5386
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5384

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

Instance Attribute Details

#addons_config ⇒ Google::Apis::ApigeeV1::GoogleCloudApigeeV1AddonsConfig

Add-on configurations for the Apigee organization. Corresponds to the JSON property addonsConfig

Returns:



5245
5246
5247
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5245

def addons_config
  @addons_config
end

#analytics_region ⇒ String

Required. DEPRECATED: This field will be deprecated once Apigee supports DRZ. Primary GCP region for analytics data storage. For valid values, see Create an Apigee organization. Corresponds to the JSON property analyticsRegion

Returns:

  • (String) 


5253
5254
5255
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5253

def analytics_region
  @analytics_region
end

#attributes ⇒ Array<String>

Not used by Apigee. Corresponds to the JSON property attributes

Returns:

  • (Array<String>) 


5258
5259
5260
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5258

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 must be set before the creation of a runtime instance and 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) 


5274
5275
5276
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5274

def authorized_network
  @authorized_network
end

#billing_type ⇒ String

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

Returns:

  • (String) 


5280
5281
5282
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5280

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) 


5287
5288
5289
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5287

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) 


5293
5294
5295
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5293

def created_at
  @created_at
end

#customer_name ⇒ String

Not used by Apigee. Corresponds to the JSON property customerName

Returns:

  • (String) 


5298
5299
5300
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5298

def customer_name
  @customer_name
end

#description ⇒ String

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

Returns:

  • (String) 


5303
5304
5305
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5303

def description
  @description
end

#display_name ⇒ String

Display name for the Apigee organization. Unused, but reserved for future use. Corresponds to the JSON property displayName

Returns:

  • (String) 


5308
5309
5310
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5308

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


5313
5314
5315
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5313

def environments
  @environments
end

#expires_at ⇒ Fixnum

Output only. Time that the Apigee organization is scheduled for deletion. Corresponds to the JSON property expiresAt

Returns:

  • (Fixnum) 


5318
5319
5320
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5318

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


5324
5325
5326
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5324

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) 


5329
5330
5331
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5329

def name
  @name
end

#portal_disabled ⇒ Boolean Also known as: portal_disabled?

Configuration for the Portals settings. Corresponds to the JSON property portalDisabled

Returns:

  • (Boolean) 


5334
5335
5336
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5334

def portal_disabled
  @portal_disabled
end

#project_id ⇒ String

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

Returns:

  • (String) 


5340
5341
5342
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5340

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:



5346
5347
5348
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5346

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. Required when RuntimeType is CLOUD. If not specified when RuntimeType is TRIAL, a Google-Managed encryption key will be used. For example: "projects/foo/locations/us/keyRings/ bar/cryptoKeys/baz". Note: Not supported for Apigee hybrid. Corresponds to the JSON property runtimeDatabaseEncryptionKeyName

Returns:

  • (String) 


5356
5357
5358
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5356

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) 


5362
5363
5364
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5362

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) 


5368
5369
5370
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5368

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) 


5377
5378
5379
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5377

def subscription_type
  @subscription_type
end

#type ⇒ String

Not used by Apigee. Corresponds to the JSON property type

Returns:

  • (String) 


5382
5383
5384
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5382

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5389

def update!(**args)
  @addons_config = args[:addons_config] if args.key?(:addons_config)
  @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)
  @expires_at = args[:expires_at] if args.key?(:expires_at)
  @last_modified_at = args[:last_modified_at] if args.key?(:last_modified_at)
  @name = args[:name] if args.key?(:name)
  @portal_disabled = args[:portal_disabled] if args.key?(:portal_disabled)
  @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