Class: Google::Apis::AcmednsV1::RotateChallengesRequest

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

Overview

The request message for the RotateChallenges RPC. Requires an access token, a root domain, and either records_to_add or records_to_remove to be populated. Records may be set for multiple subdomains at once to support SAN requests for multiple subdomains in a single domain. By default, ACME TXT record challenges that are older than 30 days will be removed. Set keep_expired_records to false if this behavior is undesired. There is a record maximum of 100 records per domain including expired records. Any request sent that would exceed this maximum will result in a FAILED_PRECONDITION error. NEXT ID: 6

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RotateChallengesRequest

Returns a new instance of RotateChallengesRequest.



117
118
119
 
# File 'lib/google/apis/acmedns_v1/classes.rb', line 117

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

Instance Attribute Details

#access_token ⇒ String

Required. ACME DNS access token. This is a base64 token secret that is procured from the Google Domains website. It authorizes ACME TXT record updates for a domain. Corresponds to the JSON property accessToken NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


98
99
100
 
# File 'lib/google/apis/acmedns_v1/classes.rb', line 98

def access_token
  @access_token
end

#keep_expired_records ⇒ Boolean Also known as: keep_expired_records?

Keep records older than 30 days that were used for previous requests. Corresponds to the JSON property keepExpiredRecords

Returns:

  • (Boolean) 


103
104
105
 
# File 'lib/google/apis/acmedns_v1/classes.rb', line 103

def keep_expired_records
  @keep_expired_records
end

#records_to_add ⇒ Array<Google::Apis::AcmednsV1::AcmeTxtRecord>

ACME TXT record challenges to add. Supports multiple challenges on the same FQDN. Corresponds to the JSON property recordsToAdd

Returns:



110
111
112
 
# File 'lib/google/apis/acmedns_v1/classes.rb', line 110

def records_to_add
  @records_to_add
end

#records_to_remove ⇒ Array<Google::Apis::AcmednsV1::AcmeTxtRecord>

ACME TXT record challenges to remove. Corresponds to the JSON property recordsToRemove

Returns:



115
116
117
 
# File 'lib/google/apis/acmedns_v1/classes.rb', line 115

def records_to_remove
  @records_to_remove
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



122
123
124
125
126
127
 
# File 'lib/google/apis/acmedns_v1/classes.rb', line 122

def update!(**args)
  @access_token = args[:access_token] if args.key?(:access_token)
  @keep_expired_records = args[:keep_expired_records] if args.key?(:keep_expired_records)
  @records_to_add = args[:records_to_add] if args.key?(:records_to_add)
  @records_to_remove = args[:records_to_remove] if args.key?(:records_to_remove)
end