Constructor
new GrafeasV1Beta1Client(optionsopt, gaxInstanceopt)
Construct an instance of GrafeasV1Beta1Client.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
<optional> |
The configuration object. The options accepted by the constructor are described in detail in this document. The common options are: Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||
gaxInstance |
gax |
<optional> |
loaded instance of |
Members
apiEndpoint
The DNS address for this API service.
apiEndpoint
The DNS address for this API service - same as servicePath.
port
The port for this API service.
scopes
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
The DNS address for this API service.
Methods
close() → {Promise}
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves when the client is closed. |
getProjectId() → {Promise}
Return the project ID used by this class.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to string containing the project ID. |
initialize() → {Promise}
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Returns:
Type | Description |
---|---|
Promise |
A promise that resolves to an authenticated service stub. |
listNoteOccurrencesAsync(request, optionsopt) → {Object}
Equivalent to listNoteOccurrences
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Occurrence. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The name of the note to list occurrences for in the form of
* `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
*/
// const name = 'abc123'
/**
* The filter expression.
*/
// const filter = 'abc123'
/**
* Number of occurrences to return in the list.
*/
// const pageSize = 1234
/**
* Token to provide to skip to a particular spot in the list.
*/
// const pageToken = 'abc123'
// Imports the Containeranalysis library
const {GrafeasV1Beta1Client} = require('@google-cloud/containeranalysis').v1beta1;
// Instantiates a client
const containeranalysisClient = new GrafeasV1Beta1Client();
async function callListNoteOccurrences() {
// Construct request
const request = {
};
// Run request
const iterable = containeranalysisClient.listNoteOccurrencesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListNoteOccurrences();
listNoteOccurrencesStream(request, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing Occurrence on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |
listNotesAsync(request, optionsopt) → {Object}
Equivalent to listNotes
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Note. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The name of the project to list notes for in the form of
* `projects/[PROJECT_ID]`.
*/
// const parent = 'abc123'
/**
* The filter expression.
*/
// const filter = 'abc123'
/**
* Number of notes to return in the list.
*/
// const pageSize = 1234
/**
* Token to provide to skip to a particular spot in the list.
*/
// const pageToken = 'abc123'
// Imports the Containeranalysis library
const {GrafeasV1Beta1Client} = require('@google-cloud/containeranalysis').v1beta1;
// Instantiates a client
const containeranalysisClient = new GrafeasV1Beta1Client();
async function callListNotes() {
// Construct request
const request = {
};
// Run request
const iterable = containeranalysisClient.listNotesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListNotes();
listNotesStream(request, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing Note on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |
listOccurrencesAsync(request, optionsopt) → {Object}
Equivalent to listOccurrences
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Object |
An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Occurrence. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
Example
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The name of the project to list occurrences for in the form of
* `projects/[PROJECT_ID]`.
*/
// const parent = 'abc123'
/**
* The filter expression.
*/
// const filter = 'abc123'
/**
* Number of occurrences to return in the list.
*/
// const pageSize = 1234
/**
* Token to provide to skip to a particular spot in the list.
*/
// const pageToken = 'abc123'
// Imports the Containeranalysis library
const {GrafeasV1Beta1Client} = require('@google-cloud/containeranalysis').v1beta1;
// Instantiates a client
const containeranalysisClient = new GrafeasV1Beta1Client();
async function callListOccurrences() {
// Construct request
const request = {
};
// Run request
const iterable = containeranalysisClient.listOccurrencesAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListOccurrences();
listOccurrencesStream(request, optionsopt) → {Stream}
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
request |
Object |
The request object that will be sent. Properties
|
||||||||||||||||
options |
object |
<optional> |
Call options. See CallOptions for more details. |
Returns:
Type | Description |
---|---|
Stream |
An object stream which emits an object representing Occurrence on 'data' event.
The client library will perform auto-pagination by default: it will call the API as many
times as needed. Note that it can affect your quota.
We recommend using |