class OrganizationsInstancesNatAddresses extends Resource (View source)

The "natAddresses" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $natAddresses = $apigeeService->organizations_instances_natAddresses;

Methods

activate(string $name, GoogleCloudApigeeV1ActivateNatAddressRequest $postBody, array $optParams = [])

Activates the NAT address. The Apigee instance can now use this for Internet egress traffic. Note: Not supported for Apigee hybrid.

create(string $parent, GoogleCloudApigeeV1NatAddress $postBody, array $optParams = [])

Creates a NAT address. The address is created in the RESERVED state and a static external IP address will be provisioned. At this time, the instance will not use this IP address for Internet egress traffic. The address can be activated for use once any required firewall IP whitelisting has been completed. Note: Not supported for Apigee hybrid. (natAddresses.create)

delete(string $name, array $optParams = [])

Deletes the NAT address. Connections that are actively using the address are drained before it is removed. Note: Not supported for Apigee hybrid.

get(string $name, array $optParams = [])

Gets the details of a NAT address. Note: Not supported for Apigee hybrid.

listOrganizationsInstancesNatAddresses(string $parent, array $optParams = [])

Lists the NAT addresses for an Apigee instance. Note: Not supported for Apigee hybrid. (natAddresses.listOrganizationsInstancesNatAddresses)

Details

GoogleLongrunningOperation activate(string $name, GoogleCloudApigeeV1ActivateNatAddressRequest $postBody, array $optParams = [])

Activates the NAT address. The Apigee instance can now use this for Internet egress traffic. Note: Not supported for Apigee hybrid.

(natAddresses.activate)

Parameters

string $name

Required. Name of the nat address. Use the following structure in your request: `organizations/{org}/instances/{instances}/natAddresses/{nataddress}``

GoogleCloudApigeeV1ActivateNatAddressRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleLongrunningOperation create(string $parent, GoogleCloudApigeeV1NatAddress $postBody, array $optParams = [])

Creates a NAT address. The address is created in the RESERVED state and a static external IP address will be provisioned. At this time, the instance will not use this IP address for Internet egress traffic. The address can be activated for use once any required firewall IP whitelisting has been completed. Note: Not supported for Apigee hybrid. (natAddresses.create)

Parameters

string $parent

Required. Name of the instance. Use the following structure in your request: organizations/{org}/instances/{instance}

GoogleCloudApigeeV1NatAddress $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes the NAT address. Connections that are actively using the address are drained before it is removed. Note: Not supported for Apigee hybrid.

(natAddresses.delete)

Parameters

string $name

Required. Name of the nat address. Use the following structure in your request: `organizations/{org}/instances/{instances}/natAddresses/{nataddress}``

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

GoogleCloudApigeeV1NatAddress get(string $name, array $optParams = [])

Gets the details of a NAT address. Note: Not supported for Apigee hybrid.

(natAddresses.get)

Parameters

string $name

Required. Name of the nat address. Use the following structure in your request: organizations/{org}/instances/{instances}/natAddresses/{nataddress}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1NatAddress

Exceptions

Exception

GoogleCloudApigeeV1ListNatAddressesResponse listOrganizationsInstancesNatAddresses(string $parent, array $optParams = [])

Lists the NAT addresses for an Apigee instance. Note: Not supported for Apigee hybrid. (natAddresses.listOrganizationsInstancesNatAddresses)

Parameters

string $parent

Required. Name of the instance. Use the following structure in your request: organizations/{org}/instances/{instance}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ListNatAddressesResponse

Exceptions

Exception