Constructor
new BinauthzManagementServiceV1Beta1Client(optionsopt, gaxInstanceopt)
Construct an instance of BinauthzManagementServiceV1Beta1Client.
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 - same as servicePath(), exists for compatibility reasons.
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
attestorPath(project, attestor) → {string}
Return a fully-qualified attestor resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string | |
attestor |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
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. |
listAttestorsAsync(request, optionsopt) → {Object}
Equivalent to listAttestors
, 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 Attestor. 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.
*/
/**
* Required. The resource name of the project associated with the
* attestors google.cloud.binaryauthorization.v1beta1.Attestor, in the format `projects/*`.
*/
// const parent = 'abc123'
/**
* Requested page size. The server may return fewer results than requested. If
* unspecified, the server will pick an appropriate default.
*/
// const pageSize = 1234
/**
* A token identifying a page of results the server should return. Typically,
* this is the value of ListAttestorsResponse.next_page_token google.cloud.binaryauthorization.v1beta1.ListAttestorsResponse.next_page_token returned
* from the previous call to the `ListAttestors` method.
*/
// const pageToken = 'abc123'
// Imports the Binaryauthorization library
const {BinauthzManagementServiceV1Beta1Client} = require('@google-cloud/binary-authorization').v1beta1;
// Instantiates a client
const binaryauthorizationClient = new BinauthzManagementServiceV1Beta1Client();
async function callListAttestors() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await binaryauthorizationClient.listAttestorsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListAttestors();
listAttestorsStream(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 Attestor 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 |
locationPolicyPath(location) → {string}
Return a fully-qualified locationPolicy resource name string.
Parameters:
Name | Type | Description |
---|---|---|
location |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
matchAttestorFromAttestorName(attestorName) → {string}
Parse the attestor from Attestor resource.
Parameters:
Name | Type | Description |
---|---|---|
attestorName |
string |
A fully-qualified path representing Attestor resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the attestor. |
matchLocationFromLocationPolicyName(locationPolicyName) → {string}
Parse the location from LocationPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
locationPolicyName |
string |
A fully-qualified path representing location_policy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the location. |
matchProjectFromAttestorName(attestorName) → {string}
Parse the project from Attestor resource.
Parameters:
Name | Type | Description |
---|---|---|
attestorName |
string |
A fully-qualified path representing Attestor resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectName(projectName) → {string}
Parse the project from Project resource.
Parameters:
Name | Type | Description |
---|---|---|
projectName |
string |
A fully-qualified path representing Project resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
matchProjectFromProjectPolicyName(projectPolicyName) → {string}
Parse the project from ProjectPolicy resource.
Parameters:
Name | Type | Description |
---|---|---|
projectPolicyName |
string |
A fully-qualified path representing project_policy resource. |
Returns:
Type | Description |
---|---|
string |
A string representing the project. |
projectPath(project) → {string}
Return a fully-qualified project resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |
projectPolicyPath(project) → {string}
Return a fully-qualified projectPolicy resource name string.
Parameters:
Name | Type | Description |
---|---|---|
project |
string |
Returns:
Type | Description |
---|---|
string |
Resource name string. |