class ProjectsLocationsEndpoints extends Resource (View source)

The "endpoints" collection of methods.

Typical usage is:

 $idsService = new Google\Service\IDS(...);
 $endpoints = $idsService->projects_locations_endpoints;

Methods

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

Creates a new Endpoint in a given project and location. (endpoints.create)

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

Deletes a single Endpoint. (endpoints.delete)

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

Gets details of a single Endpoint. (endpoints.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. (endpoints.getIamPolicy)

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

Lists Endpoints in a given project and location.

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

Updates the parameters of a single Endpoint. (endpoints.patch)

setIamPolicy(string $resource, SetIamPolicyRequest $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. (endpoints.setIamPolicy)

testIamPermissions(string $resource, TestIamPermissionsRequest $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

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

Creates a new Endpoint in a given project and location. (endpoints.create)

Parameters

string $parent

Required. The endpoint's parent.

Endpoint $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes a single Endpoint. (endpoints.delete)

Parameters

string $name

Required. The name of the endpoint to delete.

array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Gets details of a single Endpoint. (endpoints.get)

Parameters

string $name

Required. The name of the endpoint to retrieve. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

array $optParams

Optional parameters.

Return Value

Endpoint

Exceptions

Exception

Policy 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. (endpoints.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

Policy

Exceptions

Exception

ListEndpointsResponse listProjectsLocationsEndpoints(string $parent, array $optParams = [])

Lists Endpoints in a given project and location.

(endpoints.listProjectsLocationsEndpoints)

Parameters

string $parent

Required. The parent, which owns this collection of endpoints.

array $optParams

Optional parameters.

Return Value

ListEndpointsResponse

Exceptions

Exception

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

Updates the parameters of a single Endpoint. (endpoints.patch)

Parameters

string $name

Output only. The name of the endpoint.

Endpoint $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Policy setIamPolicy(string $resource, SetIamPolicyRequest $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. (endpoints.setIamPolicy)

Parameters

string $resource

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

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $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. (endpoints.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.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception