Class protos.grafeas.v1.Grafeas (3.4.6)

Represents a Grafeas

Inheritance

$protobuf.rpc.Service > protos.grafeas.v1.Grafeas

Package

@google-cloud/grafeas!

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Grafeas service.

Parameters

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Methods

batchCreateNotes(request, callback)

public batchCreateNotes(request: grafeas.v1.IBatchCreateNotesRequest, callback: grafeas.v1.Grafeas.BatchCreateNotesCallback): void;

Calls BatchCreateNotes.

Parameters

Name	Description
request	`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
void

batchCreateNotes(request)

public batchCreateNotes(request: grafeas.v1.IBatchCreateNotesRequest): Promise<grafeas.v1.BatchCreateNotesResponse>;

Calls BatchCreateNotes.

Parameter

Name	Description
request	`IBatchCreateNotesRequest` BatchCreateNotesRequest message or plain object

Returns

Type	Description
Promise<grafeas.v1.BatchCreateNotesResponse>	Promise

batchCreateOccurrences(request, callback)

public batchCreateOccurrences(request: grafeas.v1.IBatchCreateOccurrencesRequest, callback: grafeas.v1.Grafeas.BatchCreateOccurrencesCallback): void;

Calls BatchCreateOccurrences.

Parameters

Name	Description
request	`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
void

batchCreateOccurrences(request)

public batchCreateOccurrences(request: grafeas.v1.IBatchCreateOccurrencesRequest): Promise<grafeas.v1.BatchCreateOccurrencesResponse>;

Calls BatchCreateOccurrences.

Parameter

Name	Description
request	`IBatchCreateOccurrencesRequest` BatchCreateOccurrencesRequest message or plain object

Returns

Type	Description
Promise<grafeas.v1.BatchCreateOccurrencesResponse>	Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Grafeas;

Creates new Grafeas service using the specified rpc implementation.

Parameters

Name	Description
rpcImpl	`$protobuf.RPCImpl` RPC implementation
requestDelimited	`boolean` Whether requests are length-delimited
responseDelimited	`boolean` Whether responses are length-delimited

Returns

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

createNote(request, callback)

public createNote(request: grafeas.v1.ICreateNoteRequest, callback: grafeas.v1.Grafeas.CreateNoteCallback): void;

Calls CreateNote.

Parameters

Name	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
void

createNote(request)

public createNote(request: grafeas.v1.ICreateNoteRequest): Promise<grafeas.v1.Note>;

Calls CreateNote.

Parameter

Name	Description
request	`grafeas.v1.ICreateNoteRequest` CreateNoteRequest message or plain object

Returns

Type	Description
Promise<grafeas.v1.Note>	Promise

createOccurrence(request, callback)

public createOccurrence(request: grafeas.v1.ICreateOccurrenceRequest, callback: grafeas.v1.Grafeas.CreateOccurrenceCallback): void;

Calls CreateOccurrence.

Parameters

Name	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
void

createOccurrence(request)

public createOccurrence(request: grafeas.v1.ICreateOccurrenceRequest): Promise<grafeas.v1.Occurrence>;

Calls CreateOccurrence.

Parameter

Name	Description
request	`grafeas.v1.ICreateOccurrenceRequest` CreateOccurrenceRequest message or plain object

Returns

Type	Description
Promise<grafeas.v1.Occurrence>	Promise

deleteNote(request, callback)

public deleteNote(request: grafeas.v1.IDeleteNoteRequest, callback: grafeas.v1.Grafeas.DeleteNoteCallback): void;

Calls DeleteNote.

Parameters

Name	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
void

deleteNote(request)

public deleteNote(request: grafeas.v1.IDeleteNoteRequest): Promise<google.protobuf.Empty>;

Calls DeleteNote.

Parameter

Name	Description
request	`grafeas.v1.IDeleteNoteRequest` DeleteNoteRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

deleteOccurrence(request, callback)

public deleteOccurrence(request: grafeas.v1.IDeleteOccurrenceRequest, callback: grafeas.v1.Grafeas.DeleteOccurrenceCallback): void;

Calls DeleteOccurrence.

Parameters

Name	Description
request	`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
void

deleteOccurrence(request)

public deleteOccurrence(request: grafeas.v1.IDeleteOccurrenceRequest): Promise<google.protobuf.Empty>;

Calls DeleteOccurrence.

Parameter

Name	Description
request	`IDeleteOccurrenceRequest` DeleteOccurrenceRequest message or plain object

Returns

Type	Description
Promise<google.protobuf.Empty>	Promise

getNote(request, callback)

public getNote(request: grafeas.v1.IGetNoteRequest, callback: grafeas.v1.Grafeas.GetNoteCallback): void;

Calls GetNote.

Parameters

Name	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
void

getNote(request)

public getNote(request: grafeas.v1.IGetNoteRequest): Promise<grafeas.v1.Note>;

Calls GetNote.

Parameter

Name	Description
request	`grafeas.v1.IGetNoteRequest` GetNoteRequest message or plain object

Returns

Type	Description
Promise<grafeas.v1.Note>	Promise

getOccurrence(request, callback)

public getOccurrence(request: grafeas.v1.IGetOccurrenceRequest, callback: grafeas.v1.Grafeas.GetOccurrenceCallback): void;

Calls GetOccurrence.

Parameters

Name	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
void

getOccurrence(request)

public getOccurrence(request: grafeas.v1.IGetOccurrenceRequest): Promise<grafeas.v1.Occurrence>;

Calls GetOccurrence.

Parameter

Name	Description
request	`grafeas.v1.IGetOccurrenceRequest` GetOccurrenceRequest message or plain object

Returns

Type	Description
Promise<grafeas.v1.Occurrence>	Promise

getOccurrenceNote(request, callback)

public getOccurrenceNote(request: grafeas.v1.IGetOccurrenceNoteRequest, callback: grafeas.v1.Grafeas.GetOccurrenceNoteCallback): void;

Calls GetOccurrenceNote.

Parameters

Name	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
void

getOccurrenceNote(request)

public getOccurrenceNote(request: grafeas.v1.IGetOccurrenceNoteRequest): Promise<grafeas.v1.Note>;

Calls GetOccurrenceNote.

Parameter

Name	Description
request	`grafeas.v1.IGetOccurrenceNoteRequest` GetOccurrenceNoteRequest message or plain object

Returns

Type	Description
Promise<grafeas.v1.Note>	Promise

listNoteOccurrences(request, callback)

public listNoteOccurrences(request: grafeas.v1.IListNoteOccurrencesRequest, callback: grafeas.v1.Grafeas.ListNoteOccurrencesCallback): void;

Calls ListNoteOccurrences.

Parameters

Name	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
void

listNoteOccurrences(request)

public listNoteOccurrences(request: grafeas.v1.IListNoteOccurrencesRequest): Promise<grafeas.v1.ListNoteOccurrencesResponse>;

Calls ListNoteOccurrences.

Parameter

Name	Description
request	`grafeas.v1.IListNoteOccurrencesRequest` ListNoteOccurrencesRequest message or plain object

Returns

Type	Description
Promise<grafeas.v1.ListNoteOccurrencesResponse>	Promise

listNotes(request, callback)

public listNotes(request: grafeas.v1.IListNotesRequest, callback: grafeas.v1.Grafeas.ListNotesCallback): void;

Calls ListNotes.

Parameters

Name	Description
request	`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
void

listNotes(request)

public listNotes(request: grafeas.v1.IListNotesRequest): Promise<grafeas.v1.ListNotesResponse>;

Calls ListNotes.

Parameter

Name	Description
request	`IListNotesRequest` ListNotesRequest message or plain object

Returns

Type	Description
Promise<grafeas.v1.ListNotesResponse>	Promise

listOccurrences(request, callback)

public listOccurrences(request: grafeas.v1.IListOccurrencesRequest, callback: grafeas.v1.Grafeas.ListOccurrencesCallback): void;

Calls ListOccurrences.

Parameters

Name	Description
request	`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
void

listOccurrences(request)

public listOccurrences(request: grafeas.v1.IListOccurrencesRequest): Promise<grafeas.v1.ListOccurrencesResponse>;

Calls ListOccurrences.

Parameter

Name	Description
request	`IListOccurrencesRequest` ListOccurrencesRequest message or plain object

Returns

Type	Description
Promise<grafeas.v1.ListOccurrencesResponse>	Promise

updateNote(request, callback)

public updateNote(request: grafeas.v1.IUpdateNoteRequest, callback: grafeas.v1.Grafeas.UpdateNoteCallback): void;

Calls UpdateNote.

Parameters

Name	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
void

updateNote(request)

public updateNote(request: grafeas.v1.IUpdateNoteRequest): Promise<grafeas.v1.Note>;

Calls UpdateNote.

Parameter

Name	Description
request	`grafeas.v1.IUpdateNoteRequest` UpdateNoteRequest message or plain object

Returns

Type	Description
Promise<grafeas.v1.Note>	Promise

updateOccurrence(request, callback)

public updateOccurrence(request: grafeas.v1.IUpdateOccurrenceRequest, callback: grafeas.v1.Grafeas.UpdateOccurrenceCallback): void;

Calls UpdateOccurrence.

Parameters

Name	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
void

updateOccurrence(request)

public updateOccurrence(request: grafeas.v1.IUpdateOccurrenceRequest): Promise<grafeas.v1.Occurrence>;

Calls UpdateOccurrence.

Parameter

Name	Description
request	`grafeas.v1.IUpdateOccurrenceRequest` UpdateOccurrenceRequest message or plain object

Returns

Type	Description
Promise<grafeas.v1.Occurrence>	Promise