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.



6009
6010
6011
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6009

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:



5838
5839
5840
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5838

def addons_config
  @addons_config
end

#analytics_region ⇒ String

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

Returns:

  • (String) 


5846
5847
5848
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5846

def analytics_region
  @analytics_region
end

#api_consumer_data_encryption_key_name ⇒ String

Cloud KMS key name used for encrypting API consumer data. Required for US/EU regions when BillingType is SUBSCRIPTION. When [BillingType](

BillingType) is EVALUATION or the region is not US/EU, a Google-Managed

encryption key will be used. Format: projects/*/locations/*/keyRings/*/ cryptoKeys/* Corresponds to the JSON property apiConsumerDataEncryptionKeyName

Returns:

  • (String) 


5855
5856
5857
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5855

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 with control plane in US or EU. 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) 


5863
5864
5865
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5863

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) 


5870
5871
5872
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5870

def apigee_project_id
  @apigee_project_id
end

#attributes ⇒ Array<String>

Not used by Apigee. Corresponds to the JSON property attributes

Returns:

  • (Array<String>) 


5875
5876
5877
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5875

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) 


5891
5892
5893
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5891

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) 


5897
5898
5899
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5897

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) 


5904
5905
5906
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5904

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. Required when BillingType is SUBSCRIPTION. When BillingType is EVALUATION, a Google-Managed encryption key will be used. Format: projects/*/locations/*/keyRings/*/cryptoKeys/* Corresponds to the JSON property controlPlaneEncryptionKeyName

Returns:

  • (String) 


5912
5913
5914
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5912

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) 


5918
5919
5920
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5918

def created_at
  @created_at
end

#customer_name ⇒ String

Not used by Apigee. Corresponds to the JSON property customerName

Returns:

  • (String) 


5923
5924
5925
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5923

def customer_name
  @customer_name
end

#description ⇒ String

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

Returns:

  • (String) 


5928
5929
5930
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5928

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) 


5933
5934
5935
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5933

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


5938
5939
5940
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5938

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) 


5943
5944
5945
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5943

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) 


5949
5950
5951
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5949

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) 


5954
5955
5956
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5954

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) 


5959
5960
5961
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5959

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) 


5965
5966
5967
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5965

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:



5971
5972
5973
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5971

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) 


5981
5982
5983
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5981

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) 


5987
5988
5989
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5987

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) 


5993
5994
5995
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 5993

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) 


6002
6003
6004
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6002

def subscription_type
  @subscription_type
end

#type ⇒ String

Not used by Apigee. Corresponds to the JSON property type

Returns:

  • (String) 


6007
6008
6009
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6007

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6014

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