io.grafeas.v1

Class GrafeasClient

java.lang.Object

io.grafeas.v1.GrafeasClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class GrafeasClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: [Grafeas](https://grafeas.io) 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.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 
 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   Occurrence response = grafeasClient.getOccurrence(name);
 }
 
 

Note: close() needs to be called on the grafeasClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of GrafeasSettings to create(). For example:

To customize credentials:

 
 GrafeasSettings grafeasSettings =
     GrafeasSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 GrafeasClient grafeasClient =
     GrafeasClient.create(grafeasSettings);
 
 

To customize the endpoint:

 
 GrafeasSettings grafeasSettings =
     GrafeasSettings.newBuilder().setEndpoint(myEndpoint).build();
 GrafeasClient grafeasClient =
     GrafeasClient.create(grafeasSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GrafeasClient.ListNoteOccurrencesFixedSizeCollection
static class	GrafeasClient.ListNoteOccurrencesPage
static class	GrafeasClient.ListNoteOccurrencesPagedResponse
static class	GrafeasClient.ListNotesFixedSizeCollection
static class	GrafeasClient.ListNotesPage
static class	GrafeasClient.ListNotesPagedResponse
static class	GrafeasClient.ListOccurrencesFixedSizeCollection
static class	GrafeasClient.ListOccurrencesPage
static class	GrafeasClient.ListOccurrencesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GrafeasClient(GrafeasSettings settings) Constructs an instance of GrafeasClient, using the given settings.
protected	GrafeasClient(GrafeasStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
BatchCreateNotesResponse	batchCreateNotes(BatchCreateNotesRequest request) Creates new notes in batch.
BatchCreateNotesResponse	batchCreateNotes(ProjectName parent, Map<String,Note> notes) Creates new notes in batch.
BatchCreateNotesResponse	batchCreateNotes(String parent, Map<String,Note> notes) Creates new notes in batch.
com.google.api.gax.rpc.UnaryCallable<BatchCreateNotesRequest,BatchCreateNotesResponse>	batchCreateNotesCallable() Creates new notes in batch.
BatchCreateOccurrencesResponse	batchCreateOccurrences(BatchCreateOccurrencesRequest request) Creates new occurrences in batch.
BatchCreateOccurrencesResponse	batchCreateOccurrences(ProjectName parent, List<Occurrence> occurrences) Creates new occurrences in batch.
BatchCreateOccurrencesResponse	batchCreateOccurrences(String parent, List<Occurrence> occurrences) Creates new occurrences in batch.
com.google.api.gax.rpc.UnaryCallable<BatchCreateOccurrencesRequest,BatchCreateOccurrencesResponse>	batchCreateOccurrencesCallable() Creates new occurrences in batch.
void	close()
static GrafeasClient	create() Constructs an instance of GrafeasClient with default settings.
static GrafeasClient	create(GrafeasSettings settings) Constructs an instance of GrafeasClient, using the given settings.
static GrafeasClient	create(GrafeasStub stub) Constructs an instance of GrafeasClient, using the given stub for making calls.
Note	createNote(CreateNoteRequest request) Creates a new note.
Note	createNote(ProjectName parent, String noteId, Note note) Creates a new note.
Note	createNote(String parent, String noteId, Note note) Creates a new note.
com.google.api.gax.rpc.UnaryCallable<CreateNoteRequest,Note>	createNoteCallable() Creates a new note.
Occurrence	createOccurrence(CreateOccurrenceRequest request) Creates a new occurrence.
Occurrence	createOccurrence(ProjectName parent, Occurrence occurrence) Creates a new occurrence.
Occurrence	createOccurrence(String parent, Occurrence occurrence) Creates a new occurrence.
com.google.api.gax.rpc.UnaryCallable<CreateOccurrenceRequest,Occurrence>	createOccurrenceCallable() Creates a new occurrence.
void	deleteNote(DeleteNoteRequest request) Deletes the specified note.
void	deleteNote(NoteName name) Deletes the specified note.
void	deleteNote(String name) Deletes the specified note.
com.google.api.gax.rpc.UnaryCallable<DeleteNoteRequest,Empty>	deleteNoteCallable() Deletes the specified note.
void	deleteOccurrence(DeleteOccurrenceRequest request) Deletes the specified occurrence.
void	deleteOccurrence(OccurrenceName name) Deletes the specified occurrence.
void	deleteOccurrence(String name) Deletes the specified occurrence.
com.google.api.gax.rpc.UnaryCallable<DeleteOccurrenceRequest,Empty>	deleteOccurrenceCallable() Deletes the specified occurrence.
Note	getNote(GetNoteRequest request) Gets the specified note.
Note	getNote(NoteName name) Gets the specified note.
Note	getNote(String name) Gets the specified note.
com.google.api.gax.rpc.UnaryCallable<GetNoteRequest,Note>	getNoteCallable() Gets the specified note.
Occurrence	getOccurrence(GetOccurrenceRequest request) Gets the specified occurrence.
Occurrence	getOccurrence(OccurrenceName name) Gets the specified occurrence.
Occurrence	getOccurrence(String name) Gets the specified occurrence.
com.google.api.gax.rpc.UnaryCallable<GetOccurrenceRequest,Occurrence>	getOccurrenceCallable() Gets the specified occurrence.
Note	getOccurrenceNote(GetOccurrenceNoteRequest request) Gets the note attached to the specified occurrence.
Note	getOccurrenceNote(OccurrenceName name) Gets the note attached to the specified occurrence.
Note	getOccurrenceNote(String name) Gets the note attached to the specified occurrence.
com.google.api.gax.rpc.UnaryCallable<GetOccurrenceNoteRequest,Note>	getOccurrenceNoteCallable() Gets the note attached to the specified occurrence.
GrafeasSettings	getSettings()
GrafeasStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
GrafeasClient.ListNoteOccurrencesPagedResponse	listNoteOccurrences(ListNoteOccurrencesRequest request) Lists occurrences referencing the specified note.
GrafeasClient.ListNoteOccurrencesPagedResponse	listNoteOccurrences(NoteName name, String filter) Lists occurrences referencing the specified note.
GrafeasClient.ListNoteOccurrencesPagedResponse	listNoteOccurrences(String name, String filter) Lists occurrences referencing the specified note.
com.google.api.gax.rpc.UnaryCallable<ListNoteOccurrencesRequest,ListNoteOccurrencesResponse>	listNoteOccurrencesCallable() Lists occurrences referencing the specified note.
com.google.api.gax.rpc.UnaryCallable<ListNoteOccurrencesRequest,GrafeasClient.ListNoteOccurrencesPagedResponse>	listNoteOccurrencesPagedCallable() Lists occurrences referencing the specified note.
GrafeasClient.ListNotesPagedResponse	listNotes(ListNotesRequest request) Lists notes for the specified project.
GrafeasClient.ListNotesPagedResponse	listNotes(ProjectName parent, String filter) Lists notes for the specified project.
GrafeasClient.ListNotesPagedResponse	listNotes(String parent, String filter) Lists notes for the specified project.
com.google.api.gax.rpc.UnaryCallable<ListNotesRequest,ListNotesResponse>	listNotesCallable() Lists notes for the specified project.
com.google.api.gax.rpc.UnaryCallable<ListNotesRequest,GrafeasClient.ListNotesPagedResponse>	listNotesPagedCallable() Lists notes for the specified project.
GrafeasClient.ListOccurrencesPagedResponse	listOccurrences(ListOccurrencesRequest request) Lists occurrences for the specified project.
GrafeasClient.ListOccurrencesPagedResponse	listOccurrences(ProjectName parent, String filter) Lists occurrences for the specified project.
GrafeasClient.ListOccurrencesPagedResponse	listOccurrences(String parent, String filter) Lists occurrences for the specified project.
com.google.api.gax.rpc.UnaryCallable<ListOccurrencesRequest,ListOccurrencesResponse>	listOccurrencesCallable() Lists occurrences for the specified project.
com.google.api.gax.rpc.UnaryCallable<ListOccurrencesRequest,GrafeasClient.ListOccurrencesPagedResponse>	listOccurrencesPagedCallable() Lists occurrences for the specified project.
void	shutdown()
void	shutdownNow()
Note	updateNote(NoteName name, Note note, FieldMask updateMask) Updates the specified note.
Note	updateNote(String name, Note note, FieldMask updateMask) Updates the specified note.
Note	updateNote(UpdateNoteRequest request) Updates the specified note.
com.google.api.gax.rpc.UnaryCallable<UpdateNoteRequest,Note>	updateNoteCallable() Updates the specified note.
Occurrence	updateOccurrence(OccurrenceName name, Occurrence occurrence, FieldMask updateMask) Updates the specified occurrence.
Occurrence	updateOccurrence(String name, Occurrence occurrence, FieldMask updateMask) Updates the specified occurrence.
Occurrence	updateOccurrence(UpdateOccurrenceRequest request) Updates the specified occurrence.
com.google.api.gax.rpc.UnaryCallable<UpdateOccurrenceRequest,Occurrence>	updateOccurrenceCallable() Updates the specified occurrence.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GrafeasClient

protected GrafeasClient(GrafeasSettings settings)
                 throws IOException

Constructs an instance of GrafeasClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

GrafeasClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected GrafeasClient(GrafeasStub stub)

Method Detail

create

public static final GrafeasClient create()
                                  throws IOException

Constructs an instance of GrafeasClient with default settings.

Throws:

IOException

create

public static final GrafeasClient create(GrafeasSettings settings)
                                  throws IOException

Constructs an instance of GrafeasClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final GrafeasClient create(GrafeasStub stub)

Constructs an instance of GrafeasClient, using the given stub for making calls. This is for advanced usage - prefer to use GrafeasSettings}.

getSettings

public final GrafeasSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public GrafeasStub getStub()

getOccurrence

public final Occurrence getOccurrence(OccurrenceName name)

Gets the specified occurrence.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   Occurrence response = grafeasClient.getOccurrence(name);
 }
 

Parameters:

name - The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getOccurrence

public final Occurrence getOccurrence(String name)

Gets the specified occurrence.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   Occurrence response = grafeasClient.getOccurrence(name.toString());
 }
 

Parameters:

name - The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getOccurrence

public final Occurrence getOccurrence(GetOccurrenceRequest request)

Gets the specified occurrence.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   GetOccurrenceRequest request = GetOccurrenceRequest.newBuilder()
     .setName(name.toString())
     .build();
   Occurrence response = grafeasClient.getOccurrence(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getOccurrenceCallable

public final com.google.api.gax.rpc.UnaryCallable<GetOccurrenceRequest,Occurrence> getOccurrenceCallable()

Gets the specified occurrence.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   GetOccurrenceRequest request = GetOccurrenceRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Occurrence> future = grafeasClient.getOccurrenceCallable().futureCall(request);
   // Do something
   Occurrence response = future.get();
 }
 

listOccurrences

public final GrafeasClient.ListOccurrencesPagedResponse listOccurrences(ProjectName parent,
                                                                        String filter)

Lists occurrences for the specified project.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String filter = "";
   for (Occurrence element : grafeasClient.listOccurrences(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`.

filter - The filter expression.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listOccurrences

public final GrafeasClient.ListOccurrencesPagedResponse listOccurrences(String parent,
                                                                        String filter)

Lists occurrences for the specified project.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String filter = "";
   for (Occurrence element : grafeasClient.listOccurrences(parent.toString(), filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - The name of the project to list occurrences for in the form of `projects/[PROJECT_ID]`.

filter - The filter expression.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listOccurrences

public final GrafeasClient.ListOccurrencesPagedResponse listOccurrences(ListOccurrencesRequest request)

Lists occurrences for the specified project.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ListOccurrencesRequest request = ListOccurrencesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (Occurrence element : grafeasClient.listOccurrences(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listOccurrencesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListOccurrencesRequest,GrafeasClient.ListOccurrencesPagedResponse> listOccurrencesPagedCallable()

Lists occurrences for the specified project.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ListOccurrencesRequest request = ListOccurrencesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListOccurrencesPagedResponse> future = grafeasClient.listOccurrencesPagedCallable().futureCall(request);
   // Do something
   for (Occurrence element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listOccurrencesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListOccurrencesRequest,ListOccurrencesResponse> listOccurrencesCallable()

Lists occurrences for the specified project.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ListOccurrencesRequest request = ListOccurrencesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListOccurrencesResponse response = grafeasClient.listOccurrencesCallable().call(request);
     for (Occurrence element : response.getOccurrencesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteOccurrence

public final void deleteOccurrence(OccurrenceName name)

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

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   grafeasClient.deleteOccurrence(name);
 }
 

Parameters:

name - The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteOccurrence

public final void deleteOccurrence(String name)

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

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   grafeasClient.deleteOccurrence(name.toString());
 }
 

Parameters:

name - The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteOccurrence

public final void deleteOccurrence(DeleteOccurrenceRequest request)

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

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   DeleteOccurrenceRequest request = DeleteOccurrenceRequest.newBuilder()
     .setName(name.toString())
     .build();
   grafeasClient.deleteOccurrence(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteOccurrenceCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteOccurrenceRequest,Empty> deleteOccurrenceCallable()

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

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   DeleteOccurrenceRequest request = DeleteOccurrenceRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = grafeasClient.deleteOccurrenceCallable().futureCall(request);
   // Do something
   future.get();
 }
 

createOccurrence

public final Occurrence createOccurrence(ProjectName parent,
                                         Occurrence occurrence)

Creates a new occurrence.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Occurrence occurrence = Occurrence.newBuilder().build();
   Occurrence response = grafeasClient.createOccurrence(parent, occurrence);
 }
 

Parameters:

parent - The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrence is to be created.

occurrence - The occurrence to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createOccurrence

public final Occurrence createOccurrence(String parent,
                                         Occurrence occurrence)

Creates a new occurrence.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Occurrence occurrence = Occurrence.newBuilder().build();
   Occurrence response = grafeasClient.createOccurrence(parent.toString(), occurrence);
 }
 

Parameters:

parent - The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrence is to be created.

occurrence - The occurrence to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createOccurrence

public final Occurrence createOccurrence(CreateOccurrenceRequest request)

Creates a new occurrence.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Occurrence occurrence = Occurrence.newBuilder().build();
   CreateOccurrenceRequest request = CreateOccurrenceRequest.newBuilder()
     .setParent(parent.toString())
     .setOccurrence(occurrence)
     .build();
   Occurrence response = grafeasClient.createOccurrence(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createOccurrenceCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateOccurrenceRequest,Occurrence> createOccurrenceCallable()

Creates a new occurrence.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Occurrence occurrence = Occurrence.newBuilder().build();
   CreateOccurrenceRequest request = CreateOccurrenceRequest.newBuilder()
     .setParent(parent.toString())
     .setOccurrence(occurrence)
     .build();
   ApiFuture<Occurrence> future = grafeasClient.createOccurrenceCallable().futureCall(request);
   // Do something
   Occurrence response = future.get();
 }
 

batchCreateOccurrences

public final BatchCreateOccurrencesResponse batchCreateOccurrences(ProjectName parent,
                                                                   List<Occurrence> occurrences)

Creates new occurrences in batch.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   List<Occurrence> occurrences = new ArrayList<>();
   BatchCreateOccurrencesResponse response = grafeasClient.batchCreateOccurrences(parent, occurrences);
 }
 

Parameters:

parent - The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created.

occurrences - The occurrences to create. Max allowed length is 1000.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

batchCreateOccurrences

public final BatchCreateOccurrencesResponse batchCreateOccurrences(String parent,
                                                                   List<Occurrence> occurrences)

Creates new occurrences in batch.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   List<Occurrence> occurrences = new ArrayList<>();
   BatchCreateOccurrencesResponse response = grafeasClient.batchCreateOccurrences(parent.toString(), occurrences);
 }
 

Parameters:

parent - The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created.

occurrences - The occurrences to create. Max allowed length is 1000.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

batchCreateOccurrences

public final BatchCreateOccurrencesResponse batchCreateOccurrences(BatchCreateOccurrencesRequest request)

Creates new occurrences in batch.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   List<Occurrence> occurrences = new ArrayList<>();
   BatchCreateOccurrencesRequest request = BatchCreateOccurrencesRequest.newBuilder()
     .setParent(parent.toString())
     .addAllOccurrences(occurrences)
     .build();
   BatchCreateOccurrencesResponse response = grafeasClient.batchCreateOccurrences(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

batchCreateOccurrencesCallable

public final com.google.api.gax.rpc.UnaryCallable<BatchCreateOccurrencesRequest,BatchCreateOccurrencesResponse> batchCreateOccurrencesCallable()

Creates new occurrences in batch.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   List<Occurrence> occurrences = new ArrayList<>();
   BatchCreateOccurrencesRequest request = BatchCreateOccurrencesRequest.newBuilder()
     .setParent(parent.toString())
     .addAllOccurrences(occurrences)
     .build();
   ApiFuture<BatchCreateOccurrencesResponse> future = grafeasClient.batchCreateOccurrencesCallable().futureCall(request);
   // Do something
   BatchCreateOccurrencesResponse response = future.get();
 }
 

updateOccurrence

public final Occurrence updateOccurrence(OccurrenceName name,
                                         Occurrence occurrence,
                                         FieldMask updateMask)

Updates the specified occurrence.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   Occurrence occurrence = Occurrence.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Occurrence response = grafeasClient.updateOccurrence(name, occurrence, updateMask);
 }
 

Parameters:

name - The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

occurrence - The updated occurrence.

updateMask - The fields to update.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateOccurrence

public final Occurrence updateOccurrence(String name,
                                         Occurrence occurrence,
                                         FieldMask updateMask)

Updates the specified occurrence.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   Occurrence occurrence = Occurrence.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Occurrence response = grafeasClient.updateOccurrence(name.toString(), occurrence, updateMask);
 }
 

Parameters:

name - The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

occurrence - The updated occurrence.

updateMask - The fields to update.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateOccurrence

public final Occurrence updateOccurrence(UpdateOccurrenceRequest request)

Updates the specified occurrence.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   Occurrence occurrence = Occurrence.newBuilder().build();
   UpdateOccurrenceRequest request = UpdateOccurrenceRequest.newBuilder()
     .setName(name.toString())
     .setOccurrence(occurrence)
     .build();
   Occurrence response = grafeasClient.updateOccurrence(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateOccurrenceCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateOccurrenceRequest,Occurrence> updateOccurrenceCallable()

Updates the specified occurrence.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   Occurrence occurrence = Occurrence.newBuilder().build();
   UpdateOccurrenceRequest request = UpdateOccurrenceRequest.newBuilder()
     .setName(name.toString())
     .setOccurrence(occurrence)
     .build();
   ApiFuture<Occurrence> future = grafeasClient.updateOccurrenceCallable().futureCall(request);
   // Do something
   Occurrence response = future.get();
 }
 

getOccurrenceNote

public final Note getOccurrenceNote(OccurrenceName name)

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

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   Note response = grafeasClient.getOccurrenceNote(name);
 }
 

Parameters:

name - The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getOccurrenceNote

public final Note getOccurrenceNote(String name)

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

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   Note response = grafeasClient.getOccurrenceNote(name.toString());
 }
 

Parameters:

name - The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getOccurrenceNote

public final Note getOccurrenceNote(GetOccurrenceNoteRequest request)

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

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   GetOccurrenceNoteRequest request = GetOccurrenceNoteRequest.newBuilder()
     .setName(name.toString())
     .build();
   Note response = grafeasClient.getOccurrenceNote(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getOccurrenceNoteCallable

public final com.google.api.gax.rpc.UnaryCallable<GetOccurrenceNoteRequest,Note> getOccurrenceNoteCallable()

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

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   GetOccurrenceNoteRequest request = GetOccurrenceNoteRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Note> future = grafeasClient.getOccurrenceNoteCallable().futureCall(request);
   // Do something
   Note response = future.get();
 }
 

getNote

public final Note getNote(NoteName name)

Gets the specified note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   Note response = grafeasClient.getNote(name);
 }
 

Parameters:

name - The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getNote

public final Note getNote(String name)

Gets the specified note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   Note response = grafeasClient.getNote(name.toString());
 }
 

Parameters:

name - The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getNote

public final Note getNote(GetNoteRequest request)

Gets the specified note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   GetNoteRequest request = GetNoteRequest.newBuilder()
     .setName(name.toString())
     .build();
   Note response = grafeasClient.getNote(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getNoteCallable

public final com.google.api.gax.rpc.UnaryCallable<GetNoteRequest,Note> getNoteCallable()

Gets the specified note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   GetNoteRequest request = GetNoteRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Note> future = grafeasClient.getNoteCallable().futureCall(request);
   // Do something
   Note response = future.get();
 }
 

listNotes

public final GrafeasClient.ListNotesPagedResponse listNotes(ProjectName parent,
                                                            String filter)

Lists notes for the specified project.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String filter = "";
   for (Note element : grafeasClient.listNotes(parent, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - The name of the project to list notes for in the form of `projects/[PROJECT_ID]`.

filter - The filter expression.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listNotes

public final GrafeasClient.ListNotesPagedResponse listNotes(String parent,
                                                            String filter)

Lists notes for the specified project.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String filter = "";
   for (Note element : grafeasClient.listNotes(parent.toString(), filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - The name of the project to list notes for in the form of `projects/[PROJECT_ID]`.

filter - The filter expression.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listNotes

public final GrafeasClient.ListNotesPagedResponse listNotes(ListNotesRequest request)

Lists notes for the specified project.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ListNotesRequest request = ListNotesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (Note element : grafeasClient.listNotes(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listNotesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListNotesRequest,GrafeasClient.ListNotesPagedResponse> listNotesPagedCallable()

Lists notes for the specified project.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ListNotesRequest request = ListNotesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListNotesPagedResponse> future = grafeasClient.listNotesPagedCallable().futureCall(request);
   // Do something
   for (Note element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listNotesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListNotesRequest,ListNotesResponse> listNotesCallable()

Lists notes for the specified project.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ListNotesRequest request = ListNotesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListNotesResponse response = grafeasClient.listNotesCallable().call(request);
     for (Note element : response.getNotesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

deleteNote

public final void deleteNote(NoteName name)

Deletes the specified note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   grafeasClient.deleteNote(name);
 }
 

Parameters:

name - The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteNote

public final void deleteNote(String name)

Deletes the specified note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   grafeasClient.deleteNote(name.toString());
 }
 

Parameters:

name - The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteNote

public final void deleteNote(DeleteNoteRequest request)

Deletes the specified note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   DeleteNoteRequest request = DeleteNoteRequest.newBuilder()
     .setName(name.toString())
     .build();
   grafeasClient.deleteNote(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteNoteCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteNoteRequest,Empty> deleteNoteCallable()

Deletes the specified note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   DeleteNoteRequest request = DeleteNoteRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = grafeasClient.deleteNoteCallable().futureCall(request);
   // Do something
   future.get();
 }
 

createNote

public final Note createNote(ProjectName parent,
                             String noteId,
                             Note note)

Creates a new note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String noteId = "";
   Note note = Note.newBuilder().build();
   Note response = grafeasClient.createNote(parent, noteId, note);
 }
 

Parameters:

parent - The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created.

noteId - The ID to use for this note.

note - The note to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createNote

public final Note createNote(String parent,
                             String noteId,
                             Note note)

Creates a new note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String noteId = "";
   Note note = Note.newBuilder().build();
   Note response = grafeasClient.createNote(parent.toString(), noteId, note);
 }
 

Parameters:

parent - The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created.

noteId - The ID to use for this note.

note - The note to create.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createNote

public final Note createNote(CreateNoteRequest request)

Creates a new note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String noteId = "";
   Note note = Note.newBuilder().build();
   CreateNoteRequest request = CreateNoteRequest.newBuilder()
     .setParent(parent.toString())
     .setNoteId(noteId)
     .setNote(note)
     .build();
   Note response = grafeasClient.createNote(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createNoteCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateNoteRequest,Note> createNoteCallable()

Creates a new note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String noteId = "";
   Note note = Note.newBuilder().build();
   CreateNoteRequest request = CreateNoteRequest.newBuilder()
     .setParent(parent.toString())
     .setNoteId(noteId)
     .setNote(note)
     .build();
   ApiFuture<Note> future = grafeasClient.createNoteCallable().futureCall(request);
   // Do something
   Note response = future.get();
 }
 

batchCreateNotes

public final BatchCreateNotesResponse batchCreateNotes(ProjectName parent,
                                                       Map<String,Note> notes)

Creates new notes in batch.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Map<String, Note> notes = new HashMap<>();
   BatchCreateNotesResponse response = grafeasClient.batchCreateNotes(parent, notes);
 }
 

Parameters:

parent - The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created.

notes - The notes to create. Max allowed length is 1000.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

batchCreateNotes

public final BatchCreateNotesResponse batchCreateNotes(String parent,
                                                       Map<String,Note> notes)

Creates new notes in batch.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Map<String, Note> notes = new HashMap<>();
   BatchCreateNotesResponse response = grafeasClient.batchCreateNotes(parent.toString(), notes);
 }
 

Parameters:

parent - The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created.

notes - The notes to create. Max allowed length is 1000.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

batchCreateNotes

public final BatchCreateNotesResponse batchCreateNotes(BatchCreateNotesRequest request)

Creates new notes in batch.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Map<String, Note> notes = new HashMap<>();
   BatchCreateNotesRequest request = BatchCreateNotesRequest.newBuilder()
     .setParent(parent.toString())
     .putAllNotes(notes)
     .build();
   BatchCreateNotesResponse response = grafeasClient.batchCreateNotes(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

batchCreateNotesCallable

public final com.google.api.gax.rpc.UnaryCallable<BatchCreateNotesRequest,BatchCreateNotesResponse> batchCreateNotesCallable()

Creates new notes in batch.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Map<String, Note> notes = new HashMap<>();
   BatchCreateNotesRequest request = BatchCreateNotesRequest.newBuilder()
     .setParent(parent.toString())
     .putAllNotes(notes)
     .build();
   ApiFuture<BatchCreateNotesResponse> future = grafeasClient.batchCreateNotesCallable().futureCall(request);
   // Do something
   BatchCreateNotesResponse response = future.get();
 }
 

updateNote

public final Note updateNote(NoteName name,
                             Note note,
                             FieldMask updateMask)

Updates the specified note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   Note note = Note.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Note response = grafeasClient.updateNote(name, note, updateMask);
 }
 

Parameters:

name - The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.

note - The updated note.

updateMask - The fields to update.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateNote

public final Note updateNote(String name,
                             Note note,
                             FieldMask updateMask)

Updates the specified note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   Note note = Note.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Note response = grafeasClient.updateNote(name.toString(), note, updateMask);
 }
 

Parameters:

name - The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.

note - The updated note.

updateMask - The fields to update.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateNote

public final Note updateNote(UpdateNoteRequest request)

Updates the specified note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   Note note = Note.newBuilder().build();
   UpdateNoteRequest request = UpdateNoteRequest.newBuilder()
     .setName(name.toString())
     .setNote(note)
     .build();
   Note response = grafeasClient.updateNote(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateNoteCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateNoteRequest,Note> updateNoteCallable()

Updates the specified note.

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   Note note = Note.newBuilder().build();
   UpdateNoteRequest request = UpdateNoteRequest.newBuilder()
     .setName(name.toString())
     .setNote(note)
     .build();
   ApiFuture<Note> future = grafeasClient.updateNoteCallable().futureCall(request);
   // Do something
   Note response = future.get();
 }
 

listNoteOccurrences

public final GrafeasClient.ListNoteOccurrencesPagedResponse listNoteOccurrences(NoteName name,
                                                                                String filter)

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

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   String filter = "";
   for (Occurrence element : grafeasClient.listNoteOccurrences(name, filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.

filter - The filter expression.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listNoteOccurrences

public final GrafeasClient.ListNoteOccurrencesPagedResponse listNoteOccurrences(String name,
                                                                                String filter)

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

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   String filter = "";
   for (Occurrence element : grafeasClient.listNoteOccurrences(name.toString(), filter).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

name - The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.

filter - The filter expression.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listNoteOccurrences

public final GrafeasClient.ListNoteOccurrencesPagedResponse listNoteOccurrences(ListNoteOccurrencesRequest request)

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

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   ListNoteOccurrencesRequest request = ListNoteOccurrencesRequest.newBuilder()
     .setName(name.toString())
     .build();
   for (Occurrence element : grafeasClient.listNoteOccurrences(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listNoteOccurrencesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListNoteOccurrencesRequest,GrafeasClient.ListNoteOccurrencesPagedResponse> listNoteOccurrencesPagedCallable()

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

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   ListNoteOccurrencesRequest request = ListNoteOccurrencesRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<ListNoteOccurrencesPagedResponse> future = grafeasClient.listNoteOccurrencesPagedCallable().futureCall(request);
   // Do something
   for (Occurrence element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listNoteOccurrencesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListNoteOccurrencesRequest,ListNoteOccurrencesResponse> listNoteOccurrencesCallable()

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

Sample code:

 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   NoteName name = NoteName.of("[PROJECT]", "[NOTE]");
   ListNoteOccurrencesRequest request = ListNoteOccurrencesRequest.newBuilder()
     .setName(name.toString())
     .build();
   while (true) {
     ListNoteOccurrencesResponse response = grafeasClient.listNoteOccurrencesCallable().call(request);
     for (Occurrence element : response.getOccurrencesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException