Class GroupService

constructor

• new GroupService(sdk: SDKInterface): GroupService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns GroupService

$type

create

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

  Calls the Create RPC.

  Parameters

  • request: CreateGroupRequest

  Returns Request<CreateGroupRequest, Operation<GetOperationRequest>>

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

  Calls the Create RPC.

  Parameters

  • request: CreateGroupRequest
  • metadata: Metadata

  Returns Request<CreateGroupRequest, Operation<GetOperationRequest>>

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

  Calls the Create RPC.

  Parameters

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

  Returns Request<CreateGroupRequest, Operation<GetOperationRequest>>

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

  Calls the Create RPC.

  Parameters

  • request: CreateGroupRequest

  Returns Request<CreateGroupRequest, Operation<GetOperationRequest>>

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

  Calls the Create RPC.

  Parameters

  • request: CreateGroupRequest
  • metadata: Metadata

  Returns Request<CreateGroupRequest, Operation<GetOperationRequest>>

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

  Calls the Create RPC.

  Parameters

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

  Returns Request<CreateGroupRequest, Operation<GetOperationRequest>>

delete

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

  Calls the Delete RPC.

  Parameters

  • request: DeleteGroupRequest

  Returns Request<DeleteGroupRequest, Operation<GetOperationRequest>>

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

  Calls the Delete RPC.

  Parameters

  • request: DeleteGroupRequest
  • metadata: Metadata

  Returns Request<DeleteGroupRequest, Operation<GetOperationRequest>>

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

  Calls the Delete RPC.

  Parameters

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

  Returns Request<DeleteGroupRequest, Operation<GetOperationRequest>>

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

  Calls the Delete RPC.

  Parameters

  • request: DeleteGroupRequest

  Returns Request<DeleteGroupRequest, Operation<GetOperationRequest>>

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

  Calls the Delete RPC.

  Parameters

  • request: DeleteGroupRequest
  • metadata: Metadata

  Returns Request<DeleteGroupRequest, Operation<GetOperationRequest>>

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

  Calls the Delete RPC.

  Parameters

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

  Returns Request<DeleteGroupRequest, Operation<GetOperationRequest>>

filter

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

  Calls the filter method.

  Parameters

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

  Returns AsyncGenerator<Group>

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

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

  Parameters

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

  Returns AsyncGenerator<Group>

get

• get(request: GetGroupRequest): Request<GetGroupRequest, Group>

  Calls the Get RPC.

  Parameters

  • request: GetGroupRequest

  Returns Request<GetGroupRequest, Group>

• get(
      request: GetGroupRequest,
      metadata: Metadata,
  ): Request<GetGroupRequest, Group>

  Calls the Get RPC.

  Parameters

  • request: GetGroupRequest
  • metadata: Metadata

  Returns Request<GetGroupRequest, Group>

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

  Calls the Get RPC.

  Parameters

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

  Returns Request<GetGroupRequest, Group>

• get(request: GetGroupRequest): Request<GetGroupRequest, Group>

  Calls the Get RPC.

  Parameters

  • request: GetGroupRequest

  Returns Request<GetGroupRequest, Group>

• get(
      request: GetGroupRequest,
      metadata: Metadata,
  ): Request<GetGroupRequest, Group>

  Calls the Get RPC.

  Parameters

  • request: GetGroupRequest
  • metadata: Metadata

  Returns Request<GetGroupRequest, Group>

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

  Calls the Get RPC.

  Parameters

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

  Returns Request<GetGroupRequest, Group>

getByName

• getByName(request: GetGroupByNameRequest): Request<GetGroupByNameRequest, Group>

  Calls the GetByName RPC.

  Parameters

  • request: GetGroupByNameRequest

  Returns Request<GetGroupByNameRequest, Group>

• getByName(
      request: GetGroupByNameRequest,
      metadata: Metadata,
  ): Request<GetGroupByNameRequest, Group>

  Calls the GetByName RPC.

  Parameters

  • request: GetGroupByNameRequest
  • metadata: Metadata

  Returns Request<GetGroupByNameRequest, Group>

• getByName(
      request: GetGroupByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetGroupByNameRequest, Group>

  Calls the GetByName RPC.

  Parameters

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

  Returns Request<GetGroupByNameRequest, Group>

• getByName(request: GetGroupByNameRequest): Request<GetGroupByNameRequest, Group>

  Calls the GetByName RPC.

  Parameters

  • request: GetGroupByNameRequest

  Returns Request<GetGroupByNameRequest, Group>

• getByName(
      request: GetGroupByNameRequest,
      metadata: Metadata,
  ): Request<GetGroupByNameRequest, Group>

  Calls the GetByName RPC.

  Parameters

  • request: GetGroupByNameRequest
  • metadata: Metadata

  Returns Request<GetGroupByNameRequest, Group>

• getByName(
      request: GetGroupByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetGroupByNameRequest, Group>

  Calls the GetByName RPC.

  Parameters

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

  Returns Request<GetGroupByNameRequest, Group>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(request: ListGroupsRequest): Request<ListGroupsRequest, ListGroupsResponse>

  Calls the List RPC.

  Parameters

  • request: ListGroupsRequest

  Returns Request<ListGroupsRequest, ListGroupsResponse>

• list(
      request: ListGroupsRequest,
      metadata: Metadata,
  ): Request<ListGroupsRequest, ListGroupsResponse>

  Calls the List RPC.

  Parameters

  • request: ListGroupsRequest
  • metadata: Metadata

  Returns Request<ListGroupsRequest, ListGroupsResponse>

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

  Calls the List RPC.

  Parameters

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

  Returns Request<ListGroupsRequest, ListGroupsResponse>

• list(request: ListGroupsRequest): Request<ListGroupsRequest, ListGroupsResponse>

  Calls the List RPC.

  Parameters

  • request: ListGroupsRequest

  Returns Request<ListGroupsRequest, ListGroupsResponse>

• list(
      request: ListGroupsRequest,
      metadata: Metadata,
  ): Request<ListGroupsRequest, ListGroupsResponse>

  Calls the List RPC.

  Parameters

  • request: ListGroupsRequest
  • metadata: Metadata

  Returns Request<ListGroupsRequest, ListGroupsResponse>

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

  Calls the List RPC.

  Parameters

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

  Returns Request<ListGroupsRequest, ListGroupsResponse>

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>

update

• update(
      request: UpdateGroupRequest,
  ): Request<UpdateGroupRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateGroupRequest

  Returns Request<UpdateGroupRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateGroupRequest,
      metadata: Metadata,
  ): Request<UpdateGroupRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateGroupRequest
  • metadata: Metadata

  Returns Request<UpdateGroupRequest, Operation<GetOperationRequest>>

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

  Calls the Update RPC.

  Parameters

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

  Returns Request<UpdateGroupRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateGroupRequest,
  ): Request<UpdateGroupRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateGroupRequest

  Returns Request<UpdateGroupRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateGroupRequest,
      metadata: Metadata,
  ): Request<UpdateGroupRequest, Operation<GetOperationRequest>>

  Calls the Update RPC.

  Parameters

  • request: UpdateGroupRequest
  • metadata: Metadata

  Returns Request<UpdateGroupRequest, Operation<GetOperationRequest>>

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

  Calls the Update RPC.

  Parameters

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

  Returns Request<UpdateGroupRequest, Operation<GetOperationRequest>>