Class PlatformService

constructor

• new PlatformService(sdk: SDKInterface): PlatformService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns PlatformService

$type

filter

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

  Calls the filter method.

  Parameters

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

  Returns AsyncGenerator<Platform>

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

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

  Parameters

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

  Returns AsyncGenerator<Platform>

getByName

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

  Retrieves detailed information about a specific compute platform by its parent and name.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Platform>

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

  Retrieves detailed information about a specific compute platform by its parent and name.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Platform>

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

  Retrieves detailed information about a specific compute platform by its parent and name.

  Parameters

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

  Returns Request<GetByNameRequest, Platform>

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

  Retrieves detailed information about a specific compute platform by its parent and name.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Platform>

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

  Retrieves detailed information about a specific compute platform by its parent and name.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Platform>

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

  Retrieves detailed information about a specific compute platform by its parent and name.

  Parameters

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

  Returns Request<GetByNameRequest, Platform>

list

• list(
      request: ListPlatformsRequest,
  ): Request<ListPlatformsRequest, ListPlatformsResponse>

  Lists all compute platforms within a specified parent.

  Parameters

  • request: ListPlatformsRequest

  Returns Request<ListPlatformsRequest, ListPlatformsResponse>

• list(
      request: ListPlatformsRequest,
      metadata: Metadata,
  ): Request<ListPlatformsRequest, ListPlatformsResponse>

  Lists all compute platforms within a specified parent.

  Parameters

  • request: ListPlatformsRequest
  • metadata: Metadata

  Returns Request<ListPlatformsRequest, ListPlatformsResponse>

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

  Lists all compute platforms within a specified parent.

  Parameters

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

  Returns Request<ListPlatformsRequest, ListPlatformsResponse>

• list(
      request: ListPlatformsRequest,
  ): Request<ListPlatformsRequest, ListPlatformsResponse>

  Lists all compute platforms within a specified parent.

  Parameters

  • request: ListPlatformsRequest

  Returns Request<ListPlatformsRequest, ListPlatformsResponse>

• list(
      request: ListPlatformsRequest,
      metadata: Metadata,
  ): Request<ListPlatformsRequest, ListPlatformsResponse>

  Lists all compute platforms within a specified parent.

  Parameters

  • request: ListPlatformsRequest
  • metadata: Metadata

  Returns Request<ListPlatformsRequest, ListPlatformsResponse>

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

  Lists all compute platforms within a specified parent.

  Parameters

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

  Returns Request<ListPlatformsRequest, ListPlatformsResponse>