Class: Google::Apis::NetworkconnectivityV1::RegionalEndpoint

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

Overview

The RegionalEndpoint resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RegionalEndpoint

Returns a new instance of RegionalEndpoint.



2537
2538
2539
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2537

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

Instance Attribute Details

#access_type ⇒ String

Required. The access type of this regional endpoint. This field is reflected in the PSC Forwarding Rule configuration to enable global access. Corresponds to the JSON property accessType

Returns:

  • (String) 


2469
2470
2471
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2469

def access_type
  @access_type
end

#address ⇒ String

Optional. The IP Address of the Regional Endpoint. When no address is provided, an IP from the subnetwork is allocated. Use one of the following formats: * IPv4 address as in 10.0.0.1 * Address resource URI as in projects/project/ regions/region/addresses/address_name` Corresponds to the JSON propertyaddress`

Returns:

  • (String) 


2477
2478
2479
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2477

def address
  @address
end

#create_time ⇒ String

Output only. Time when the RegionalEndpoint was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


2482
2483
2484
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2482

def create_time
  @create_time
end

#description ⇒ String

Optional. A description of this resource. Corresponds to the JSON property description

Returns:

  • (String) 


2487
2488
2489
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2487

def description
  @description
end

#ip_address ⇒ String

Output only. The literal IP address of the PSC Forwarding Rule created on behalf of the customer. This field is deprecated. Use address instead. Corresponds to the JSON property ipAddress

Returns:

  • (String) 


2493
2494
2495
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2493

def ip_address
  @ip_address
end

#labels ⇒ Hash<String,String>

User-defined labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2498
2499
2500
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2498

def labels
  @labels
end

#name ⇒ String

Output only. The name of a RegionalEndpoint. Format: projects/project/ locations/location/regionalEndpoints/regional_endpoint`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


2504
2505
2506
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2504

def name
  @name
end

#network ⇒ String

The name of the VPC network for this private regional endpoint. Format: projects/project/global/networks/network` Corresponds to the JSON propertynetwork`

Returns:

  • (String) 


2510
2511
2512
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2510

def network
  @network
end

#psc_forwarding_rule ⇒ String

Output only. The resource reference of the PSC Forwarding Rule created on behalf of the customer. Format: //compute.googleapis.com/projects/project/ regions/region/forwardingRules/forwarding_rule_name` Corresponds to the JSON propertypscForwardingRule`

Returns:

  • (String) 


2517
2518
2519
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2517

def psc_forwarding_rule
  @psc_forwarding_rule
end

#subnetwork ⇒ String

The name of the subnetwork from which the IP address will be allocated. Format: projects/project/regions/region/subnetworks/subnetwork` Corresponds to the JSON propertysubnetwork`

Returns:

  • (String) 


2523
2524
2525
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2523

def subnetwork
  @subnetwork
end

#target_google_api ⇒ String

Required. The service endpoint this private regional endpoint connects to. Format: `apiname.region.p.rep.googleapis.comExample: "cloudkms.us- central1.p.rep.googleapis.com". Corresponds to the JSON propertytargetGoogleApi`

Returns:

  • (String) 


2530
2531
2532
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2530

def target_google_api
  @target_google_api
end

#update_time ⇒ String

Output only. Time when the RegionalEndpoint was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


2535
2536
2537
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2535

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
 
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2542

def update!(**args)
  @access_type = args[:access_type] if args.key?(:access_type)
  @address = args[:address] if args.key?(:address)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @ip_address = args[:ip_address] if args.key?(:ip_address)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @psc_forwarding_rule = args[:psc_forwarding_rule] if args.key?(:psc_forwarding_rule)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @target_google_api = args[:target_google_api] if args.key?(:target_google_api)
  @update_time = args[:update_time] if args.key?(:update_time)
end