Class ScopeService

constructor

• new ScopeService(sdk: SDKInterface): ScopeService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns ScopeService

$type

filter

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

  Calls the filter method.

  Parameters

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

  Returns AsyncGenerator<Scope>

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

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

  Parameters

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

  Returns AsyncGenerator<Scope>

get

• get(request: GetScopeRequest): Request<GetScopeRequest, Scope>

  Calls the Get RPC.

  Parameters

  • request: GetScopeRequest

  Returns Request<GetScopeRequest, Scope>

• get(
      request: GetScopeRequest,
      metadata: Metadata,
  ): Request<GetScopeRequest, Scope>

  Calls the Get RPC.

  Parameters

  • request: GetScopeRequest
  • metadata: Metadata

  Returns Request<GetScopeRequest, Scope>

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

  Calls the Get RPC.

  Parameters

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

  Returns Request<GetScopeRequest, Scope>

• get(request: GetScopeRequest): Request<GetScopeRequest, Scope>

  Calls the Get RPC.

  Parameters

  • request: GetScopeRequest

  Returns Request<GetScopeRequest, Scope>

• get(
      request: GetScopeRequest,
      metadata: Metadata,
  ): Request<GetScopeRequest, Scope>

  Calls the Get RPC.

  Parameters

  • request: GetScopeRequest
  • metadata: Metadata

  Returns Request<GetScopeRequest, Scope>

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

  Calls the Get RPC.

  Parameters

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

  Returns Request<GetScopeRequest, Scope>

getByName

• getByName(request: GetScopeByNameRequest): Request<GetScopeByNameRequest, Scope>

  Calls the GetByName RPC.

  Parameters

  • request: GetScopeByNameRequest

  Returns Request<GetScopeByNameRequest, Scope>

• getByName(
      request: GetScopeByNameRequest,
      metadata: Metadata,
  ): Request<GetScopeByNameRequest, Scope>

  Calls the GetByName RPC.

  Parameters

  • request: GetScopeByNameRequest
  • metadata: Metadata

  Returns Request<GetScopeByNameRequest, Scope>

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

  Calls the GetByName RPC.

  Parameters

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

  Returns Request<GetScopeByNameRequest, Scope>

• getByName(request: GetScopeByNameRequest): Request<GetScopeByNameRequest, Scope>

  Calls the GetByName RPC.

  Parameters

  • request: GetScopeByNameRequest

  Returns Request<GetScopeByNameRequest, Scope>

• getByName(
      request: GetScopeByNameRequest,
      metadata: Metadata,
  ): Request<GetScopeByNameRequest, Scope>

  Calls the GetByName RPC.

  Parameters

  • request: GetScopeByNameRequest
  • metadata: Metadata

  Returns Request<GetScopeByNameRequest, Scope>

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

  Calls the GetByName RPC.

  Parameters

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

  Returns Request<GetScopeByNameRequest, Scope>

list

• list(request: ListScopesRequest): Request<ListScopesRequest, ListScopesResponse>

  Calls the List RPC.

  Parameters

  • request: ListScopesRequest

  Returns Request<ListScopesRequest, ListScopesResponse>

• list(
      request: ListScopesRequest,
      metadata: Metadata,
  ): Request<ListScopesRequest, ListScopesResponse>

  Calls the List RPC.

  Parameters

  • request: ListScopesRequest
  • metadata: Metadata

  Returns Request<ListScopesRequest, ListScopesResponse>

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

  Calls the List RPC.

  Parameters

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

  Returns Request<ListScopesRequest, ListScopesResponse>

• list(request: ListScopesRequest): Request<ListScopesRequest, ListScopesResponse>

  Calls the List RPC.

  Parameters

  • request: ListScopesRequest

  Returns Request<ListScopesRequest, ListScopesResponse>

• list(
      request: ListScopesRequest,
      metadata: Metadata,
  ): Request<ListScopesRequest, ListScopesResponse>

  Calls the List RPC.

  Parameters

  • request: ListScopesRequest
  • metadata: Metadata

  Returns Request<ListScopesRequest, ListScopesResponse>

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

  Calls the List RPC.

  Parameters

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

  Returns Request<ListScopesRequest, ListScopesResponse>