Constructor
new SystemPolicyV1Beta1Client(optionsopt, gaxInstanceopt)
Construct an instance of SystemPolicyV1Beta1Client.
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. |
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. |