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: 35

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DatabaseResourceMetadata

Returns a new instance of DatabaseResourceMetadata.



1767
1768
1769
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1767

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

Instance Attribute Details

#additional_metadata ⇒ Hash<String,Object>

Field to ingest additional metadata whichd does not support proto format. Corresponds to the JSON property additionalMetadata

Returns:

  • (Hash<String,Object>) 


1588
1589
1590
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1588

def additional_metadata
  @additional_metadata
end

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

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

Returns:



1593
1594
1595
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1593

def availability_configuration
  @availability_configuration
end

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

Configuration for automatic backups Corresponds to the JSON property backupConfiguration

Returns:



1598
1599
1600
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1598

def backup_configuration
  @backup_configuration
end

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

A backup run. Corresponds to the JSON property backupRun

Returns:



1603
1604
1605
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1603

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:



1609
1610
1611
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1609

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) 


1615
1616
1617
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1615

def creation_time
  @creation_time
end

#current_state ⇒ String

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

Returns:

  • (String) 


1620
1621
1622
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1620

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:



1627
1628
1629
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1627

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) 


1634
1635
1636
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1634

def edition
  @edition
end

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

Entitlements associated with the resource Corresponds to the JSON property entitlements

Returns:



1639
1640
1641
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1639

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) 


1646
1647
1648
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1646

def expected_state
  @expected_state
end

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

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

Returns:



1651
1652
1653
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1651

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:



1656
1657
1658
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1656

def id
  @id
end

#instance_type ⇒ String

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

Returns:

  • (String) 


1661
1662
1663
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1661

def instance_type
  @instance_type
end

#internal_additional_metadata ⇒ Hash<String,Object>

Field to ingest additional metadata which support proto format. Corresponds to the JSON property internalAdditionalMetadata

Returns:

  • (Hash<String,Object>) 


1666
1667
1668
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1666

def internal_additional_metadata
  @internal_additional_metadata
end

#ip_address ⇒ Google::Apis::RedisV1beta1::IpAddress

Used to send IP address information for a database resource. Corresponds to the JSON property ipAddress

Returns:



1671
1672
1673
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1671

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


1676
1677
1678
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1676

def is_deletion_protection_enabled
  @is_deletion_protection_enabled
end

#location ⇒ String

The resource location. REQUIRED Corresponds to the JSON property location

Returns:

  • (String) 


1682
1683
1684
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1682

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:



1688
1689
1690
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1688

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:



1693
1694
1695
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1693

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


1698
1699
1700
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1698

def modes
  @modes
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:



1703
1704
1705
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1703

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) 


1709
1710
1711
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1709

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:



1714
1715
1716
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1714

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) 


1721
1722
1723
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1721

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:



1726
1727
1728
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1726

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) 


1735
1736
1737
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1735

def resource_name
  @resource_name
end

#suspension_reason ⇒ String

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

Returns:

  • (String) 


1740
1741
1742
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1740

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:



1747
1748
1749
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1747

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) 


1752
1753
1754
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1752

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:



1759
1760
1761
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1759

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) 


1765
1766
1767
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1765

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
 
# File 'lib/google/apis/redis_v1beta1/classes.rb', line 1772

def update!(**args)
  @additional_metadata = args[:additional_metadata] if args.key?(:additional_metadata)
  @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)
  @internal_additional_metadata = args[:internal_additional_metadata] if args.key?(:internal_additional_metadata)
  @ip_address = args[:ip_address] if args.key?(:ip_address)
  @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