Class FederationService

constructor

• new FederationService(sdk: SDKInterface): FederationService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns FederationService

$type

activate

• activate(
      request: ActivateFederationRequest,
  ): Request<ActivateFederationRequest, Operation<GetOperationRequest>>

  Activates an existing federation. By default, a newly created federation is in the active state.

  Parameters

  • request: ActivateFederationRequest

  Returns Request<ActivateFederationRequest, Operation<GetOperationRequest>>

• activate(
      request: ActivateFederationRequest,
      metadata: Metadata,
  ): Request<ActivateFederationRequest, Operation<GetOperationRequest>>

  Activates an existing federation. By default, a newly created federation is in the active state.

  Parameters

  • request: ActivateFederationRequest
  • metadata: Metadata

  Returns Request<ActivateFederationRequest, Operation<GetOperationRequest>>

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

  Activates an existing federation. By default, a newly created federation is in the active state.

  Parameters

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

  Returns Request<ActivateFederationRequest, Operation<GetOperationRequest>>

• activate(
      request: ActivateFederationRequest,
  ): Request<ActivateFederationRequest, Operation<GetOperationRequest>>

  Activates an existing federation. By default, a newly created federation is in the active state.

  Parameters

  • request: ActivateFederationRequest

  Returns Request<ActivateFederationRequest, Operation<GetOperationRequest>>

• activate(
      request: ActivateFederationRequest,
      metadata: Metadata,
  ): Request<ActivateFederationRequest, Operation<GetOperationRequest>>

  Activates an existing federation. By default, a newly created federation is in the active state.

  Parameters

  • request: ActivateFederationRequest
  • metadata: Metadata

  Returns Request<ActivateFederationRequest, Operation<GetOperationRequest>>

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

  Activates an existing federation. By default, a newly created federation is in the active state.

  Parameters

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

  Returns Request<ActivateFederationRequest, Operation<GetOperationRequest>>

create

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

  Creates a federation.

  Parameters

  • request: CreateFederationRequest

  Returns Request<CreateFederationRequest, Operation<GetOperationRequest>>

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

  Creates a federation.

  Parameters

  • request: CreateFederationRequest
  • metadata: Metadata

  Returns Request<CreateFederationRequest, Operation<GetOperationRequest>>

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

  Creates a federation.

  Parameters

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

  Returns Request<CreateFederationRequest, Operation<GetOperationRequest>>

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

  Creates a federation.

  Parameters

  • request: CreateFederationRequest

  Returns Request<CreateFederationRequest, Operation<GetOperationRequest>>

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

  Creates a federation.

  Parameters

  • request: CreateFederationRequest
  • metadata: Metadata

  Returns Request<CreateFederationRequest, Operation<GetOperationRequest>>

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

  Creates a federation.

  Parameters

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

  Returns Request<CreateFederationRequest, Operation<GetOperationRequest>>

deactivate

• deactivate(
      request: DeactivateFederationRequest,
  ): Request<DeactivateFederationRequest, Operation<GetOperationRequest>>

  Deactivates an existing federation. When a federation is inactive, all users under it cannot authenticate.

  Parameters

  • request: DeactivateFederationRequest

  Returns Request<DeactivateFederationRequest, Operation<GetOperationRequest>>

• deactivate(
      request: DeactivateFederationRequest,
      metadata: Metadata,
  ): Request<DeactivateFederationRequest, Operation<GetOperationRequest>>

  Deactivates an existing federation. When a federation is inactive, all users under it cannot authenticate.

  Parameters

  • request: DeactivateFederationRequest
  • metadata: Metadata

  Returns Request<DeactivateFederationRequest, Operation<GetOperationRequest>>

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

  Deactivates an existing federation. When a federation is inactive, all users under it cannot authenticate.

  Parameters

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

  Returns Request<DeactivateFederationRequest, Operation<GetOperationRequest>>

• deactivate(
      request: DeactivateFederationRequest,
  ): Request<DeactivateFederationRequest, Operation<GetOperationRequest>>

  Deactivates an existing federation. When a federation is inactive, all users under it cannot authenticate.

  Parameters

  • request: DeactivateFederationRequest

  Returns Request<DeactivateFederationRequest, Operation<GetOperationRequest>>

• deactivate(
      request: DeactivateFederationRequest,
      metadata: Metadata,
  ): Request<DeactivateFederationRequest, Operation<GetOperationRequest>>

  Deactivates an existing federation. When a federation is inactive, all users under it cannot authenticate.

  Parameters

  • request: DeactivateFederationRequest
  • metadata: Metadata

  Returns Request<DeactivateFederationRequest, Operation<GetOperationRequest>>

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

  Deactivates an existing federation. When a federation is inactive, all users under it cannot authenticate.

  Parameters

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

  Returns Request<DeactivateFederationRequest, Operation<GetOperationRequest>>

delete

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

  Deletes a federation. An active federation cannot be deleted and must be deactivated first.

  Parameters

  • request: DeleteFederationRequest

  Returns Request<DeleteFederationRequest, Operation<GetOperationRequest>>

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

  Deletes a federation. An active federation cannot be deleted and must be deactivated first.

  Parameters

  • request: DeleteFederationRequest
  • metadata: Metadata

  Returns Request<DeleteFederationRequest, Operation<GetOperationRequest>>

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

  Deletes a federation. An active federation cannot be deleted and must be deactivated first.

  Parameters

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

  Returns Request<DeleteFederationRequest, Operation<GetOperationRequest>>

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

  Deletes a federation. An active federation cannot be deleted and must be deactivated first.

  Parameters

  • request: DeleteFederationRequest

  Returns Request<DeleteFederationRequest, Operation<GetOperationRequest>>

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

  Deletes a federation. An active federation cannot be deleted and must be deactivated first.

  Parameters

  • request: DeleteFederationRequest
  • metadata: Metadata

  Returns Request<DeleteFederationRequest, Operation<GetOperationRequest>>

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

  Deletes a federation. An active federation cannot be deleted and must be deactivated first.

  Parameters

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

  Returns Request<DeleteFederationRequest, Operation<GetOperationRequest>>

get

• get(request: GetFederationRequest): Request<GetFederationRequest, Federation>

  Retrieves information about a federation by ID.

  Parameters

  • request: GetFederationRequest

  Returns Request<GetFederationRequest, Federation>

• get(
      request: GetFederationRequest,
      metadata: Metadata,
  ): Request<GetFederationRequest, Federation>

  Retrieves information about a federation by ID.

  Parameters

  • request: GetFederationRequest
  • metadata: Metadata

  Returns Request<GetFederationRequest, Federation>

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

  Retrieves information about a federation by ID.

  Parameters

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

  Returns Request<GetFederationRequest, Federation>

• get(request: GetFederationRequest): Request<GetFederationRequest, Federation>

  Retrieves information about a federation by ID.

  Parameters

  • request: GetFederationRequest

  Returns Request<GetFederationRequest, Federation>

• get(
      request: GetFederationRequest,
      metadata: Metadata,
  ): Request<GetFederationRequest, Federation>

  Retrieves information about a federation by ID.

  Parameters

  • request: GetFederationRequest
  • metadata: Metadata

  Returns Request<GetFederationRequest, Federation>

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

  Retrieves information about a federation by ID.

  Parameters

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

  Returns Request<GetFederationRequest, Federation>

getByName

• getByName(request: GetByNameRequest): Request<GetByNameRequest, Federation>

  Retrieves information about a federation by name and parent container.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Federation>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
  ): Request<GetByNameRequest, Federation>

  Retrieves information about a federation by name and parent container.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Federation>

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

  Retrieves information about a federation by name and parent container.

  Parameters

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

  Returns Request<GetByNameRequest, Federation>

• getByName(request: GetByNameRequest): Request<GetByNameRequest, Federation>

  Retrieves information about a federation by name and parent container.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Federation>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
  ): Request<GetByNameRequest, Federation>

  Retrieves information about a federation by name and parent container.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Federation>

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

  Retrieves information about a federation by name and parent container.

  Parameters

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

  Returns Request<GetByNameRequest, Federation>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListFederationsRequest,
  ): Request<ListFederationsRequest, ListFederationsResponse>

  Lists federations by parent container.

  Parameters

  • request: ListFederationsRequest

  Returns Request<ListFederationsRequest, ListFederationsResponse>

• list(
      request: ListFederationsRequest,
      metadata: Metadata,
  ): Request<ListFederationsRequest, ListFederationsResponse>

  Lists federations by parent container.

  Parameters

  • request: ListFederationsRequest
  • metadata: Metadata

  Returns Request<ListFederationsRequest, ListFederationsResponse>

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

  Lists federations by parent container.

  Parameters

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

  Returns Request<ListFederationsRequest, ListFederationsResponse>

• list(
      request: ListFederationsRequest,
  ): Request<ListFederationsRequest, ListFederationsResponse>

  Lists federations by parent container.

  Parameters

  • request: ListFederationsRequest

  Returns Request<ListFederationsRequest, ListFederationsResponse>

• list(
      request: ListFederationsRequest,
      metadata: Metadata,
  ): Request<ListFederationsRequest, ListFederationsResponse>

  Lists federations by parent container.

  Parameters

  • request: ListFederationsRequest
  • metadata: Metadata

  Returns Request<ListFederationsRequest, ListFederationsResponse>

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

  Lists federations by parent container.

  Parameters

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

  Returns Request<ListFederationsRequest, ListFederationsResponse>

update

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

  Updates a federation.

  Parameters

  • request: UpdateFederationRequest

  Returns Request<UpdateFederationRequest, Operation<GetOperationRequest>>

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

  Updates a federation.

  Parameters

  • request: UpdateFederationRequest
  • metadata: Metadata

  Returns Request<UpdateFederationRequest, Operation<GetOperationRequest>>

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

  Updates a federation.

  Parameters

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

  Returns Request<UpdateFederationRequest, Operation<GetOperationRequest>>

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

  Updates a federation.

  Parameters

  • request: UpdateFederationRequest

  Returns Request<UpdateFederationRequest, Operation<GetOperationRequest>>

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

  Updates a federation.

  Parameters

  • request: UpdateFederationRequest
  • metadata: Metadata

  Returns Request<UpdateFederationRequest, Operation<GetOperationRequest>>

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

  Updates a federation.

  Parameters

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

  Returns Request<UpdateFederationRequest, Operation<GetOperationRequest>>