Class: Google::Apis::RedisV1beta1::DatabaseResourceMetadata

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DatabaseResourceMetadata

Returns a new instance of DatabaseResourceMetadata.



1583
1584
1585
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1583

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

Instance Attribute Details

#availability_configuration ⇒ Google::Apis::RedisV1beta1::AvailabilityConfiguration

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

Returns:



1424
1425
1426
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1424

def availability_configuration
  @availability_configuration
end

#backup_configuration ⇒ Google::Apis::RedisV1beta1::BackupConfiguration

Configuration for automatic backups Corresponds to the JSON property backupConfiguration

Returns:



1429
1430
1431
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1429

def backup_configuration
  @backup_configuration
end

#backup_run ⇒ Google::Apis::RedisV1beta1::BackupRun

A backup run. Corresponds to the JSON property backupRun

Returns:



1434
1435
1436
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1434

def backup_run
  @backup_run
end

#backupdr_configuration ⇒ Google::Apis::RedisV1beta1::BackupDrConfiguration

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

Returns:



1440
1441
1442
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1440

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) 


1446
1447
1448
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1446

def creation_time
  @creation_time
end

#current_state ⇒ String

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

Returns:

  • (String) 


1451
1452
1453
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1451

def current_state
  @current_state
end

#custom_metadata ⇒ Google::Apis::RedisV1beta1::CustomMetadataData

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:



1458
1459
1460
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1458

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) 


1465
1466
1467
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1465

def edition
  @edition
end

#entitlements ⇒ Array<Google::Apis::RedisV1beta1::Entitlement>

Entitlements associated with the resource Corresponds to the JSON property entitlements

Returns:



1470
1471
1472
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1470

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) 


1477
1478
1479
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1477

def expected_state
  @expected_state
end

#gcbdr_configuration ⇒ Google::Apis::RedisV1beta1::GcbdrConfiguration

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

Returns:



1482
1483
1484
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1482

def gcbdr_configuration
  @gcbdr_configuration
end

#id ⇒ Google::Apis::RedisV1beta1::DatabaseResourceId

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

Returns:



1487
1488
1489
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1487

def id
  @id
end

#instance_type ⇒ String

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

Returns:

  • (String) 


1492
1493
1494
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1492

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) 


1497
1498
1499
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1497

def is_deletion_protection_enabled
  @is_deletion_protection_enabled
end

#location ⇒ String

The resource location. REQUIRED Corresponds to the JSON property location

Returns:

  • (String) 


1503
1504
1505
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1503

def location
  @location
end

#machine_configuration ⇒ Google::Apis::RedisV1beta1::MachineConfiguration

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

Returns:



1509
1510
1511
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1509

def machine_configuration
  @machine_configuration
end

#maintenance_info ⇒ Google::Apis::RedisV1beta1::ResourceMaintenanceInfo

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

Returns:



1514
1515
1516
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1514

def maintenance_info
  @maintenance_info
end

#primary_resource_id ⇒ Google::Apis::RedisV1beta1::DatabaseResourceId

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

Returns:



1519
1520
1521
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1519

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) 


1525
1526
1527
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1525

def primary_resource_location
  @primary_resource_location
end

#product ⇒ Google::Apis::RedisV1beta1::Product

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

Returns:



1530
1531
1532
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1530

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) 


1537
1538
1539
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1537

def resource_container
  @resource_container
end

#resource_flags ⇒ Array<Google::Apis::RedisV1beta1::ResourceFlags>

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

Returns:



1542
1543
1544
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1542

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) 


1551
1552
1553
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1551

def resource_name
  @resource_name
end

#suspension_reason ⇒ String

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

Returns:

  • (String) 


1556
1557
1558
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1556

def suspension_reason
  @suspension_reason
end

#tags_set ⇒ Google::Apis::RedisV1beta1::Tags

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:



1563
1564
1565
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1563

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) 


1568
1569
1570
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1568

def updation_time
  @updation_time
end

#user_label_set ⇒ Google::Apis::RedisV1beta1::UserLabels

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:



1575
1576
1577
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1575

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) 


1581
1582
1583
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1581

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1588

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