The configuration object. See the subsequent
parameters for more details.
Properties
Name
Type
Attributes
Description
credentials
object
<optional>
Credentials object.
Properties
Name
Type
Attributes
Description
client_email
string
<optional>
private_key
string
<optional>
email
string
<optional>
Account email address. Required when
using a .pem or .p12 keyFilename.
keyFilename
string
<optional>
Full path to the a .json, .pem, or
.p12 key downloaded from the Google Developers Console. If you provide
a path to a JSON file, the projectId option below is not necessary.
NOTE: .pem and .p12 require you to specify options.email as well.
port
number
<optional>
The port on which to connect to
the remote host.
projectId
string
<optional>
The project ID from the Google
Developer's Console, e.g. 'grape-spaceship-123'. We will also check
the environment variable GCLOUD_PROJECT for your project ID. If your
app is running in an environment which supports
Application Default Credentials,
your project ID will be detected automatically.
apiEndpoint
string
<optional>
The domain name of the
API remote host.
Members
(static) apiEndpoint
The DNS address for this API service - same as servicePath(),
exists for compatibility reasons.
(static) port
The port for this API service.
(static) scopes
The scopes needed to make gRPC calls for every method defined
in this service.
(static) servicePath
The DNS address for this API service.
Methods
close()
Terminate the GRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
getProjectId(callback)
Return the project ID used by this class.
Parameters:
Name
Type
Description
callback
function
the callback to
be called with the current 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.
listAssets(request, optionsopt) → {Promise}
Lists assets with time and resource types and returns paged results in
response.
Parameters:
Name
Type
Attributes
Description
request
Object
The request object that will be sent.
Properties
Name
Type
Description
parent
string
Required. Name of the organization or project the assets belong to. Format:
"organizations/[organization-number]" (such as "organizations/123"),
"projects/[project-number]" (such as "projects/my-project-id"), or
"projects/[project-id]" (such as "projects/12345").
Timestamp to take an asset snapshot. This can only be set to a timestamp
between 2018-10-02 UTC (inclusive) and the current time. If not specified,
the current time will be used. Due to delays in resource data collection
and indexing, there is a volatile window during which running the same
query may get different results.
assetTypes
Array.<string>
A list of asset types of which to take a snapshot for. For example:
"compute.googleapis.com/Disk". If specified, only matching assets will be
returned. See Introduction to Cloud Asset
Inventory
for all supported asset types.
Asset content type. If not specified, no content but the asset name will
be returned.
pageSize
number
The maximum number of assets to be returned in a single response. Default
is 100, minimum is 1, and maximum is 1000.
pageToken
string
The next_page_token returned from the previous ListAssetsResponse, or
unspecified for the first ListAssetsRequest. It is a continuation of a
prior ListAssets call, and the API should return the next page of assets.
Equivalent to listAssets, but returns an iterable object.
for-await-of syntax is used with the iterable to recursively get response element on-demand.
Parameters:
Name
Type
Attributes
Description
request
Object
The request object that will be sent.
Properties
Name
Type
Description
parent
string
Required. Name of the organization or project the assets belong to. Format:
"organizations/[organization-number]" (such as "organizations/123"),
"projects/[project-number]" (such as "projects/my-project-id"), or
"projects/[project-id]" (such as "projects/12345").
Timestamp to take an asset snapshot. This can only be set to a timestamp
between 2018-10-02 UTC (inclusive) and the current time. If not specified,
the current time will be used. Due to delays in resource data collection
and indexing, there is a volatile window during which running the same
query may get different results.
assetTypes
Array.<string>
A list of asset types of which to take a snapshot for. For example:
"compute.googleapis.com/Disk". If specified, only matching assets will be
returned. See Introduction to Cloud Asset
Inventory
for all supported asset types.
Asset content type. If not specified, no content but the asset name will
be returned.
pageSize
number
The maximum number of assets to be returned in a single response. Default
is 100, minimum is 1, and maximum is 1000.
pageToken
string
The next_page_token returned from the previous ListAssetsResponse, or
unspecified for the first ListAssetsRequest. It is a continuation of a
prior ListAssets call, and the API should return the next page of assets.
Equivalent to listAssets, but returns a NodeJS Stream object.
This fetches the paged responses for listAssets continuously
and invokes the callback registered for 'data' event for each element in the
responses.
The returned object has 'end' method when no more elements are required.
autoPaginate option will be ignored.
Parameters:
Name
Type
Attributes
Description
request
Object
The request object that will be sent.
Properties
Name
Type
Description
parent
string
Required. Name of the organization or project the assets belong to. Format:
"organizations/[organization-number]" (such as "organizations/123"),
"projects/[project-number]" (such as "projects/my-project-id"), or
"projects/[project-id]" (such as "projects/12345").
Timestamp to take an asset snapshot. This can only be set to a timestamp
between 2018-10-02 UTC (inclusive) and the current time. If not specified,
the current time will be used. Due to delays in resource data collection
and indexing, there is a volatile window during which running the same
query may get different results.
assetTypes
Array.<string>
A list of asset types of which to take a snapshot for. For example:
"compute.googleapis.com/Disk". If specified, only matching assets will be
returned. See Introduction to Cloud Asset
Inventory
for all supported asset types.
Asset content type. If not specified, no content but the asset name will
be returned.
pageSize
number
The maximum number of assets to be returned in a single response. Default
is 100, minimum is 1, and maximum is 1000.
pageToken
string
The next_page_token returned from the previous ListAssetsResponse, or
unspecified for the first ListAssetsRequest. It is a continuation of a
prior ListAssets call, and the API should return the next page of assets.