Provides a cross-region view of all Cloud KMS keys in a given Cloud project. v1
Package
@google-cloud/kms-inventoryConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of KeyDashboardServiceClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof gax.fallback
: loaded instance of |
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
keyDashboardServiceStub
keyDashboardServiceStub?: Promise<{
[name: string]: Function;
}>;
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
close()
close(): Promise<void>;
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. |
cryptoKeyPath(project, location, keyRing, cryptoKey)
cryptoKeyPath(project: string, location: string, keyRing: string, cryptoKey: string): string;
Return a fully-qualified cryptoKey resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
keyRing |
string
|
cryptoKey |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
cryptoKeyVersionPath(project, location, keyRing, cryptoKey, cryptoKeyVersion)
cryptoKeyVersionPath(project: string, location: string, keyRing: string, cryptoKey: string, cryptoKeyVersion: string): string;
Return a fully-qualified cryptoKeyVersion resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
keyRing |
string
|
cryptoKey |
string
|
cryptoKeyVersion |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
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 | |
---|---|
Type | Description |
void |
importJobPath(project, location, keyRing, importJob)
importJobPath(project: string, location: string, keyRing: string, importJob: string): string;
Return a fully-qualified importJob resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
keyRing |
string
|
importJob |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
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. |
keyRingPath(project, location, keyRing)
keyRingPath(project: string, location: string, keyRing: string): string;
Return a fully-qualified keyRing resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
keyRing |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
listCryptoKeys(request, options)
listCryptoKeys(request?: protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest, options?: CallOptions): Promise<[
protos.google.cloud.kms.v1.ICryptoKey[],
protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest | null,
protos.google.cloud.kms.inventory.v1.IListCryptoKeysResponse
]>;
Returns cryptographic keys managed by Cloud KMS in a given Cloud project. Note that this data is sourced from snapshots, meaning it may not completely reflect the actual state of key metadata at call time.
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.kms.v1.ICryptoKey[],
protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest | null,
protos.google.cloud.kms.inventory.v1.IListCryptoKeysResponse
]> | {Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using |
listCryptoKeys(request, options, callback)
listCryptoKeys(request: protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest, protos.google.cloud.kms.inventory.v1.IListCryptoKeysResponse | null | undefined, protos.google.cloud.kms.v1.ICryptoKey>): void;
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest
|
options |
CallOptions
|
callback |
PaginationCallback<protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest, protos.google.cloud.kms.inventory.v1.IListCryptoKeysResponse | null | undefined, protos.google.cloud.kms.v1.ICryptoKey>
|
Returns | |
---|---|
Type | Description |
void |
listCryptoKeys(request, callback)
listCryptoKeys(request: protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest, callback: PaginationCallback<protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest, protos.google.cloud.kms.inventory.v1.IListCryptoKeysResponse | null | undefined, protos.google.cloud.kms.v1.ICryptoKey>): void;
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest
|
callback |
PaginationCallback<protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest, protos.google.cloud.kms.inventory.v1.IListCryptoKeysResponse | null | undefined, protos.google.cloud.kms.v1.ICryptoKey>
|
Returns | |
---|---|
Type | Description |
void |
listCryptoKeysAsync(request, options)
listCryptoKeysAsync(request?: protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.kms.v1.ICryptoKey>;
Equivalent to listCryptoKeys
, but returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<protos.google.cloud.kms.v1.ICryptoKey> | {Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
/**
* 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 Google Cloud project for which to retrieve key metadata, in
* the format `projects/*`
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of keys to return. The service may return
* fewer than this value. If unspecified, at most 1000 keys will be returned.
* The maximum value is 1000; values above 1000 will be coerced to 1000.
*/
// const pageSize = 1234
/**
* Optional. Pass this into a subsequent request in order to receive the next
* page of results.
*/
// const pageToken = 'abc123'
// Imports the Inventory library
const {KeyDashboardServiceClient} = require('@google-cloud/kms-inventory').v1;
// Instantiates a client
const inventoryClient = new KeyDashboardServiceClient();
async function callListCryptoKeys() {
// Construct request
const request = {
parent,
};
// Run request
const iterable = await inventoryClient.listCryptoKeysAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListCryptoKeys();
listCryptoKeysStream(request, options)
listCryptoKeysStream(request?: protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest, options?: CallOptions): Transform;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters | |
---|---|
Name | Description |
request |
protos.google.cloud.kms.inventory.v1.IListCryptoKeysRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Transform | {Stream} An object stream which emits an object representing 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 |
matchCryptoKeyFromCryptoKeyName(cryptoKeyName)
matchCryptoKeyFromCryptoKeyName(cryptoKeyName: string): string | number;
Parse the crypto_key from CryptoKey resource.
Parameter | |
---|---|
Name | Description |
cryptoKeyName |
string
A fully-qualified path representing CryptoKey resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the crypto_key. |
matchCryptoKeyFromCryptoKeyVersionName(cryptoKeyVersionName)
matchCryptoKeyFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number;
Parse the crypto_key from CryptoKeyVersion resource.
Parameter | |
---|---|
Name | Description |
cryptoKeyVersionName |
string
A fully-qualified path representing CryptoKeyVersion resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the crypto_key. |
matchCryptoKeyFromProjectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName)
matchCryptoKeyFromProjectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName: string): string | number;
Parse the crypto_key from ProjectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummary resource.
Parameter | |
---|---|
Name | Description |
projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName |
string
A fully-qualified path representing project_location_key_ring_crypto_key_crypto_key_version_protectedResourcesSummary resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the crypto_key. |
matchCryptoKeyFromProjectLocationKeyRingCryptoKeyProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyProtectedResourcesSummaryName)
matchCryptoKeyFromProjectLocationKeyRingCryptoKeyProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyProtectedResourcesSummaryName: string): string | number;
Parse the crypto_key from ProjectLocationKeyRingCryptoKeyProtectedResourcesSummary resource.
Parameter | |
---|---|
Name | Description |
projectLocationKeyRingCryptoKeyProtectedResourcesSummaryName |
string
A fully-qualified path representing project_location_key_ring_crypto_key_protectedResourcesSummary resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the crypto_key. |
matchCryptoKeyFromPublicKeyName(publicKeyName)
matchCryptoKeyFromPublicKeyName(publicKeyName: string): string | number;
Parse the crypto_key from PublicKey resource.
Parameter | |
---|---|
Name | Description |
publicKeyName |
string
A fully-qualified path representing PublicKey resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the crypto_key. |
matchCryptoKeyVersionFromCryptoKeyVersionName(cryptoKeyVersionName)
matchCryptoKeyVersionFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number;
Parse the crypto_key_version from CryptoKeyVersion resource.
Parameter | |
---|---|
Name | Description |
cryptoKeyVersionName |
string
A fully-qualified path representing CryptoKeyVersion resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the crypto_key_version. |
matchCryptoKeyVersionFromProjectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName)
matchCryptoKeyVersionFromProjectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName: string): string | number;
Parse the crypto_key_version from ProjectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummary resource.
Parameter | |
---|---|
Name | Description |
projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName |
string
A fully-qualified path representing project_location_key_ring_crypto_key_crypto_key_version_protectedResourcesSummary resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the crypto_key_version. |
matchCryptoKeyVersionFromPublicKeyName(publicKeyName)
matchCryptoKeyVersionFromPublicKeyName(publicKeyName: string): string | number;
Parse the crypto_key_version from PublicKey resource.
Parameter | |
---|---|
Name | Description |
publicKeyName |
string
A fully-qualified path representing PublicKey resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the crypto_key_version. |
matchImportJobFromImportJobName(importJobName)
matchImportJobFromImportJobName(importJobName: string): string | number;
Parse the import_job from ImportJob resource.
Parameter | |
---|---|
Name | Description |
importJobName |
string
A fully-qualified path representing ImportJob resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the import_job. |
matchKeyRingFromCryptoKeyName(cryptoKeyName)
matchKeyRingFromCryptoKeyName(cryptoKeyName: string): string | number;
Parse the key_ring from CryptoKey resource.
Parameter | |
---|---|
Name | Description |
cryptoKeyName |
string
A fully-qualified path representing CryptoKey resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the key_ring. |
matchKeyRingFromCryptoKeyVersionName(cryptoKeyVersionName)
matchKeyRingFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number;
Parse the key_ring from CryptoKeyVersion resource.
Parameter | |
---|---|
Name | Description |
cryptoKeyVersionName |
string
A fully-qualified path representing CryptoKeyVersion resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the key_ring. |
matchKeyRingFromImportJobName(importJobName)
matchKeyRingFromImportJobName(importJobName: string): string | number;
Parse the key_ring from ImportJob resource.
Parameter | |
---|---|
Name | Description |
importJobName |
string
A fully-qualified path representing ImportJob resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the key_ring. |
matchKeyRingFromKeyRingName(keyRingName)
matchKeyRingFromKeyRingName(keyRingName: string): string | number;
Parse the key_ring from KeyRing resource.
Parameter | |
---|---|
Name | Description |
keyRingName |
string
A fully-qualified path representing KeyRing resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the key_ring. |
matchKeyRingFromProjectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName)
matchKeyRingFromProjectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName: string): string | number;
Parse the key_ring from ProjectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummary resource.
Parameter | |
---|---|
Name | Description |
projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName |
string
A fully-qualified path representing project_location_key_ring_crypto_key_crypto_key_version_protectedResourcesSummary resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the key_ring. |
matchKeyRingFromProjectLocationKeyRingCryptoKeyProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyProtectedResourcesSummaryName)
matchKeyRingFromProjectLocationKeyRingCryptoKeyProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyProtectedResourcesSummaryName: string): string | number;
Parse the key_ring from ProjectLocationKeyRingCryptoKeyProtectedResourcesSummary resource.
Parameter | |
---|---|
Name | Description |
projectLocationKeyRingCryptoKeyProtectedResourcesSummaryName |
string
A fully-qualified path representing project_location_key_ring_crypto_key_protectedResourcesSummary resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the key_ring. |
matchKeyRingFromPublicKeyName(publicKeyName)
matchKeyRingFromPublicKeyName(publicKeyName: string): string | number;
Parse the key_ring from PublicKey resource.
Parameter | |
---|---|
Name | Description |
publicKeyName |
string
A fully-qualified path representing PublicKey resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the key_ring. |
matchLocationFromCryptoKeyName(cryptoKeyName)
matchLocationFromCryptoKeyName(cryptoKeyName: string): string | number;
Parse the location from CryptoKey resource.
Parameter | |
---|---|
Name | Description |
cryptoKeyName |
string
A fully-qualified path representing CryptoKey resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromCryptoKeyVersionName(cryptoKeyVersionName)
matchLocationFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number;
Parse the location from CryptoKeyVersion resource.
Parameter | |
---|---|
Name | Description |
cryptoKeyVersionName |
string
A fully-qualified path representing CryptoKeyVersion resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromImportJobName(importJobName)
matchLocationFromImportJobName(importJobName: string): string | number;
Parse the location from ImportJob resource.
Parameter | |
---|---|
Name | Description |
importJobName |
string
A fully-qualified path representing ImportJob resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromKeyRingName(keyRingName)
matchLocationFromKeyRingName(keyRingName: string): string | number;
Parse the location from KeyRing resource.
Parameter | |
---|---|
Name | Description |
keyRingName |
string
A fully-qualified path representing KeyRing resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName)
matchLocationFromProjectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName: string): string | number;
Parse the location from ProjectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummary resource.
Parameter | |
---|---|
Name | Description |
projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName |
string
A fully-qualified path representing project_location_key_ring_crypto_key_crypto_key_version_protectedResourcesSummary resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromProjectLocationKeyRingCryptoKeyProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyProtectedResourcesSummaryName)
matchLocationFromProjectLocationKeyRingCryptoKeyProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyProtectedResourcesSummaryName: string): string | number;
Parse the location from ProjectLocationKeyRingCryptoKeyProtectedResourcesSummary resource.
Parameter | |
---|---|
Name | Description |
projectLocationKeyRingCryptoKeyProtectedResourcesSummaryName |
string
A fully-qualified path representing project_location_key_ring_crypto_key_protectedResourcesSummary resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchLocationFromPublicKeyName(publicKeyName)
matchLocationFromPublicKeyName(publicKeyName: string): string | number;
Parse the location from PublicKey resource.
Parameter | |
---|---|
Name | Description |
publicKeyName |
string
A fully-qualified path representing PublicKey resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the location. |
matchProjectFromCryptoKeyName(cryptoKeyName)
matchProjectFromCryptoKeyName(cryptoKeyName: string): string | number;
Parse the project from CryptoKey resource.
Parameter | |
---|---|
Name | Description |
cryptoKeyName |
string
A fully-qualified path representing CryptoKey resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromCryptoKeyVersionName(cryptoKeyVersionName)
matchProjectFromCryptoKeyVersionName(cryptoKeyVersionName: string): string | number;
Parse the project from CryptoKeyVersion resource.
Parameter | |
---|---|
Name | Description |
cryptoKeyVersionName |
string
A fully-qualified path representing CryptoKeyVersion resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromImportJobName(importJobName)
matchProjectFromImportJobName(importJobName: string): string | number;
Parse the project from ImportJob resource.
Parameter | |
---|---|
Name | Description |
importJobName |
string
A fully-qualified path representing ImportJob resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromKeyRingName(keyRingName)
matchProjectFromKeyRingName(keyRingName: string): string | number;
Parse the project from KeyRing resource.
Parameter | |
---|---|
Name | Description |
keyRingName |
string
A fully-qualified path representing KeyRing resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName)
matchProjectFromProjectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName: string): string | number;
Parse the project from ProjectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummary resource.
Parameter | |
---|---|
Name | Description |
projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryName |
string
A fully-qualified path representing project_location_key_ring_crypto_key_crypto_key_version_protectedResourcesSummary resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
matchProjectFromProjectLocationKeyRingCryptoKeyProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyProtectedResourcesSummaryName)
matchProjectFromProjectLocationKeyRingCryptoKeyProtectedResourcesSummaryName(projectLocationKeyRingCryptoKeyProtectedResourcesSummaryName: string): string | number;
Parse the project from ProjectLocationKeyRingCryptoKeyProtectedResourcesSummary resource.
Parameter | |
---|---|
Name | Description |
projectLocationKeyRingCryptoKeyProtectedResourcesSummaryName |
string
A fully-qualified path representing project_location_key_ring_crypto_key_protectedResourcesSummary 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. |
matchProjectFromPublicKeyName(publicKeyName)
matchProjectFromPublicKeyName(publicKeyName: string): string | number;
Parse the project from PublicKey resource.
Parameter | |
---|---|
Name | Description |
publicKeyName |
string
A fully-qualified path representing PublicKey resource. |
Returns | |
---|---|
Type | Description |
string | number | {string} A string representing the project. |
projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryPath(project, location, keyRing, cryptoKey, cryptoKeyVersion)
projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummaryPath(project: string, location: string, keyRing: string, cryptoKey: string, cryptoKeyVersion: string): string;
Return a fully-qualified projectLocationKeyRingCryptoKeyCryptoKeyVersionProtectedResourcesSummary resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
keyRing |
string
|
cryptoKey |
string
|
cryptoKeyVersion |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
projectLocationKeyRingCryptoKeyProtectedResourcesSummaryPath(project, location, keyRing, cryptoKey)
projectLocationKeyRingCryptoKeyProtectedResourcesSummaryPath(project: string, location: string, keyRing: string, cryptoKey: string): string;
Return a fully-qualified projectLocationKeyRingCryptoKeyProtectedResourcesSummary resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
keyRing |
string
|
cryptoKey |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |
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. |
publicKeyPath(project, location, keyRing, cryptoKey, cryptoKeyVersion)
publicKeyPath(project: string, location: string, keyRing: string, cryptoKey: string, cryptoKeyVersion: string): string;
Return a fully-qualified publicKey resource name string.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
keyRing |
string
|
cryptoKey |
string
|
cryptoKeyVersion |
string
|
Returns | |
---|---|
Type | Description |
string | {string} Resource name string. |