Class GrafeasClientImpl (3.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class GrafeasClientImpl : GrafeasClient

Grafeas client wrapper implementation, for convenient use.

Inheritance

Object > GrafeasClient > GrafeasClientImpl

Namespace

Grafeas.V1

Assembly

Grafeas.V1.dll

Remarks

Grafeas API.

Retrieves analysis results of Cloud components such as Docker container images.

Analysis results are stored as a series of occurrences. An Occurrence contains information about a specific analysis instance on a resource. An occurrence refers to a Note. A note contains details describing the analysis and is generally stored in a separate project, called a Provider. Multiple occurrences can refer to the same note.

For example, an SSL vulnerability could affect multiple images. In this case, there would be one note for the vulnerability and an occurrence for each image with the vulnerability referring to that note.

Constructors

GrafeasClientImpl(Grafeas.GrafeasClient, GrafeasSettings, ILogger)

public GrafeasClientImpl(Grafeas.GrafeasClient grpcClient, GrafeasSettings settings, ILogger logger)

Constructs a client wrapper for the Grafeas service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientGrafeas.GrafeasClient

The underlying gRPC client.

settingsGrafeasSettings

The base GrafeasSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override Grafeas.GrafeasClient GrpcClient { get; }

The underlying gRPC Grafeas client

Property Value
TypeDescription
Grafeas.GrafeasClient
Overrides

Methods

BatchCreateNotes(BatchCreateNotesRequest, CallSettings)

public override BatchCreateNotesResponse BatchCreateNotes(BatchCreateNotesRequest request, CallSettings callSettings = null)

Creates new notes in batch.

Parameters
NameDescription
requestBatchCreateNotesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
BatchCreateNotesResponse

The RPC response.

Overrides

BatchCreateNotesAsync(BatchCreateNotesRequest, CallSettings)

public override Task<BatchCreateNotesResponse> BatchCreateNotesAsync(BatchCreateNotesRequest request, CallSettings callSettings = null)

Creates new notes in batch.

Parameters
NameDescription
requestBatchCreateNotesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<BatchCreateNotesResponse>

A Task containing the RPC response.

Overrides

BatchCreateOccurrences(BatchCreateOccurrencesRequest, CallSettings)

public override BatchCreateOccurrencesResponse BatchCreateOccurrences(BatchCreateOccurrencesRequest request, CallSettings callSettings = null)

Creates new occurrences in batch.

Parameters
NameDescription
requestBatchCreateOccurrencesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
BatchCreateOccurrencesResponse

The RPC response.

Overrides

BatchCreateOccurrencesAsync(BatchCreateOccurrencesRequest, CallSettings)

public override Task<BatchCreateOccurrencesResponse> BatchCreateOccurrencesAsync(BatchCreateOccurrencesRequest request, CallSettings callSettings = null)

Creates new occurrences in batch.

Parameters
NameDescription
requestBatchCreateOccurrencesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<BatchCreateOccurrencesResponse>

A Task containing the RPC response.

Overrides

CreateNote(CreateNoteRequest, CallSettings)

public override Note CreateNote(CreateNoteRequest request, CallSettings callSettings = null)

Creates a new note.

Parameters
NameDescription
requestCreateNoteRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Note

The RPC response.

Overrides

CreateNoteAsync(CreateNoteRequest, CallSettings)

public override Task<Note> CreateNoteAsync(CreateNoteRequest request, CallSettings callSettings = null)

Creates a new note.

Parameters
NameDescription
requestCreateNoteRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Note>

A Task containing the RPC response.

Overrides

CreateOccurrence(CreateOccurrenceRequest, CallSettings)

public override Occurrence CreateOccurrence(CreateOccurrenceRequest request, CallSettings callSettings = null)

Creates a new occurrence.

Parameters
NameDescription
requestCreateOccurrenceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Occurrence

The RPC response.

Overrides

CreateOccurrenceAsync(CreateOccurrenceRequest, CallSettings)

public override Task<Occurrence> CreateOccurrenceAsync(CreateOccurrenceRequest request, CallSettings callSettings = null)

Creates a new occurrence.

Parameters
NameDescription
requestCreateOccurrenceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Occurrence>

A Task containing the RPC response.

Overrides

DeleteNote(DeleteNoteRequest, CallSettings)

public override void DeleteNote(DeleteNoteRequest request, CallSettings callSettings = null)

Deletes the specified note.

Parameters
NameDescription
requestDeleteNoteRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteNoteAsync(DeleteNoteRequest, CallSettings)

public override Task DeleteNoteAsync(DeleteNoteRequest request, CallSettings callSettings = null)

Deletes the specified note.

Parameters
NameDescription
requestDeleteNoteRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

DeleteOccurrence(DeleteOccurrenceRequest, CallSettings)

public override void DeleteOccurrence(DeleteOccurrenceRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Overrides

DeleteOccurrenceAsync(DeleteOccurrenceRequest, CallSettings)

public override Task DeleteOccurrenceAsync(DeleteOccurrenceRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task

A Task containing the RPC response.

Overrides

GetNote(GetNoteRequest, CallSettings)

public override Note GetNote(GetNoteRequest request, CallSettings callSettings = null)

Gets the specified note.

Parameters
NameDescription
requestGetNoteRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Note

The RPC response.

Overrides

GetNoteAsync(GetNoteRequest, CallSettings)

public override Task<Note> GetNoteAsync(GetNoteRequest request, CallSettings callSettings = null)

Gets the specified note.

Parameters
NameDescription
requestGetNoteRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Note>

A Task containing the RPC response.

Overrides

GetOccurrence(GetOccurrenceRequest, CallSettings)

public override Occurrence GetOccurrence(GetOccurrenceRequest request, CallSettings callSettings = null)

Gets the specified occurrence.

Parameters
NameDescription
requestGetOccurrenceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Occurrence

The RPC response.

Overrides

GetOccurrenceAsync(GetOccurrenceRequest, CallSettings)

public override Task<Occurrence> GetOccurrenceAsync(GetOccurrenceRequest request, CallSettings callSettings = null)

Gets the specified occurrence.

Parameters
NameDescription
requestGetOccurrenceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Occurrence>

A Task containing the RPC response.

Overrides

GetOccurrenceNote(GetOccurrenceNoteRequest, CallSettings)

public override Note GetOccurrenceNote(GetOccurrenceNoteRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Note

The RPC response.

Overrides

GetOccurrenceNoteAsync(GetOccurrenceNoteRequest, CallSettings)

public override Task<Note> GetOccurrenceNoteAsync(GetOccurrenceNoteRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Note>

A Task containing the RPC response.

Overrides

ListNoteOccurrences(ListNoteOccurrencesRequest, CallSettings)

public override PagedEnumerable<ListNoteOccurrencesResponse, Occurrence> ListNoteOccurrences(ListNoteOccurrencesRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListNoteOccurrencesResponse, Occurrence>

A pageable sequence of Occurrence resources.

Overrides

ListNoteOccurrencesAsync(ListNoteOccurrencesRequest, CallSettings)

public override PagedAsyncEnumerable<ListNoteOccurrencesResponse, Occurrence> ListNoteOccurrencesAsync(ListNoteOccurrencesRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListNoteOccurrencesResponse, Occurrence>

A pageable asynchronous sequence of Occurrence resources.

Overrides

ListNotes(ListNotesRequest, CallSettings)

public override PagedEnumerable<ListNotesResponse, Note> ListNotes(ListNotesRequest request, CallSettings callSettings = null)

Lists notes for the specified project.

Parameters
NameDescription
requestListNotesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListNotesResponse, Note>

A pageable sequence of Note resources.

Overrides

ListNotesAsync(ListNotesRequest, CallSettings)

public override PagedAsyncEnumerable<ListNotesResponse, Note> ListNotesAsync(ListNotesRequest request, CallSettings callSettings = null)

Lists notes for the specified project.

Parameters
NameDescription
requestListNotesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListNotesResponse, Note>

A pageable asynchronous sequence of Note resources.

Overrides

ListOccurrences(ListOccurrencesRequest, CallSettings)

public override PagedEnumerable<ListOccurrencesResponse, Occurrence> ListOccurrences(ListOccurrencesRequest request, CallSettings callSettings = null)

Lists occurrences for the specified project.

Parameters
NameDescription
requestListOccurrencesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerable<ListOccurrencesResponse, Occurrence>

A pageable sequence of Occurrence resources.

Overrides

ListOccurrencesAsync(ListOccurrencesRequest, CallSettings)

public override PagedAsyncEnumerable<ListOccurrencesResponse, Occurrence> ListOccurrencesAsync(ListOccurrencesRequest request, CallSettings callSettings = null)

Lists occurrences for the specified project.

Parameters
NameDescription
requestListOccurrencesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerable<ListOccurrencesResponse, Occurrence>

A pageable asynchronous sequence of Occurrence resources.

Overrides

UpdateNote(UpdateNoteRequest, CallSettings)

public override Note UpdateNote(UpdateNoteRequest request, CallSettings callSettings = null)

Updates the specified note.

Parameters
NameDescription
requestUpdateNoteRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Note

The RPC response.

Overrides

UpdateNoteAsync(UpdateNoteRequest, CallSettings)

public override Task<Note> UpdateNoteAsync(UpdateNoteRequest request, CallSettings callSettings = null)

Updates the specified note.

Parameters
NameDescription
requestUpdateNoteRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Note>

A Task containing the RPC response.

Overrides

UpdateOccurrence(UpdateOccurrenceRequest, CallSettings)

public override Occurrence UpdateOccurrence(UpdateOccurrenceRequest request, CallSettings callSettings = null)

Updates the specified occurrence.

Parameters
NameDescription
requestUpdateOccurrenceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Occurrence

The RPC response.

Overrides

UpdateOccurrenceAsync(UpdateOccurrenceRequest, CallSettings)

public override Task<Occurrence> UpdateOccurrenceAsync(UpdateOccurrenceRequest request, CallSettings callSettings = null)

Updates the specified occurrence.

Parameters
NameDescription
requestUpdateOccurrenceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Task<Occurrence>

A Task containing the RPC response.

Overrides