Asset service definition. v1p5beta1
Package
@google-cloud/assetConstructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of AssetServiceClient.
Name | Description |
opts |
ClientOptions
|
Properties
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Type | Description |
string |
assetServiceStub
assetServiceStub?: Promise<{
[name: string]: Function;
}>;
Type | Description |
Promise<{ [name: string]: Function; }> |
auth
auth: gax.GoogleAuth;
Type | Description |
gax.GoogleAuth |
descriptors
descriptors: Descriptors;
Type | Description |
Descriptors |
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
Type | Description |
{ [name: string]: Function; } |
pathTemplates
pathTemplates: {
[name: string]: gax.PathTemplate;
};
Type | Description |
{ [name: string]: gax.PathTemplate; } |
port
static get port(): number;
The port for this API service.
Type | Description |
number |
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
Type | Description |
string[] |
servicePath
static get servicePath(): string;
The DNS address for this API service.
Type | Description |
string |
warn
warn: (code: string, message: string, warnType?: string) => void;
Type | Description |
(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.
Name | Description |
accessPolicy |
string
|
accessLevel |
string
|
Type | Description |
string | {string} Resource name string. |
accessPolicyPath(accessPolicy)
accessPolicyPath(accessPolicy: string): string;
Return a fully-qualified accessPolicy resource name string.
Name | Description |
accessPolicy |
string
|
Type | Description |
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.
Type | Description |
Promise<void> | {Promise} A promise that resolves when the client is closed. |
getProjectId()
getProjectId(): Promise<string>;
Type | Description |
Promise<string> |
getProjectId(callback)
getProjectId(callback: Callback<string, undefined, undefined>): void;
Name | Description |
callback |
Callback<string, undefined, undefined>
|
Type | Description |
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.
Type | Description |
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]>;
Name | Description |
request |
protos.google.cloud.asset.v1p5beta1.IListAssetsRequest
|
options |
CallOptions
|
Type | Description |
Promise<[protos.google.cloud.asset.v1p5beta1.IAsset[], protos.google.cloud.asset.v1p5beta1.IListAssetsRequest | null, protos.google.cloud.asset.v1p5beta1.IListAssetsResponse]> |
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;
Name | Description |
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>
|
Type | Description |
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;
Name | Description |
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>
|
Type | Description |
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.
Name | Description |
request |
protos.google.cloud.asset.v1p5beta1.IListAssetsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
AsyncIterable<protos.google.cloud.asset.v1p5beta1.IAsset> | {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 [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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples. |
const iterable = client.listAssetsAsync(request); for await (const response of iterable) { // process response }
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.
Name | Description |
request |
protos.google.cloud.asset.v1p5beta1.IListAssetsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Type | Description |
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 |
matchAccessLevelFromAccessLevelName(accessLevelName)
matchAccessLevelFromAccessLevelName(accessLevelName: string): string | number;
Parse the access_level from AccessLevel resource.
Name | Description |
accessLevelName |
string
A fully-qualified path representing AccessLevel resource. |
Type | Description |
string | number | {string} A string representing the access_level. |
matchAccessPolicyFromAccessLevelName(accessLevelName)
matchAccessPolicyFromAccessLevelName(accessLevelName: string): string | number;
Parse the access_policy from AccessLevel resource.
Name | Description |
accessLevelName |
string
A fully-qualified path representing AccessLevel resource. |
Type | Description |
string | number | {string} A string representing the access_policy. |
matchAccessPolicyFromAccessPolicyName(accessPolicyName)
matchAccessPolicyFromAccessPolicyName(accessPolicyName: string): string | number;
Parse the access_policy from AccessPolicy resource.
Name | Description |
accessPolicyName |
string
A fully-qualified path representing AccessPolicy resource. |
Type | Description |
string | number | {string} A string representing the access_policy. |
matchAccessPolicyFromServicePerimeterName(servicePerimeterName)
matchAccessPolicyFromServicePerimeterName(servicePerimeterName: string): string | number;
Parse the access_policy from ServicePerimeter resource.
Name | Description |
servicePerimeterName |
string
A fully-qualified path representing ServicePerimeter resource. |
Type | Description |
string | number | {string} A string representing the access_policy. |
matchServicePerimeterFromServicePerimeterName(servicePerimeterName)
matchServicePerimeterFromServicePerimeterName(servicePerimeterName: string): string | number;
Parse the service_perimeter from ServicePerimeter resource.
Name | Description |
servicePerimeterName |
string
A fully-qualified path representing ServicePerimeter resource. |
Type | Description |
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.
Name | Description |
accessPolicy |
string
|
servicePerimeter |
string
|
Type | Description |
string | {string} Resource name string. |