class ProjectsLocationsGateways extends Resource (View source)

The "gateways" collection of methods.

Typical usage is:

 $apigatewayService = new Google\Service\Apigateway(...);
 $gateways = $apigatewayService->projects_locations_gateways;

Methods

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

Creates a new Gateway in a given project and location. (gateways.create)

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

Deletes a single Gateway. (gateways.delete)

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

Gets details of a single Gateway. (gateways.get)

getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (gateways.getIamPolicy)

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

Lists Gateways in a given project and location.

patch(string $name, ApigatewayGateway $postBody, array $optParams = [])

Updates the parameters of a single Gateway. (gateways.patch)

setIamPolicy(string $resource, ApigatewaySetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (gateways.setIamPolicy)

testIamPermissions(string $resource, ApigatewayTestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

Details

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

Creates a new Gateway in a given project and location. (gateways.create)

Parameters

string $parent

Required. Parent resource of the Gateway, of the form: projects/locations

ApigatewayGateway $postBody
array $optParams

Optional parameters.

Return Value

ApigatewayOperation

Exceptions

Exception

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

Deletes a single Gateway. (gateways.delete)

Parameters

string $name

Required. Resource name of the form: projects/locations/gateways

array $optParams

Optional parameters.

Return Value

ApigatewayOperation

Exceptions

Exception

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

Gets details of a single Gateway. (gateways.get)

Parameters

string $name

Required. Resource name of the form: projects/locations/gateways

array $optParams

Optional parameters.

Return Value

ApigatewayGateway

Exceptions

Exception

ApigatewayPolicy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (gateways.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

array $optParams

Optional parameters.

Return Value

ApigatewayPolicy

Exceptions

Exception

ApigatewayListGatewaysResponse listProjectsLocationsGateways(string $parent, array $optParams = [])

Lists Gateways in a given project and location.

(gateways.listProjectsLocationsGateways)

Parameters

string $parent

Required. Parent resource of the Gateway, of the form: projects/locations

array $optParams

Optional parameters.

Return Value

ApigatewayListGatewaysResponse

Exceptions

Exception

ApigatewayOperation patch(string $name, ApigatewayGateway $postBody, array $optParams = [])

Updates the parameters of a single Gateway. (gateways.patch)

Parameters

string $name

Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}

ApigatewayGateway $postBody
array $optParams

Optional parameters.

Return Value

ApigatewayOperation

Exceptions

Exception

ApigatewayPolicy setIamPolicy(string $resource, ApigatewaySetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (gateways.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

ApigatewaySetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

ApigatewayPolicy

Exceptions

Exception

ApigatewayTestIamPermissionsResponse testIamPermissions(string $resource, ApigatewayTestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

This operation may "fail open" without warning. (gateways.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

ApigatewayTestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

ApigatewayTestIamPermissionsResponse

Exceptions

Exception