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.



4614
4615
4616
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4614

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:



4482
4483
4484
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4482

def addons_config
  @addons_config
end

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


4489
4490
4491
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4489

def analytics_region
  @analytics_region
end

#attributes ⇒ Array<String>

Not used by Apigee. Corresponds to the JSON property attributes

Returns:

  • (Array<String>) 


4494
4495
4496
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4494

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) 


4510
4511
4512
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4510

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) 


4516
4517
4518
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4516

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) 


4523
4524
4525
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4523

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) 


4529
4530
4531
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4529

def created_at
  @created_at
end

#customer_name ⇒ String

Not used by Apigee. Corresponds to the JSON property customerName

Returns:

  • (String) 


4534
4535
4536
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4534

def customer_name
  @customer_name
end

#description ⇒ String

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

Returns:

  • (String) 


4539
4540
4541
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4539

def description
  @description
end

#display_name ⇒ String

Corresponds to the JSON property displayName

Returns:

  • (String) 


4544
4545
4546
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4544

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


4549
4550
4551
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4549

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) 


4554
4555
4556
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4554

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) 


4560
4561
4562
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4560

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) 


4565
4566
4567
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4565

def name
  @name
end

#project_id ⇒ String

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

Returns:

  • (String) 


4570
4571
4572
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4570

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:



4576
4577
4578
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4576

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) 


4586
4587
4588
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4586

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) 


4592
4593
4594
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4592

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) 


4598
4599
4600
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4598

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) 


4607
4608
4609
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4607

def subscription_type
  @subscription_type
end

#type ⇒ String

Not used by Apigee. Corresponds to the JSON property type

Returns:

  • (String) 


4612
4613
4614
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4612

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 4619

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