Grafeas

grafeas.v1. Grafeas

Represents a Grafeas

Constructor

new Grafeas(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Grafeas service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

batchCreateNotes(request, callback) → {undefined}

Calls BatchCreateNotes.

Parameters:
Name Type Description
request grafeas.v1.IBatchCreateNotesRequest

BatchCreateNotesRequest message or plain object
callback grafeas.v1.Grafeas.BatchCreateNotesCallback

Node-style callback called with the error, if any, and BatchCreateNotesResponse
Returns:
Type Description
undefined

batchCreateNotes(request) → {Promise.<grafeas.v1.BatchCreateNotesResponse>}

Calls BatchCreateNotes.

Parameters:
Name Type Description
request grafeas.v1.IBatchCreateNotesRequest

BatchCreateNotesRequest message or plain object
Returns:
Type Description
Promise.<grafeas.v1.BatchCreateNotesResponse>

Promise

batchCreateOccurrences(request, callback) → {undefined}

Calls BatchCreateOccurrences.

Parameters:
Name Type Description
request grafeas.v1.IBatchCreateOccurrencesRequest

BatchCreateOccurrencesRequest message or plain object
callback grafeas.v1.Grafeas.BatchCreateOccurrencesCallback

Node-style callback called with the error, if any, and BatchCreateOccurrencesResponse
Returns:
Type Description
undefined

batchCreateOccurrences(request) → {Promise.<grafeas.v1.BatchCreateOccurrencesResponse>}

Calls BatchCreateOccurrences.

Parameters:
Name Type Description
request grafeas.v1.IBatchCreateOccurrencesRequest

BatchCreateOccurrencesRequest message or plain object
Returns:
Type Description
Promise.<grafeas.v1.BatchCreateOccurrencesResponse>

Promise

createNote(request, callback) → {undefined}

Calls CreateNote.

Parameters:
Name Type Description
request grafeas.v1.ICreateNoteRequest

CreateNoteRequest message or plain object
callback grafeas.v1.Grafeas.CreateNoteCallback

Node-style callback called with the error, if any, and Note
Returns:
Type Description
undefined

createNote(request) → {Promise.<grafeas.v1.Note>}

Calls CreateNote.

Parameters:
Name Type Description
request grafeas.v1.ICreateNoteRequest

CreateNoteRequest message or plain object
Returns:
Type Description
Promise.<grafeas.v1.Note>

Promise

createOccurrence(request, callback) → {undefined}

Calls CreateOccurrence.

Parameters:
Name Type Description
request grafeas.v1.ICreateOccurrenceRequest

CreateOccurrenceRequest message or plain object
callback grafeas.v1.Grafeas.CreateOccurrenceCallback

Node-style callback called with the error, if any, and Occurrence
Returns:
Type Description
undefined

createOccurrence(request) → {Promise.<grafeas.v1.Occurrence>}

Calls CreateOccurrence.

Parameters:
Name Type Description
request grafeas.v1.ICreateOccurrenceRequest

CreateOccurrenceRequest message or plain object
Returns:
Type Description
Promise.<grafeas.v1.Occurrence>

Promise

deleteNote(request, callback) → {undefined}

Calls DeleteNote.

Parameters:
Name Type Description
request grafeas.v1.IDeleteNoteRequest

DeleteNoteRequest message or plain object
callback grafeas.v1.Grafeas.DeleteNoteCallback

Node-style callback called with the error, if any, and Empty
Returns:
Type Description
undefined

deleteNote(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteNote.

Parameters:
Name Type Description
request grafeas.v1.IDeleteNoteRequest

DeleteNoteRequest message or plain object
Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

deleteOccurrence(request, callback) → {undefined}

Calls DeleteOccurrence.

Parameters:
Name Type Description
request grafeas.v1.IDeleteOccurrenceRequest

DeleteOccurrenceRequest message or plain object
callback grafeas.v1.Grafeas.DeleteOccurrenceCallback

Node-style callback called with the error, if any, and Empty
Returns:
Type Description
undefined

deleteOccurrence(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteOccurrence.

Parameters:
Name Type Description
request grafeas.v1.IDeleteOccurrenceRequest

DeleteOccurrenceRequest message or plain object
Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

getNote(request, callback) → {undefined}

Calls GetNote.

Parameters:
Name Type Description
request grafeas.v1.IGetNoteRequest

GetNoteRequest message or plain object
callback grafeas.v1.Grafeas.GetNoteCallback

Node-style callback called with the error, if any, and Note
Returns:
Type Description
undefined

getNote(request) → {Promise.<grafeas.v1.Note>}

Calls GetNote.

Parameters:
Name Type Description
request grafeas.v1.IGetNoteRequest

GetNoteRequest message or plain object
Returns:
Type Description
Promise.<grafeas.v1.Note>

Promise

getOccurrence(request, callback) → {undefined}

Calls GetOccurrence.

Parameters:
Name Type Description
request grafeas.v1.IGetOccurrenceRequest

GetOccurrenceRequest message or plain object
callback grafeas.v1.Grafeas.GetOccurrenceCallback

Node-style callback called with the error, if any, and Occurrence
Returns:
Type Description
undefined

getOccurrence(request) → {Promise.<grafeas.v1.Occurrence>}

Calls GetOccurrence.

Parameters:
Name Type Description
request grafeas.v1.IGetOccurrenceRequest

GetOccurrenceRequest message or plain object
Returns:
Type Description
Promise.<grafeas.v1.Occurrence>

Promise

getOccurrenceNote(request, callback) → {undefined}

Calls GetOccurrenceNote.

Parameters:
Name Type Description
request grafeas.v1.IGetOccurrenceNoteRequest

GetOccurrenceNoteRequest message or plain object
callback grafeas.v1.Grafeas.GetOccurrenceNoteCallback

Node-style callback called with the error, if any, and Note
Returns:
Type Description
undefined

getOccurrenceNote(request) → {Promise.<grafeas.v1.Note>}

Calls GetOccurrenceNote.

Parameters:
Name Type Description
request grafeas.v1.IGetOccurrenceNoteRequest

GetOccurrenceNoteRequest message or plain object
Returns:
Type Description
Promise.<grafeas.v1.Note>

Promise

listNoteOccurrences(request, callback) → {undefined}

Calls ListNoteOccurrences.

Parameters:
Name Type Description
request grafeas.v1.IListNoteOccurrencesRequest

ListNoteOccurrencesRequest message or plain object
callback grafeas.v1.Grafeas.ListNoteOccurrencesCallback

Node-style callback called with the error, if any, and ListNoteOccurrencesResponse
Returns:
Type Description
undefined

listNoteOccurrences(request) → {Promise.<grafeas.v1.ListNoteOccurrencesResponse>}

Calls ListNoteOccurrences.

Parameters:
Name Type Description
request grafeas.v1.IListNoteOccurrencesRequest

ListNoteOccurrencesRequest message or plain object
Returns:
Type Description
Promise.<grafeas.v1.ListNoteOccurrencesResponse>

Promise

listNotes(request, callback) → {undefined}

Calls ListNotes.

Parameters:
Name Type Description
request grafeas.v1.IListNotesRequest

ListNotesRequest message or plain object
callback grafeas.v1.Grafeas.ListNotesCallback

Node-style callback called with the error, if any, and ListNotesResponse
Returns:
Type Description
undefined

listNotes(request) → {Promise.<grafeas.v1.ListNotesResponse>}

Calls ListNotes.

Parameters:
Name Type Description
request grafeas.v1.IListNotesRequest

ListNotesRequest message or plain object
Returns:
Type Description
Promise.<grafeas.v1.ListNotesResponse>

Promise

listOccurrences(request, callback) → {undefined}

Calls ListOccurrences.

Parameters:
Name Type Description
request grafeas.v1.IListOccurrencesRequest

ListOccurrencesRequest message or plain object
callback grafeas.v1.Grafeas.ListOccurrencesCallback

Node-style callback called with the error, if any, and ListOccurrencesResponse
Returns:
Type Description
undefined

listOccurrences(request) → {Promise.<grafeas.v1.ListOccurrencesResponse>}

Calls ListOccurrences.

Parameters:
Name Type Description
request grafeas.v1.IListOccurrencesRequest

ListOccurrencesRequest message or plain object
Returns:
Type Description
Promise.<grafeas.v1.ListOccurrencesResponse>

Promise

updateNote(request, callback) → {undefined}

Calls UpdateNote.

Parameters:
Name Type Description
request grafeas.v1.IUpdateNoteRequest

UpdateNoteRequest message or plain object
callback grafeas.v1.Grafeas.UpdateNoteCallback

Node-style callback called with the error, if any, and Note
Returns:
Type Description
undefined

updateNote(request) → {Promise.<grafeas.v1.Note>}

Calls UpdateNote.

Parameters:
Name Type Description
request grafeas.v1.IUpdateNoteRequest

UpdateNoteRequest message or plain object
Returns:
Type Description
Promise.<grafeas.v1.Note>

Promise

updateOccurrence(request, callback) → {undefined}

Calls UpdateOccurrence.

Parameters:
Name Type Description
request grafeas.v1.IUpdateOccurrenceRequest

UpdateOccurrenceRequest message or plain object
callback grafeas.v1.Grafeas.UpdateOccurrenceCallback

Node-style callback called with the error, if any, and Occurrence
Returns:
Type Description
undefined

updateOccurrence(request) → {Promise.<grafeas.v1.Occurrence>}

Calls UpdateOccurrence.

Parameters:
Name Type Description
request grafeas.v1.IUpdateOccurrenceRequest

UpdateOccurrenceRequest message or plain object
Returns:
Type Description
Promise.<grafeas.v1.Occurrence>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Grafeas}

Creates new Grafeas service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited
Returns:
Type Description
Grafeas

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

BatchCreateNotesCallback(error, responseopt)

Callback as used by batchCreateNotes.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response grafeas.v1.BatchCreateNotesResponse <optional>

BatchCreateNotesResponse

BatchCreateOccurrencesCallback(error, responseopt)

Callback as used by batchCreateOccurrences.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response grafeas.v1.BatchCreateOccurrencesResponse <optional>

BatchCreateOccurrencesResponse

CreateNoteCallback(error, responseopt)

Callback as used by createNote.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response grafeas.v1.Note <optional>

Note

CreateOccurrenceCallback(error, responseopt)

Callback as used by createOccurrence.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response grafeas.v1.Occurrence <optional>

Occurrence

DeleteNoteCallback(error, responseopt)

Callback as used by deleteNote.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.protobuf.Empty <optional>

Empty

DeleteOccurrenceCallback(error, responseopt)

Callback as used by deleteOccurrence.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.protobuf.Empty <optional>

Empty

GetNoteCallback(error, responseopt)

Callback as used by getNote.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response grafeas.v1.Note <optional>

Note

GetOccurrenceCallback(error, responseopt)

Callback as used by getOccurrence.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response grafeas.v1.Occurrence <optional>

Occurrence

GetOccurrenceNoteCallback(error, responseopt)

Callback as used by getOccurrenceNote.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response grafeas.v1.Note <optional>

Note

ListNoteOccurrencesCallback(error, responseopt)

Callback as used by listNoteOccurrences.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response grafeas.v1.ListNoteOccurrencesResponse <optional>

ListNoteOccurrencesResponse

ListNotesCallback(error, responseopt)

Callback as used by listNotes.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response grafeas.v1.ListNotesResponse <optional>

ListNotesResponse

ListOccurrencesCallback(error, responseopt)

Callback as used by listOccurrences.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response grafeas.v1.ListOccurrencesResponse <optional>

ListOccurrencesResponse

UpdateNoteCallback(error, responseopt)

Callback as used by updateNote.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response grafeas.v1.Note <optional>

Note

UpdateOccurrenceCallback(error, responseopt)

Callback as used by updateOccurrence.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response grafeas.v1.Occurrence <optional>

Occurrence