Class AccessPermitService

constructor

• new AccessPermitService(sdk: SDKInterface): AccessPermitService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns AccessPermitService

$type

create

• create(
      request: CreateAccessPermitRequest,
  ): Request<CreateAccessPermitRequest, Operation<GetOperationRequest>>

  Creates access permit for provided resource with provided role. Subject of access permit is also a parent of access permit. If resource is unknown - NOT_FOUND will be thrown. If parent of subject is not from resource's hierarchy - NOT_FOUND will be thrown.

  Parameters

  • request: CreateAccessPermitRequest

  Returns Request<CreateAccessPermitRequest, Operation<GetOperationRequest>>

• create(
      request: CreateAccessPermitRequest,
      metadata: Metadata,
  ): Request<CreateAccessPermitRequest, Operation<GetOperationRequest>>

  Creates access permit for provided resource with provided role. Subject of access permit is also a parent of access permit. If resource is unknown - NOT_FOUND will be thrown. If parent of subject is not from resource's hierarchy - NOT_FOUND will be thrown.

  Parameters

  • request: CreateAccessPermitRequest
  • metadata: Metadata

  Returns Request<CreateAccessPermitRequest, Operation<GetOperationRequest>>

• create(
      request: CreateAccessPermitRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateAccessPermitRequest, Operation<GetOperationRequest>>

  Creates access permit for provided resource with provided role. Subject of access permit is also a parent of access permit. If resource is unknown - NOT_FOUND will be thrown. If parent of subject is not from resource's hierarchy - NOT_FOUND will be thrown.

  Parameters

  • request: CreateAccessPermitRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateAccessPermitRequest, Operation<GetOperationRequest>>

• create(
      request: CreateAccessPermitRequest,
  ): Request<CreateAccessPermitRequest, Operation<GetOperationRequest>>

  Creates access permit for provided resource with provided role. Subject of access permit is also a parent of access permit. If resource is unknown - NOT_FOUND will be thrown. If parent of subject is not from resource's hierarchy - NOT_FOUND will be thrown.

  Parameters

  • request: CreateAccessPermitRequest

  Returns Request<CreateAccessPermitRequest, Operation<GetOperationRequest>>

• create(
      request: CreateAccessPermitRequest,
      metadata: Metadata,
  ): Request<CreateAccessPermitRequest, Operation<GetOperationRequest>>

  Creates access permit for provided resource with provided role. Subject of access permit is also a parent of access permit. If resource is unknown - NOT_FOUND will be thrown. If parent of subject is not from resource's hierarchy - NOT_FOUND will be thrown.

  Parameters

  • request: CreateAccessPermitRequest
  • metadata: Metadata

  Returns Request<CreateAccessPermitRequest, Operation<GetOperationRequest>>

• create(
      request: CreateAccessPermitRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateAccessPermitRequest, Operation<GetOperationRequest>>

  Creates access permit for provided resource with provided role. Subject of access permit is also a parent of access permit. If resource is unknown - NOT_FOUND will be thrown. If parent of subject is not from resource's hierarchy - NOT_FOUND will be thrown.

  Parameters

  • request: CreateAccessPermitRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateAccessPermitRequest, Operation<GetOperationRequest>>

delete

• delete(
      request: DeleteAccessPermitRequest,
  ): Request<DeleteAccessPermitRequest, Operation<GetOperationRequest>>

  Delete access permit by id

  Parameters

  • request: DeleteAccessPermitRequest

  Returns Request<DeleteAccessPermitRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteAccessPermitRequest,
      metadata: Metadata,
  ): Request<DeleteAccessPermitRequest, Operation<GetOperationRequest>>

  Delete access permit by id

  Parameters

  • request: DeleteAccessPermitRequest
  • metadata: Metadata

  Returns Request<DeleteAccessPermitRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteAccessPermitRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteAccessPermitRequest, Operation<GetOperationRequest>>

  Delete access permit by id

  Parameters

  • request: DeleteAccessPermitRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteAccessPermitRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteAccessPermitRequest,
  ): Request<DeleteAccessPermitRequest, Operation<GetOperationRequest>>

  Delete access permit by id

  Parameters

  • request: DeleteAccessPermitRequest

  Returns Request<DeleteAccessPermitRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteAccessPermitRequest,
      metadata: Metadata,
  ): Request<DeleteAccessPermitRequest, Operation<GetOperationRequest>>

  Delete access permit by id

  Parameters

  • request: DeleteAccessPermitRequest
  • metadata: Metadata

  Returns Request<DeleteAccessPermitRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteAccessPermitRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteAccessPermitRequest, Operation<GetOperationRequest>>

  Delete access permit by id

  Parameters

  • request: DeleteAccessPermitRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteAccessPermitRequest, Operation<GetOperationRequest>>

filter

• filter(
      request: ListAccessPermitRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<AccessPermit>

  Calls the filter method.

  Parameters

  • request: ListAccessPermitRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<AccessPermit>

• filter(
      request: ListAccessPermitRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<AccessPermit>

  Yields list items across pages, without changing the supplied request.

  Parameters

  • request: ListAccessPermitRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<AccessPermit>

get

• get(
      request: GetAccessPermitRequest,
  ): Request<GetAccessPermitRequest, AccessPermit>

  Gets access permit by id

  Parameters

  • request: GetAccessPermitRequest

  Returns Request<GetAccessPermitRequest, AccessPermit>

• get(
      request: GetAccessPermitRequest,
      metadata: Metadata,
  ): Request<GetAccessPermitRequest, AccessPermit>

  Gets access permit by id

  Parameters

  • request: GetAccessPermitRequest
  • metadata: Metadata

  Returns Request<GetAccessPermitRequest, AccessPermit>

• get(
      request: GetAccessPermitRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetAccessPermitRequest, AccessPermit>

  Gets access permit by id

  Parameters

  • request: GetAccessPermitRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetAccessPermitRequest, AccessPermit>

• get(
      request: GetAccessPermitRequest,
  ): Request<GetAccessPermitRequest, AccessPermit>

  Gets access permit by id

  Parameters

  • request: GetAccessPermitRequest

  Returns Request<GetAccessPermitRequest, AccessPermit>

• get(
      request: GetAccessPermitRequest,
      metadata: Metadata,
  ): Request<GetAccessPermitRequest, AccessPermit>

  Gets access permit by id

  Parameters

  • request: GetAccessPermitRequest
  • metadata: Metadata

  Returns Request<GetAccessPermitRequest, AccessPermit>

• get(
      request: GetAccessPermitRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetAccessPermitRequest, AccessPermit>

  Gets access permit by id

  Parameters

  • request: GetAccessPermitRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetAccessPermitRequest, AccessPermit>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListAccessPermitRequest,
  ): Request<ListAccessPermitRequest, ListAccessPermitResponse>

  Lists access permits for provided parent

  Parameters

  • request: ListAccessPermitRequest

  Returns Request<ListAccessPermitRequest, ListAccessPermitResponse>

• list(
      request: ListAccessPermitRequest,
      metadata: Metadata,
  ): Request<ListAccessPermitRequest, ListAccessPermitResponse>

  Lists access permits for provided parent

  Parameters

  • request: ListAccessPermitRequest
  • metadata: Metadata

  Returns Request<ListAccessPermitRequest, ListAccessPermitResponse>

• list(
      request: ListAccessPermitRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListAccessPermitRequest, ListAccessPermitResponse>

  Lists access permits for provided parent

  Parameters

  • request: ListAccessPermitRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListAccessPermitRequest, ListAccessPermitResponse>

• list(
      request: ListAccessPermitRequest,
  ): Request<ListAccessPermitRequest, ListAccessPermitResponse>

  Lists access permits for provided parent

  Parameters

  • request: ListAccessPermitRequest

  Returns Request<ListAccessPermitRequest, ListAccessPermitResponse>

• list(
      request: ListAccessPermitRequest,
      metadata: Metadata,
  ): Request<ListAccessPermitRequest, ListAccessPermitResponse>

  Lists access permits for provided parent

  Parameters

  • request: ListAccessPermitRequest
  • metadata: Metadata

  Returns Request<ListAccessPermitRequest, ListAccessPermitResponse>

• list(
      request: ListAccessPermitRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListAccessPermitRequest, ListAccessPermitResponse>

  Lists access permits for provided parent

  Parameters

  • request: ListAccessPermitRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListAccessPermitRequest, ListAccessPermitResponse>

listOperations

• listOperations(
      request: ListOperationsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): Request<ListOperationsRequest>

  Lists operations for this service address.

  Parameters

  • request: ListOperationsRequest
  • metadata: Metadata = ...
  • options: Partial<CallOptions> & RetryOptions = {}

  Returns Request<ListOperationsRequest>