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.



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

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)


2285
2286
2287
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2285

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)


2293
2294
2295
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2293

def address
  @address
end

#create_timeString

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

Returns:

  • (String)


2298
2299
2300
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2298

def create_time
  @create_time
end

#descriptionString

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

Returns:

  • (String)


2303
2304
2305
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2303

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)


2309
2310
2311
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2309

def ip_address
  @ip_address
end

#labelsHash<String,String>

User-defined labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>)


2314
2315
2316
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2314

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)


2320
2321
2322
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2320

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)


2326
2327
2328
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2326

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)


2333
2334
2335
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2333

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)


2339
2340
2341
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2339

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)


2346
2347
2348
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2346

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)


2351
2352
2353
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2351

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
# File 'lib/google/apis/networkconnectivity_v1/classes.rb', line 2358

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