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

AccessPoliciesAuthorizedOrgsDescs

class AccessPoliciesAuthorizedOrgsDescs extends Resource (View source)

The "authorizedOrgsDescs" collection of methods.

Typical usage is:

 $accesscontextmanagerService = new Google\Service\AccessContextManager(...);
 $authorizedOrgsDescs = $accesscontextmanagerService->accessPolicies_authorizedOrgsDescs;

Methods

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

Creates an authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. The name of this AuthorizedOrgsDesc will be assigned during creation.

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

Deletes an authorized orgs desc based on the resource name. The long-running operation from this RPC has a successful status after the authorized orgs desc is removed from long-lasting storage. (authorizedOrgsDescs.delete)

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

Gets an authorized orgs desc based on the resource name.

ListAuthorizedOrgsDescsResponse
listAccessPoliciesAuthorizedOrgsDescs(string $parent, array $optParams = [])

Lists all authorized orgs descs for an access policy.

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

Updates an authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. Only the organization list in AuthorizedOrgsDesc can be updated. The name, authorization_type, asset_type and authorization_direction cannot be updated. (authorizedOrgsDescs.patch)

Details

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

Creates an authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. The name of this AuthorizedOrgsDesc will be assigned during creation.

(authorizedOrgsDescs.create)

Parameters

string $parent

Required. Resource name for the access policy which owns this Authorized Orgs Desc. Format: accessPolicies/{policy_id}
AuthorizedOrgsDesc $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Deletes an authorized orgs desc based on the resource name. The long-running operation from this RPC has a successful status after the authorized orgs desc is removed from long-lasting storage. (authorizedOrgsDescs.delete)

Parameters

string $name

Required. Resource name for the Authorized Orgs Desc. Format: accessPolicies/{policy_id}/authorizedOrgsDesc/{authorized_orgs_desc_id}
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 84
AuthorizedOrgsDesc get(string $name, array $optParams = [])

Gets an authorized orgs desc based on the resource name.

(authorizedOrgsDescs.get)

Parameters

string $name

Required. Resource name for the Authorized Orgs Desc. Format: accessPolicies/{policy_id}/authorizedOrgsDescs/{authorized_orgs_descs_id}
array $optParams

Optional parameters.

Return Value

AuthorizedOrgsDesc

Exceptions

Exception

at line 105
ListAuthorizedOrgsDescsResponse listAccessPoliciesAuthorizedOrgsDescs(string $parent, array $optParams = [])

Lists all authorized orgs descs for an access policy.

(authorizedOrgsDescs.listAccessPoliciesAuthorizedOrgsDescs)

Parameters

string $parent

Required. Resource name for the access policy to list Authorized Orgs Desc from. Format: accessPolicies/{policy_id}
array $optParams

Optional parameters.

Return Value

ListAuthorizedOrgsDescsResponse

Exceptions

Exception

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

Updates an authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. Only the organization list in AuthorizedOrgsDesc can be updated. The name, authorization_type, asset_type and authorization_direction cannot be updated. (authorizedOrgsDescs.patch)

Parameters

string $name

Identifier. Resource name for the AuthorizedOrgsDesc. Format: accessPolicies/{access_policy}/authorizedOrgsDescs/{authorized_orgs_desc}. The authorized_orgs_desc component must begin with a letter, followed by alphanumeric characters or _. After you create an AuthorizedOrgsDesc, you cannot change its name.
AuthorizedOrgsDesc $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception