Class ProjectService

constructor

• new ProjectService(sdk: SDKInterface): ProjectService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns ProjectService

$type

create

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

  Creates a new project.

  Parameters

  • request: CreateProjectRequest

  Returns Request<CreateProjectRequest, Operation<GetOperationRequest>>

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

  Creates a new project.

  Parameters

  • request: CreateProjectRequest
  • metadata: Metadata

  Returns Request<CreateProjectRequest, Operation<GetOperationRequest>>

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

  Creates a new project.

  Parameters

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

  Returns Request<CreateProjectRequest, Operation<GetOperationRequest>>

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

  Creates a new project.

  Parameters

  • request: CreateProjectRequest

  Returns Request<CreateProjectRequest, Operation<GetOperationRequest>>

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

  Creates a new project.

  Parameters

  • request: CreateProjectRequest
  • metadata: Metadata

  Returns Request<CreateProjectRequest, Operation<GetOperationRequest>>

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

  Creates a new project.

  Parameters

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

  Returns Request<CreateProjectRequest, Operation<GetOperationRequest>>

delete

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

  Deletes a project by its ID.

  Parameters

  • request: DeleteProjectRequest

  Returns Request<DeleteProjectRequest, Operation<GetOperationRequest>>

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

  Deletes a project by its ID.

  Parameters

  • request: DeleteProjectRequest
  • metadata: Metadata

  Returns Request<DeleteProjectRequest, Operation<GetOperationRequest>>

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

  Deletes a project by its ID.

  Parameters

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

  Returns Request<DeleteProjectRequest, Operation<GetOperationRequest>>

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

  Deletes a project by its ID.

  Parameters

  • request: DeleteProjectRequest

  Returns Request<DeleteProjectRequest, Operation<GetOperationRequest>>

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

  Deletes a project by its ID.

  Parameters

  • request: DeleteProjectRequest
  • metadata: Metadata

  Returns Request<DeleteProjectRequest, Operation<GetOperationRequest>>

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

  Deletes a project by its ID.

  Parameters

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

  Returns Request<DeleteProjectRequest, Operation<GetOperationRequest>>

get

• get(request: GetProjectRequest): Request<GetProjectRequest, Project>

  Retrieves a project by its ID.

  Parameters

  • request: GetProjectRequest

  Returns Request<GetProjectRequest, Project>

• get(
      request: GetProjectRequest,
      metadata: Metadata,
  ): Request<GetProjectRequest, Project>

  Retrieves a project by its ID.

  Parameters

  • request: GetProjectRequest
  • metadata: Metadata

  Returns Request<GetProjectRequest, Project>

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

  Retrieves a project by its ID.

  Parameters

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

  Returns Request<GetProjectRequest, Project>

• get(request: GetProjectRequest): Request<GetProjectRequest, Project>

  Retrieves a project by its ID.

  Parameters

  • request: GetProjectRequest

  Returns Request<GetProjectRequest, Project>

• get(
      request: GetProjectRequest,
      metadata: Metadata,
  ): Request<GetProjectRequest, Project>

  Retrieves a project by its ID.

  Parameters

  • request: GetProjectRequest
  • metadata: Metadata

  Returns Request<GetProjectRequest, Project>

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

  Retrieves a project by its ID.

  Parameters

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

  Returns Request<GetProjectRequest, Project>

getByName

• getByName(
      request: GetProjectByNameRequest,
  ): Request<GetProjectByNameRequest, Project>

  Retrieves a project by its name within a specified parent.

  Parameters

  • request: GetProjectByNameRequest

  Returns Request<GetProjectByNameRequest, Project>

• getByName(
      request: GetProjectByNameRequest,
      metadata: Metadata,
  ): Request<GetProjectByNameRequest, Project>

  Retrieves a project by its name within a specified parent.

  Parameters

  • request: GetProjectByNameRequest
  • metadata: Metadata

  Returns Request<GetProjectByNameRequest, Project>

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

  Retrieves a project by its name within a specified parent.

  Parameters

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

  Returns Request<GetProjectByNameRequest, Project>

• getByName(
      request: GetProjectByNameRequest,
  ): Request<GetProjectByNameRequest, Project>

  Retrieves a project by its name within a specified parent.

  Parameters

  • request: GetProjectByNameRequest

  Returns Request<GetProjectByNameRequest, Project>

• getByName(
      request: GetProjectByNameRequest,
      metadata: Metadata,
  ): Request<GetProjectByNameRequest, Project>

  Retrieves a project by its name within a specified parent.

  Parameters

  • request: GetProjectByNameRequest
  • metadata: Metadata

  Returns Request<GetProjectByNameRequest, Project>

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

  Retrieves a project by its name within a specified parent.

  Parameters

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

  Returns Request<GetProjectByNameRequest, Project>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListProjectsRequest,
  ): Request<ListProjectsRequest, ListProjectsResponse>

  Lists projects under a specified parent.

  Parameters

  • request: ListProjectsRequest

  Returns Request<ListProjectsRequest, ListProjectsResponse>

• list(
      request: ListProjectsRequest,
      metadata: Metadata,
  ): Request<ListProjectsRequest, ListProjectsResponse>

  Lists projects under a specified parent.

  Parameters

  • request: ListProjectsRequest
  • metadata: Metadata

  Returns Request<ListProjectsRequest, ListProjectsResponse>

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

  Lists projects under a specified parent.

  Parameters

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

  Returns Request<ListProjectsRequest, ListProjectsResponse>

• list(
      request: ListProjectsRequest,
  ): Request<ListProjectsRequest, ListProjectsResponse>

  Lists projects under a specified parent.

  Parameters

  • request: ListProjectsRequest

  Returns Request<ListProjectsRequest, ListProjectsResponse>

• list(
      request: ListProjectsRequest,
      metadata: Metadata,
  ): Request<ListProjectsRequest, ListProjectsResponse>

  Lists projects under a specified parent.

  Parameters

  • request: ListProjectsRequest
  • metadata: Metadata

  Returns Request<ListProjectsRequest, ListProjectsResponse>

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

  Lists projects under a specified parent.

  Parameters

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

  Returns Request<ListProjectsRequest, ListProjectsResponse>

update

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

  Updates an existing project.

  Parameters

  • request: UpdateProjectRequest

  Returns Request<UpdateProjectRequest, Operation<GetOperationRequest>>

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

  Updates an existing project.

  Parameters

  • request: UpdateProjectRequest
  • metadata: Metadata

  Returns Request<UpdateProjectRequest, Operation<GetOperationRequest>>

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

  Updates an existing project.

  Parameters

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

  Returns Request<UpdateProjectRequest, Operation<GetOperationRequest>>

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

  Updates an existing project.

  Parameters

  • request: UpdateProjectRequest

  Returns Request<UpdateProjectRequest, Operation<GetOperationRequest>>

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

  Updates an existing project.

  Parameters

  • request: UpdateProjectRequest
  • metadata: Metadata

  Returns Request<UpdateProjectRequest, Operation<GetOperationRequest>>

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

  Updates an existing project.

  Parameters

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

  Returns Request<UpdateProjectRequest, Operation<GetOperationRequest>>