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.



2421
2422
2423
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2421

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

Instance Attribute Details

#access_typeString

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)


2353
2354
2355
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2353

def access_type
  @access_type
end

#addressString

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)


2361
2362
2363
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2361

def address
  @address
end

#create_timeString

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

Returns:

  • (String)


2366
2367
2368
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2366

def create_time
  @create_time
end

#descriptionString

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

Returns:

  • (String)


2371
2372
2373
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2371

def description
  @description
end

#ip_addressString

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)


2377
2378
2379
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2377

def ip_address
  @ip_address
end

#labelsHash<String,String>

User-defined labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>)


2382
2383
2384
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2382

def labels
  @labels
end

#nameString

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

Returns:

  • (String)


2388
2389
2390
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2388

def name
  @name
end

#networkString

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

Returns:

  • (String)


2394
2395
2396
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2394

def network
  @network
end

#psc_forwarding_ruleString

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)


2401
2402
2403
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2401

def psc_forwarding_rule
  @psc_forwarding_rule
end

#subnetworkString

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)


2407
2408
2409
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2407

def subnetwork
  @subnetwork
end

#target_google_apiString

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)


2414
2415
2416
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2414

def target_google_api
  @target_google_api
end

#update_timeString

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

Returns:

  • (String)


2419
2420
2421
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2419

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2426

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