class ProjectsLocationsSpokes extends Resource (View source)

The "spokes" collection of methods.

Typical usage is:

 $networkconnectivityService = new Google\Service\Networkconnectivity(...);
 $spokes = $networkconnectivityService->projects_locations_spokes;

Methods

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

Creates a Network Connectivity Center spoke. (spokes.create)

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

Deletes a Network Connectivity Center spoke. (spokes.delete)

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

Gets details about a Network Connectivity Center spoke. (spokes.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. (spokes.getIamPolicy)

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

Lists the Network Connectivity Center spokes in a specified project and location. (spokes.listProjectsLocationsSpokes)

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

Updates the parameters of a Network Connectivity Center spoke. (spokes.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. (spokes.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

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

Creates a Network Connectivity Center spoke. (spokes.create)

Parameters

string $parent

Required. The parent resource.

Spoke $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Deletes a Network Connectivity Center spoke. (spokes.delete)

Parameters

string $name

Required. The name of the spoke to delete.

array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

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

Gets details about a Network Connectivity Center spoke. (spokes.get)

Parameters

string $name

Required. The name of the spoke resource.

array $optParams

Optional parameters.

Return Value

Spoke

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. (spokes.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

ListSpokesResponse listProjectsLocationsSpokes(string $parent, array $optParams = [])

Lists the Network Connectivity Center spokes in a specified project and location. (spokes.listProjectsLocationsSpokes)

Parameters

string $parent

Required. The parent resource.

array $optParams

Optional parameters.

Return Value

ListSpokesResponse

Exceptions

Exception

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

Updates the parameters of a Network Connectivity Center spoke. (spokes.patch)

Parameters

string $name

Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id}

Spoke $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

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. (spokes.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. (spokes.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