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.



2866
2867
2868
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2866

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


2778
2779
2780
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2778

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) 


2783
2784
2785
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2783

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) 


2789
2790
2791
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2789

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) 


2795
2796
2797
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2795

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


2802
2803
2804
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2802

def labels
  @labels
end

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

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

Returns:



2807
2808
2809
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2807

def management_uri
  @management_uri
end

#name ⇒ String

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

Returns:

  • (String) 


2812
2813
2814
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2812

def name
  @name
end

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

Optional. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. This field is optional if MS is created without PSA Corresponds to the JSON property networks

Returns:



2819
2820
2821
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2819

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) 


2827
2828
2829
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2827

def oauth2_client_id
  @oauth2_client_id
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


2832
2833
2834
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2832

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


2838
2839
2840
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2838

def satisfies_pzs
  @satisfies_pzs
end

#state ⇒ String

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

Returns:

  • (String) 


2844
2845
2846
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2844

def state
  @state
end

#type ⇒ String

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

Returns:

  • (String) 


2849
2850
2851
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2849

def type
  @type
end

#update_time ⇒ String

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

Returns:

  • (String) 


2854
2855
2856
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2854

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:



2859
2860
2861
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2859

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:



2864
2865
2866
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2864

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



2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 2871

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)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @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