Class: Google::Apis::BackupdrV1::ManagementServer

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

Overview

ManagementServer describes a single BackupDR ManagementServer instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ManagementServer

Returns a new instance of ManagementServer.



496
497
498
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 496

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

Instance Attribute Details

#ba_proxy_uri ⇒ Array<String>

Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy. Corresponds to the JSON property baProxyUri

Returns:

  • (Array<String>) 


421
422
423
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 421

def ba_proxy_uri
  @ba_proxy_uri
end

#create_time ⇒ String

Output only. The time when the instance was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


426
427
428
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 426

def create_time
  @create_time
end

#description ⇒ String

Optional. The description of the ManagementServer instance (2048 characters or less). Corresponds to the JSON property description

Returns:

  • (String) 


432
433
434
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 432

def description
  @description
end

#etag ⇒ String

Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other. Corresponds to the JSON property etag

Returns:

  • (String) 


438
439
440
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 438

def etag
  @etag
end

#labels ⇒ Hash<String,String>

Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go= If set to true, the MS is created in migration ready mode. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


445
446
447
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 445

def labels
  @labels
end

#management_uri ⇒ Google::Apis::BackupdrV1::ManagementUri

ManagementURI for the Management Server resource. Corresponds to the JSON property managementUri

Returns:



450
451
452
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 450

def management_uri
  @management_uri
end

#name ⇒ String

Output only. Identifier. The resource name. Corresponds to the JSON property name

Returns:

  • (String) 


455
456
457
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 455

def name
  @name
end

#networks ⇒ Array<Google::Apis::BackupdrV1::NetworkConfig>

Required. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. Corresponds to the JSON property networks

Returns:



461
462
463
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 461

def networks
  @networks
end

#oauth2_client_id ⇒ String

Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the ‘aud’ field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken). Corresponds to the JSON property oauth2ClientId

Returns:

  • (String) 


469
470
471
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 469

def oauth2_client_id
  @oauth2_client_id
end

#state ⇒ String

Output only. The ManagementServer state. Corresponds to the JSON property state

Returns:

  • (String) 


474
475
476
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 474

def state
  @state
end

#type ⇒ String

Optional. The type of the ManagementServer resource. Corresponds to the JSON property type

Returns:

  • (String) 


479
480
481
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 479

def type
  @type
end

#update_time ⇒ String

Output only. The time when the instance was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


484
485
486
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 484

def update_time
  @update_time
end

#workforce_identity_based_management_uri ⇒ Google::Apis::BackupdrV1::WorkforceIdentityBasedManagementUri

ManagementURI depending on the Workforce Identity i.e. either 1p or 3p. Corresponds to the JSON property workforceIdentityBasedManagementUri

Returns:



489
490
491
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 489

def workforce_identity_based_management_uri
  @workforce_identity_based_management_uri
end

#workforce_identity_based_oauth2_client_id ⇒ Google::Apis::BackupdrV1::WorkforceIdentityBasedOAuth2ClientId

OAuth Client ID depending on the Workforce Identity i.e. either 1p or 3p, Corresponds to the JSON property workforceIdentityBasedOauth2ClientId

Returns:



494
495
496
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 494

def workforce_identity_based_oauth2_client_id
  @workforce_identity_based_oauth2_client_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 501

def update!(**args)
  @ba_proxy_uri = args[:ba_proxy_uri] if args.key?(:ba_proxy_uri)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @etag = args[:etag] if args.key?(:etag)
  @labels = args[:labels] if args.key?(:labels)
  @management_uri = args[:management_uri] if args.key?(:management_uri)
  @name = args[:name] if args.key?(:name)
  @networks = args[:networks] if args.key?(:networks)
  @oauth2_client_id = args[:oauth2_client_id] if args.key?(:oauth2_client_id)
  @state = args[:state] if args.key?(:state)
  @type = args[:type] if args.key?(:type)
  @update_time = args[:update_time] if args.key?(:update_time)
  @workforce_identity_based_management_uri = args[:workforce_identity_based_management_uri] if args.key?(:workforce_identity_based_management_uri)
  @workforce_identity_based_oauth2_client_id = args[:workforce_identity_based_oauth2_client_id] if args.key?(:workforce_identity_based_oauth2_client_id)
end