API for working with the system policy. v1
Package
@google-cloud/binary-authorization!
Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of SystemPolicyV1Client.
Parameter
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
Property Value
Type | Description |
gax.GoogleAuth | |
descriptors
descriptors: Descriptors;
Property Value
Type | Description |
Descriptors | |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
Property Value
Type | Description |
{
[name: string]: Function;
} | |
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
Property Value
Type | Description |
{
[name: string]: gax.PathTemplate;
} | |
port
static get port(): number;
The port for this API service.
Property Value
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static get servicePath(): string;
The DNS address for this API service.
Property Value
systemPolicyV1Stub
systemPolicyV1Stub?: Promise<{
[name: string]: Function;
}>;
Property Value
Type | Description |
Promise<{
[name: string]: Function;
}> | |
warn
warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type | Description |
(code: string, message: string, warnType?: string) => void | |
Methods
attestorPath(project, attestor)
attestorPath(project: string, attestor: string): string;
Return a fully-qualified attestor resource name string.
Parameters
Name | Description |
project |
string
|
attestor |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
close()
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<void> | {Promise} A promise that resolves when the client is closed.
|
getProjectId()
getProjectId(): Promise<string>;
Returns
Type | Description |
Promise<string> | |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Returns
getSystemPolicy(request, options)
getSystemPolicy(request?: protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest, options?: CallOptions): Promise<[
protos.google.cloud.binaryauthorization.v1.IPolicy,
(protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.binaryauthorization.v1.IPolicy,
(protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest | undefined),
{} | undefined
]> | |
getSystemPolicy(request, options, callback)
getSystemPolicy(request: protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest, options: CallOptions, callback: Callback<protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest | null | undefined, {} | null | undefined>
|
Returns
getSystemPolicy(request, callback)
getSystemPolicy(request: protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest, callback: Callback<protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest
|
callback |
Callback<protos.google.cloud.binaryauthorization.v1.IPolicy, protos.google.cloud.binaryauthorization.v1.IGetSystemPolicyRequest | null | undefined, {} | null | undefined>
|
Returns
initialize()
initialize(): Promise<{
[name: string]: Function;
}>;
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<{
[name: string]: Function;
}> | {Promise} A promise that resolves to an authenticated service stub.
|
locationPolicyPath(location)
locationPolicyPath(location: string): string;
Return a fully-qualified locationPolicy resource name string.
Parameter
Name | Description |
location |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
matchAttestorFromAttestorName(attestorName)
matchAttestorFromAttestorName(attestorName: string): string | number;
Parse the attestor from Attestor resource.
Parameter
Name | Description |
attestorName |
string
A fully-qualified path representing Attestor resource.
|
Returns
Type | Description |
string | number | {string} A string representing the attestor.
|
matchLocationFromLocationPolicyName(locationPolicyName)
matchLocationFromLocationPolicyName(locationPolicyName: string): string | number;
Parse the location from LocationPolicy resource.
Parameter
Name | Description |
locationPolicyName |
string
A fully-qualified path representing location_policy resource.
|
Returns
Type | Description |
string | number | {string} A string representing the location.
|
matchProjectFromAttestorName(attestorName)
matchProjectFromAttestorName(attestorName: string): string | number;
Parse the project from Attestor resource.
Parameter
Name | Description |
attestorName |
string
A fully-qualified path representing Attestor resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromProjectName(projectName)
matchProjectFromProjectName(projectName: string): string | number;
Parse the project from Project resource.
Parameter
Name | Description |
projectName |
string
A fully-qualified path representing Project resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
matchProjectFromProjectPolicyName(projectPolicyName)
matchProjectFromProjectPolicyName(projectPolicyName: string): string | number;
Parse the project from ProjectPolicy resource.
Parameter
Name | Description |
projectPolicyName |
string
A fully-qualified path representing project_policy resource.
|
Returns
Type | Description |
string | number | {string} A string representing the project.
|
projectPath(project)
projectPath(project: string): string;
Return a fully-qualified project resource name string.
Parameter
Name | Description |
project |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|
projectPolicyPath(project)
projectPolicyPath(project: string): string;
Return a fully-qualified projectPolicy resource name string.
Parameter
Name | Description |
project |
string
|
Returns
Type | Description |
string | {string} Resource name string.
|