1. class
  2. Google
  3. \
  4. Service
  5. \
  6. GKEHub
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsScopes

ProjectsLocationsScopes

class ProjectsLocationsScopes extends Resource (View source)

The "scopes" collection of methods.

Typical usage is:

 $gkehubService = new Google\Service\GKEHub(...);
 $scopes = $gkehubService->projects_locations_scopes;

Methods

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

Creates a Scope. (scopes.create)

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

Deletes a Scope. (scopes.delete)

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

Returns the details of a Scope. (scopes.get)

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. (scopes.getIamPolicy)

ListScopesResponse
listProjectsLocationsScopes(string $parent, array $optParams = [])

Lists Scopes. (scopes.listProjectsLocationsScopes)

ListBoundMembershipsResponse
listMemberships(string $scopeName, array $optParams = [])

Lists Memberships bound to a Scope. The response includes relevant Memberships from all regions. (scopes.listMemberships)

ListPermittedScopesResponse
listPermitted(string $parent, array $optParams = [])

Lists permitted Scopes. (scopes.listPermitted)

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

Updates a scopes. (scopes.patch)

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. (scopes.setIamPolicy)

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.

Details

at line 53
Operation create(string $parent, Scope $postBody, array $optParams = [])

Creates a Scope. (scopes.create)

Parameters

string $parent

Required. The parent (project and location) where the Scope will be created. Specified in the format projects/locations.
Scope $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes a Scope. (scopes.delete)

Parameters

string $name

Required. The Scope resource name in the format projects/locations/scopes.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 83
Scope get(string $name, array $optParams = [])

Returns the details of a Scope. (scopes.get)

Parameters

string $name

Required. The Scope resource name in the format projects/locations/scopes.
array $optParams

Optional parameters.

Return Value

Scope

Exceptions

Exception

at line 114
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. (scopes.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

at line 136
ListScopesResponse listProjectsLocationsScopes(string $parent, array $optParams = [])

Lists Scopes. (scopes.listProjectsLocationsScopes)

Parameters

string $parent

Required. The parent (project and location) where the Scope will be listed. Specified in the format projects/locations.
array $optParams

Optional parameters.

Return Value

ListScopesResponse

Exceptions

Exception

at line 164
ListBoundMembershipsResponse listMemberships(string $scopeName, array $optParams = [])

Lists Memberships bound to a Scope. The response includes relevant Memberships from all regions. (scopes.listMemberships)

Parameters

string $scopeName

Required. Name of the Scope, in the format projects/locations/global/scopes, to which the Memberships are bound.
array $optParams

Optional parameters.

Return Value

ListBoundMembershipsResponse

Exceptions

Exception

at line 186
ListPermittedScopesResponse listPermitted(string $parent, array $optParams = [])

Lists permitted Scopes. (scopes.listPermitted)

Parameters

string $parent

Required. The parent (project and location) where the Scope will be listed. Specified in the format projects/locations.
array $optParams

Optional parameters.

Return Value

ListPermittedScopesResponse

Exceptions

Exception

at line 204
Operation patch(string $name, Scope $postBody, array $optParams = [])

Updates a scopes. (scopes.patch)

Parameters

string $name

The resource name for the scope projects/{project}/locations/{location}/scopes/{scope}
Scope $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 224
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. (scopes.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

at line 246
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. (scopes.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