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.



7368
7369
7370
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7368

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:



7172
7173
7174
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7172

def addons_config
  @addons_config
end

#analytics_region ⇒ String

Required. DEPRECATED: This field will eventually be deprecated and replaced with a differently-named field. Primary Google Cloud region for analytics data storage. For valid values, see Create an Apigee organization. Corresponds to the JSON property analyticsRegion

Returns:

  • (String) 


7180
7181
7182
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7180

def analytics_region
  @analytics_region
end

#api_consumer_data_encryption_key_name ⇒ String

Cloud KMS key name used for encrypting API consumer data. If not specified or BillingType is EVALUATION, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/* Corresponds to the JSON property apiConsumerDataEncryptionKeyName

Returns:

  • (String) 


7187
7188
7189
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7187

def api_consumer_data_encryption_key_name
  @api_consumer_data_encryption_key_name
end

#api_consumer_data_location ⇒ String

This field is needed only for customers using non-default data residency regions. Apigee stores some control plane data only in single region. This field determines which single region Apigee should use. For example: "us-west1" when control plane is in US or "europe-west2" when control plane is in EU. Corresponds to the JSON property apiConsumerDataLocation

Returns:

  • (String) 


7195
7196
7197
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7195

def api_consumer_data_location
  @api_consumer_data_location
end

#apigee_project_id ⇒ String

Output only. Apigee Project ID associated with the organization. Use this project to allowlist Apigee in the Service Attachment when using private service connect with Apigee. Corresponds to the JSON property apigeeProjectId

Returns:

  • (String) 


7202
7203
7204
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7202

def apigee_project_id
  @apigee_project_id
end

#attributes ⇒ Array<String>

Not used by Apigee. Corresponds to the JSON property attributes

Returns:

  • (Array<String>) 


7207
7208
7209
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7207

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. When changing authorizedNetwork, you must reconfigure VPC peering. After VPC peering with previous network is deleted, run the following command: gcloud services vpc-peerings delete --network=NETWORK, where NETWORK is the name of the previous network. This will delete the previous Service Networking. Otherwise, you will get the following error: The resource 'projects/...-tp' is already linked to another shared VPC host 'projects/...-tp. 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) 


7230
7231
7232
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7230

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) 


7236
7237
7238
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7236

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) 


7243
7244
7245
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7243

def ca_certificate
  @ca_certificate
end

#control_plane_encryption_key_name ⇒ String

Cloud KMS key name used for encrypting control plane data that is stored in a multi region. Only used for the data residency region "US" or "EU". If not specified or BillingType is EVALUATION, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/ cryptoKeys/* Corresponds to the JSON property controlPlaneEncryptionKeyName

Returns:

  • (String) 


7252
7253
7254
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7252

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


7258
7259
7260
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7258

def created_at
  @created_at
end

#customer_name ⇒ String

Not used by Apigee. Corresponds to the JSON property customerName

Returns:

  • (String) 


7263
7264
7265
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7263

def customer_name
  @customer_name
end

#description ⇒ String

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

Returns:

  • (String) 


7268
7269
7270
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7268

def description
  @description
end

#disable_vpc_peering ⇒ Boolean Also known as: disable_vpc_peering?

Optional. Flag that specifies whether the VPC Peering through Private Google Access should be disabled between the consumer network and Apigee. Valid only when RuntimeType is set to CLOUD. Required if an authorizedNetwork on the consumer project is not provided, in which case the flag should be set to true. The value must be set before the creation of any Apigee runtime instance and can be updated only when there are no runtime instances. Note: Apigee will be deprecating the vpc peering model that requires you to provide ' authorizedNetwork', by making the non-peering model as the default way of provisioning Apigee organization in future. So, this will be a temporary flag to enable the transition. Not supported for Apigee hybrid. Corresponds to the JSON property disableVpcPeering

Returns:

  • (Boolean) 


7282
7283
7284
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7282

def disable_vpc_peering
  @disable_vpc_peering
end

#display_name ⇒ String

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

Returns:

  • (String) 


7288
7289
7290
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7288

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


7293
7294
7295
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7293

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) 


7298
7299
7300
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7298

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) 


7304
7305
7306
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7304

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) 


7309
7310
7311
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7309

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) 


7314
7315
7316
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7314

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) 


7320
7321
7322
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7320

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:



7326
7327
7328
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7326

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


7335
7336
7337
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7335

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) 


7341
7342
7343
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7341

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) 


7347
7348
7349
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7347

def state
  @state
end

#subscription_plan ⇒ String

Output only. Subscription plan that the customer has purchased. Output only. Corresponds to the JSON property subscriptionPlan

Returns:

  • (String) 


7352
7353
7354
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7352

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


7361
7362
7363
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7361

def subscription_type
  @subscription_type
end

#type ⇒ String

Not used by Apigee. Corresponds to the JSON property type

Returns:

  • (String) 


7366
7367
7368
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7366

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 7373

def update!(**args)
  @addons_config = args[:addons_config] if args.key?(:addons_config)
  @analytics_region = args[:analytics_region] if args.key?(:analytics_region)
  @api_consumer_data_encryption_key_name = args[:api_consumer_data_encryption_key_name] if args.key?(:api_consumer_data_encryption_key_name)
  @api_consumer_data_location = args[:api_consumer_data_location] if args.key?(:api_consumer_data_location)
  @apigee_project_id = args[:apigee_project_id] if args.key?(:apigee_project_id)
  @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)
  @control_plane_encryption_key_name = args[:control_plane_encryption_key_name] if args.key?(:control_plane_encryption_key_name)
  @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)
  @disable_vpc_peering = args[:disable_vpc_peering] if args.key?(:disable_vpc_peering)
  @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_plan = args[:subscription_plan] if args.key?(:subscription_plan)
  @subscription_type = args[:subscription_type] if args.key?(:subscription_type)
  @type = args[:type] if args.key?(:type)
end