Asset service definition. v1p5beta1
Package
@google-cloud/assetConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of AssetServiceClient.
opts
ClientOptions
gaxInstance
typeof gax
| typeof fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new AssetServiceClient({fallback: 'rest'}, gax); ```
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
assetServiceStub
assetServiceStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
auth
auth
:
gax
.
GoogleAuth
;
descriptors
descriptors
:
Descriptors
;
innerApiCalls
innerApiCalls
:
{
[
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
accessLevelPath(accessPolicy, accessLevel)
accessLevelPath
(
accessPolicy
:
string
,
accessLevel
:
string
)
:
string
;
Return a fully-qualified accessLevel resource name string.
accessPolicy
string
accessLevel
string
string
{string} Resource name string.
accessPolicyPath(accessPolicy)
accessPolicyPath
(
accessPolicy
:
string
)
:
string
;
Return a fully-qualified accessPolicy resource name string.
accessPolicy
string
string
{string} Resource name string.
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.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
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.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
listAssets(request, options)
listAssets
(
request
?:
protos
.
google
.
cloud
.
asset
.
v1p5beta1
.
IListAssetsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
asset
.
v1p5beta1
.
IAsset
[],
protos
.
google
.
cloud
.
asset
.
v1p5beta1
.
IListAssetsRequest
|
null
,
protos
.
google
.
cloud
.
asset
.
v1p5beta1
.
IListAssetsResponse
]>;
Lists assets with time and resource types and returns paged results in response.
request
options
Promise
<[ protos.google.cloud.asset.v1p5beta1.IAsset
[], protos.google.cloud.asset.v1p5beta1.IListAssetsRequest
| null, protos.google.cloud.asset.v1p5beta1.IListAssetsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of Asset
. 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 listAssetsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listAssets(request, options, callback)
listAssets
(
request
:
protos
.
google
.
cloud
.
asset
.
v1p5beta1
.
IListAssetsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
asset
.
v1p5beta1
.
IListAssetsRequest
,
protos
.
google
.
cloud
.
asset
.
v1p5beta1
.
IListAssetsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
asset
.
v1p5beta1
.
IAsset
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.asset.v1p5beta1.IListAssetsRequest
, protos.google.cloud.asset.v1p5beta1.IListAssetsResponse
| null | undefined, protos.google.cloud.asset.v1p5beta1.IAsset
>
void
listAssets(request, callback)
listAssets
(
request
:
protos
.
google
.
cloud
.
asset
.
v1p5beta1
.
IListAssetsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
asset
.
v1p5beta1
.
IListAssetsRequest
,
protos
.
google
.
cloud
.
asset
.
v1p5beta1
.
IListAssetsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
asset
.
v1p5beta1
.
IAsset
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.asset.v1p5beta1.IListAssetsRequest
, protos.google.cloud.asset.v1p5beta1.IListAssetsResponse
| null | undefined, protos.google.cloud.asset.v1p5beta1.IAsset
>
void
listAssetsAsync(request, options)
listAssetsAsync
(
request
?:
protos
.
google
.
cloud
.
asset
.
v1p5beta1
.
IListAssetsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
asset
.
v1p5beta1
.
IAsset
> ;
Equivalent to listAssets
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.asset.v1p5beta1.IAsset
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing Asset . 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.
/**
* 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. Name of the organization or project the assets belong to. Format:
* "organizations/[organization-number]" (such as "organizations/123"),
* "projects/[project-id]" (such as "projects/my-project-id"), or
* "projects/[project-number]" (such as "projects/12345").
*/
// const parent = 'abc123'
/**
* Timestamp to take an asset snapshot. This can only be set to a timestamp
* between the current time and the current time minus 35 days (inclusive).
* 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.
*/
// const readTime = {}
/**
* A list of asset types to take a snapshot for. For example:
* "compute.googleapis.com/Disk".
* Regular expression is also supported. For example:
* * "compute.googleapis.com.*" snapshots resources whose asset type starts
* with "compute.googleapis.com".
* * ".*Instance" snapshots resources whose asset type ends with "Instance".
* * ".*Instance.*" snapshots resources whose asset type contains "Instance".
* See RE2 (https://github.com/google/re2/wiki/Syntax) for all supported
* regular expression syntax. If the regular expression does not match any
* supported asset type, an INVALID_ARGUMENT error will be returned.
* If specified, only matching assets will be returned, otherwise, it will
* snapshot all asset types. See Introduction to Cloud Asset
* Inventory (https://cloud.google.com/asset-inventory/docs/overview)
* for all supported asset types.
*/
// const assetTypes = ['abc','def']
/**
* Asset content type. If not specified, no content but the asset name will
* be returned.
*/
// const contentType = {}
/**
* The maximum number of assets to be returned in a single response. Default
* is 100, minimum is 1, and maximum is 1000.
*/
// const pageSize = 1234
/**
* 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.
*/
// const pageToken = 'abc123'
// Imports the Asset library
const
{
AssetServiceClient
}
=
require
(
'asset'
).
v1p5beta1
;
// Instantiates a client
const
assetClient
=
new
AssetServiceClient
();
async
function
callListAssets
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
assetClient
.
listAssetsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListAssets
();
listAssetsStream(request, options)
listAssetsStream
(
request
?:
protos
.
google
.
cloud
.
asset
.
v1p5beta1
.
IListAssetsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing Asset
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 listAssetsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
matchAccessLevelFromAccessLevelName(accessLevelName)
matchAccessLevelFromAccessLevelName
(
accessLevelName
:
string
)
:
string
|
number
;
Parse the access_level from AccessLevel resource.
accessLevelName
string
A fully-qualified path representing AccessLevel resource.
string | number
{string} A string representing the access_level.
matchAccessPolicyFromAccessLevelName(accessLevelName)
matchAccessPolicyFromAccessLevelName
(
accessLevelName
:
string
)
:
string
|
number
;
Parse the access_policy from AccessLevel resource.
accessLevelName
string
A fully-qualified path representing AccessLevel resource.
string | number
{string} A string representing the access_policy.
matchAccessPolicyFromAccessPolicyName(accessPolicyName)
matchAccessPolicyFromAccessPolicyName
(
accessPolicyName
:
string
)
:
string
|
number
;
Parse the access_policy from AccessPolicy resource.
accessPolicyName
string
A fully-qualified path representing AccessPolicy resource.
string | number
{string} A string representing the access_policy.
matchAccessPolicyFromServicePerimeterName(servicePerimeterName)
matchAccessPolicyFromServicePerimeterName
(
servicePerimeterName
:
string
)
:
string
|
number
;
Parse the access_policy from ServicePerimeter resource.
servicePerimeterName
string
A fully-qualified path representing ServicePerimeter resource.
string | number
{string} A string representing the access_policy.
matchServicePerimeterFromServicePerimeterName(servicePerimeterName)
matchServicePerimeterFromServicePerimeterName
(
servicePerimeterName
:
string
)
:
string
|
number
;
Parse the service_perimeter from ServicePerimeter resource.
servicePerimeterName
string
A fully-qualified path representing ServicePerimeter resource.
string | number
{string} A string representing the service_perimeter.
servicePerimeterPath(accessPolicy, servicePerimeter)
servicePerimeterPath
(
accessPolicy
:
string
,
servicePerimeter
:
string
)
:
string
;
Return a fully-qualified servicePerimeter resource name string.
accessPolicy
string
servicePerimeter
string
string
{string} Resource name string.
