Class: Google::Apis::AlloydbV1beta::StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/alloydb_v1beta/classes.rb,
lib/google/apis/alloydb_v1beta/representations.rb,
lib/google/apis/alloydb_v1beta/representations.rb

Overview

Common model for database resource instance metadata. Next ID: 32

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata

Returns a new instance of StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.



4596
4597
4598
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4596

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

Instance Attribute Details

#availability_configuration ⇒ Google::Apis::AlloydbV1beta::StorageDatabasecenterPartnerapiV1mainAvailabilityConfiguration

Configuration for availability of database instance Corresponds to the JSON property availabilityConfiguration

Returns:



4432
4433
4434
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4432

def availability_configuration
  @availability_configuration
end

#backup_configuration ⇒ Google::Apis::AlloydbV1beta::StorageDatabasecenterPartnerapiV1mainBackupConfiguration

Configuration for automatic backups Corresponds to the JSON property backupConfiguration

Returns:



4437
4438
4439
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4437

def backup_configuration
  @backup_configuration
end

#backup_run ⇒ Google::Apis::AlloydbV1beta::StorageDatabasecenterPartnerapiV1mainBackupRun

A backup run. Corresponds to the JSON property backupRun

Returns:



4442
4443
4444
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4442

def backup_run
  @backup_run
end

#backupdr_configuration ⇒ Google::Apis::AlloydbV1beta::StorageDatabasecenterPartnerapiV1mainBackupDrConfiguration

BackupDRConfiguration to capture the backup and disaster recovery details of database resource. Corresponds to the JSON property backupdrConfiguration

Returns:



4448
4449
4450
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4448

def backupdr_configuration
  @backupdr_configuration
end

#creation_time ⇒ String

The creation time of the resource, i.e. the time when resource is created and recorded in partner service. Corresponds to the JSON property creationTime

Returns:

  • (String) 


4454
4455
4456
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4454

def creation_time
  @creation_time
end

#current_state ⇒ String

Current state of the instance. Corresponds to the JSON property currentState

Returns:

  • (String) 


4459
4460
4461
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4459

def current_state
  @current_state
end

#custom_metadata ⇒ Google::Apis::AlloydbV1beta::StorageDatabasecenterPartnerapiV1mainCustomMetadataData

Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data Corresponds to the JSON property customMetadata

Returns:



4466
4467
4468
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4466

def custom_metadata
  @custom_metadata
end

#edition ⇒ String

Optional. Edition represents whether the instance is ENTERPRISE or ENTERPRISE_PLUS. This information is core to Cloud SQL only and is used to identify the edition of the instance. Corresponds to the JSON property edition

Returns:

  • (String) 


4473
4474
4475
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4473

def edition
  @edition
end

#entitlements ⇒ Array<Google::Apis::AlloydbV1beta::StorageDatabasecenterPartnerapiV1mainEntitlement>

Entitlements associated with the resource Corresponds to the JSON property entitlements

Returns:



4478
4479
4480
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4478

def entitlements
  @entitlements
end

#expected_state ⇒ String

The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY. Corresponds to the JSON property expectedState

Returns:

  • (String) 


4485
4486
4487
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4485

def expected_state
  @expected_state
end

#gcbdr_configuration ⇒ Google::Apis::AlloydbV1beta::StorageDatabasecenterPartnerapiV1mainGcbdrConfiguration

GCBDR Configuration for the resource. Corresponds to the JSON property gcbdrConfiguration

Returns:



4490
4491
4492
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4490

def gcbdr_configuration
  @gcbdr_configuration
end

#id ⇒ Google::Apis::AlloydbV1beta::StorageDatabasecenterPartnerapiV1mainDatabaseResourceId

DatabaseResourceId will serve as primary key for any resource ingestion event. Corresponds to the JSON property id

Returns:



4495
4496
4497
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4495

def id
  @id
end

#instance_type ⇒ String

The type of the instance. Specified at creation time. Corresponds to the JSON property instanceType

Returns:

  • (String) 


4500
4501
4502
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4500

def instance_type
  @instance_type
end

#is_deletion_protection_enabled ⇒ Boolean Also known as: is_deletion_protection_enabled?

Optional. Whether deletion protection is enabled for this resource. Corresponds to the JSON property isDeletionProtectionEnabled

Returns:

  • (Boolean) 


4505
4506
4507
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4505

def is_deletion_protection_enabled
  @is_deletion_protection_enabled
end

#location ⇒ String

The resource location. REQUIRED Corresponds to the JSON property location

Returns:

  • (String) 


4511
4512
4513
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4511

def location
  @location
end

#machine_configuration ⇒ Google::Apis::AlloydbV1beta::StorageDatabasecenterPartnerapiV1mainMachineConfiguration

MachineConfiguration describes the configuration of a machine specific to Database Resource. Corresponds to the JSON property machineConfiguration

Returns:



4517
4518
4519
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4517

def machine_configuration
  @machine_configuration
end

#maintenance_info ⇒ Google::Apis::AlloydbV1beta::StorageDatabasecenterPartnerapiV1mainResourceMaintenanceInfo

MaintenanceInfo to capture the maintenance details of database resource. Corresponds to the JSON property maintenanceInfo

Returns:



4522
4523
4524
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4522

def maintenance_info
  @maintenance_info
end

#modes ⇒ Array<String>

Optional. The modes of the database resource. Corresponds to the JSON property modes

Returns:

  • (Array<String>) 


4527
4528
4529
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4527

def modes
  @modes
end

#primary_resource_id ⇒ Google::Apis::AlloydbV1beta::StorageDatabasecenterPartnerapiV1mainDatabaseResourceId

DatabaseResourceId will serve as primary key for any resource ingestion event. Corresponds to the JSON property primaryResourceId

Returns:



4532
4533
4534
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4532

def primary_resource_id
  @primary_resource_id
end

#primary_resource_location ⇒ String

Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. Corresponds to the JSON property primaryResourceLocation

Returns:

  • (String) 


4538
4539
4540
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4538

def primary_resource_location
  @primary_resource_location
end

#product ⇒ Google::Apis::AlloydbV1beta::StorageDatabasecenterProtoCommonProduct

Product specification for Condor resources. Corresponds to the JSON property product

Returns:



4543
4544
4545
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4543

def product
  @product
end

#resource_container ⇒ String

Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of "/", such as "projects/123". For GCP provided resources, number should be project number. Corresponds to the JSON property resourceContainer

Returns:

  • (String) 


4550
4551
4552
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4550

def resource_container
  @resource_container
end

#resource_flags ⇒ Array<Google::Apis::AlloydbV1beta::StorageDatabasecenterPartnerapiV1mainResourceFlags>

Optional. List of resource flags for the database resource. Corresponds to the JSON property resourceFlags

Returns:



4555
4556
4557
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4555

def resource_flags
  @resource_flags
end

#resource_name ⇒ String

Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name " ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common- datamodel Corresponds to the JSON property resourceName

Returns:

  • (String) 


4564
4565
4566
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4564

def resource_name
  @resource_name
end

#suspension_reason ⇒ String

Optional. Suspension reason for the resource. Corresponds to the JSON property suspensionReason

Returns:

  • (String) 


4569
4570
4571
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4569

def suspension_reason
  @suspension_reason
end

#tags_set ⇒ Google::Apis::AlloydbV1beta::StorageDatabasecenterPartnerapiV1mainTags

Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag. Corresponds to the JSON property tagsSet

Returns:



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

def tags_set
  @tags_set
end

#updation_time ⇒ String

The time at which the resource was updated and recorded at partner service. Corresponds to the JSON property updationTime

Returns:

  • (String) 


4581
4582
4583
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4581

def updation_time
  @updation_time
end

#user_label_set ⇒ Google::Apis::AlloydbV1beta::StorageDatabasecenterPartnerapiV1mainUserLabels

Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels. Corresponds to the JSON property userLabelSet

Returns:



4588
4589
4590
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4588

def user_label_set
  @user_label_set
end

#zone ⇒ String

The resource zone. This is only applicable for zonal resources and will be empty for regional and multi-regional resources. Corresponds to the JSON property zone

Returns:

  • (String) 


4594
4595
4596
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4594

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
 
# File 'lib/google/apis/alloydb_v1beta/classes.rb', line 4601

def update!(**args)
  @availability_configuration = args[:availability_configuration] if args.key?(:availability_configuration)
  @backup_configuration = args[:backup_configuration] if args.key?(:backup_configuration)
  @backup_run = args[:backup_run] if args.key?(:backup_run)
  @backupdr_configuration = args[:backupdr_configuration] if args.key?(:backupdr_configuration)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @current_state = args[:current_state] if args.key?(:current_state)
  @custom_metadata = args[:custom_metadata] if args.key?(:custom_metadata)
  @edition = args[:edition] if args.key?(:edition)
  @entitlements = args[:entitlements] if args.key?(:entitlements)
  @expected_state = args[:expected_state] if args.key?(:expected_state)
  @gcbdr_configuration = args[:gcbdr_configuration] if args.key?(:gcbdr_configuration)
  @id = args[:id] if args.key?(:id)
  @instance_type = args[:instance_type] if args.key?(:instance_type)
  @is_deletion_protection_enabled = args[:is_deletion_protection_enabled] if args.key?(:is_deletion_protection_enabled)
  @location = args[:location] if args.key?(:location)
  @machine_configuration = args[:machine_configuration] if args.key?(:machine_configuration)
  @maintenance_info = args[:maintenance_info] if args.key?(:maintenance_info)
  @modes = args[:modes] if args.key?(:modes)
  @primary_resource_id = args[:primary_resource_id] if args.key?(:primary_resource_id)
  @primary_resource_location = args[:primary_resource_location] if args.key?(:primary_resource_location)
  @product = args[:product] if args.key?(:product)
  @resource_container = args[:resource_container] if args.key?(:resource_container)
  @resource_flags = args[:resource_flags] if args.key?(:resource_flags)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @suspension_reason = args[:suspension_reason] if args.key?(:suspension_reason)
  @tags_set = args[:tags_set] if args.key?(:tags_set)
  @updation_time = args[:updation_time] if args.key?(:updation_time)
  @user_label_set = args[:user_label_set] if args.key?(:user_label_set)
  @zone = args[:zone] if args.key?(:zone)
end