Grafeas v1 API - Class Grafeas.GrafeasBase (3.2.0)

[BindServiceMethod(typeof(Grafeas), "BindService")]
public abstract class Grafeas.GrafeasBase

Reference documentation and code samples for the Grafeas v1 API class Grafeas.GrafeasBase.

Base class for server-side implementations of Grafeas

Inheritance

object > Grafeas.GrafeasBase

Namespace

GrafeasV1

Assembly

Grafeas.V1.dll

Methods

BatchCreateNotes(BatchCreateNotesRequest, ServerCallContext)

public virtual Task<BatchCreateNotesResponse> BatchCreateNotes(BatchCreateNotesRequest request, ServerCallContext context)

Creates new notes in batch.

Parameters
NameDescription
requestBatchCreateNotesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskBatchCreateNotesResponse

The response to send back to the client (wrapped by a task).

BatchCreateOccurrences(BatchCreateOccurrencesRequest, ServerCallContext)

public virtual Task<BatchCreateOccurrencesResponse> BatchCreateOccurrences(BatchCreateOccurrencesRequest request, ServerCallContext context)

Creates new occurrences in batch.

Parameters
NameDescription
requestBatchCreateOccurrencesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskBatchCreateOccurrencesResponse

The response to send back to the client (wrapped by a task).

CreateNote(CreateNoteRequest, ServerCallContext)

public virtual Task<Note> CreateNote(CreateNoteRequest request, ServerCallContext context)

Creates a new note.

Parameters
NameDescription
requestCreateNoteRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskNote

The response to send back to the client (wrapped by a task).

CreateOccurrence(CreateOccurrenceRequest, ServerCallContext)

public virtual Task<Occurrence> CreateOccurrence(CreateOccurrenceRequest request, ServerCallContext context)

Creates a new occurrence.

Parameters
NameDescription
requestCreateOccurrenceRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOccurrence

The response to send back to the client (wrapped by a task).

DeleteNote(DeleteNoteRequest, ServerCallContext)

public virtual Task<Empty> DeleteNote(DeleteNoteRequest request, ServerCallContext context)

Deletes the specified note.

Parameters
NameDescription
requestDeleteNoteRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskEmpty

The response to send back to the client (wrapped by a task).

DeleteOccurrence(DeleteOccurrenceRequest, ServerCallContext)

public virtual Task<Empty> DeleteOccurrence(DeleteOccurrenceRequest request, ServerCallContext context)

Deletes the specified occurrence. For example, use this method to delete an occurrence when the occurrence is no longer applicable for the given resource.

Parameters
NameDescription
requestDeleteOccurrenceRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskEmpty

The response to send back to the client (wrapped by a task).

GetNote(GetNoteRequest, ServerCallContext)

public virtual Task<Note> GetNote(GetNoteRequest request, ServerCallContext context)

Gets the specified note.

Parameters
NameDescription
requestGetNoteRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskNote

The response to send back to the client (wrapped by a task).

GetOccurrence(GetOccurrenceRequest, ServerCallContext)

public virtual Task<Occurrence> GetOccurrence(GetOccurrenceRequest request, ServerCallContext context)

Gets the specified occurrence.

Parameters
NameDescription
requestGetOccurrenceRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOccurrence

The response to send back to the client (wrapped by a task).

GetOccurrenceNote(GetOccurrenceNoteRequest, ServerCallContext)

public virtual Task<Note> GetOccurrenceNote(GetOccurrenceNoteRequest request, ServerCallContext context)

Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.

Parameters
NameDescription
requestGetOccurrenceNoteRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskNote

The response to send back to the client (wrapped by a task).

ListNoteOccurrences(ListNoteOccurrencesRequest, ServerCallContext)

public virtual Task<ListNoteOccurrencesResponse> ListNoteOccurrences(ListNoteOccurrencesRequest request, ServerCallContext context)

Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.

Parameters
NameDescription
requestListNoteOccurrencesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListNoteOccurrencesResponse

The response to send back to the client (wrapped by a task).

ListNotes(ListNotesRequest, ServerCallContext)

public virtual Task<ListNotesResponse> ListNotes(ListNotesRequest request, ServerCallContext context)

Lists notes for the specified project.

Parameters
NameDescription
requestListNotesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListNotesResponse

The response to send back to the client (wrapped by a task).

ListOccurrences(ListOccurrencesRequest, ServerCallContext)

public virtual Task<ListOccurrencesResponse> ListOccurrences(ListOccurrencesRequest request, ServerCallContext context)

Lists occurrences for the specified project.

Parameters
NameDescription
requestListOccurrencesRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskListOccurrencesResponse

The response to send back to the client (wrapped by a task).

UpdateNote(UpdateNoteRequest, ServerCallContext)

public virtual Task<Note> UpdateNote(UpdateNoteRequest request, ServerCallContext context)

Updates the specified note.

Parameters
NameDescription
requestUpdateNoteRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskNote

The response to send back to the client (wrapped by a task).

UpdateOccurrence(UpdateOccurrenceRequest, ServerCallContext)

public virtual Task<Occurrence> UpdateOccurrence(UpdateOccurrenceRequest request, ServerCallContext context)

Updates the specified occurrence.

Parameters
NameDescription
requestUpdateOccurrenceRequest

The request received from the client.

contextServerCallContext

The context of the server-side call handler being invoked.

Returns
TypeDescription
TaskOccurrence

The response to send back to the client (wrapped by a task).