Class v1p5beta1.AssetServiceClient (3.13.0)

Asset service definition. v1p5beta1

Package

@google-cloud/asset!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of AssetServiceClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
TypeDescription
string

assetServiceStub

assetServiceStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
TypeDescription
Promise<{ [name: string]: Function; }>

auth

auth: gax.GoogleAuth;
Property Value
TypeDescription
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
TypeDescription
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
TypeDescription
{ [name: string]: Function; }

port

static get port(): number;

The port for this API service.

Property Value
TypeDescription
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
TypeDescription
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
TypeDescription
string

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
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

getProjectId()

getProjectId(): Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
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.

Returns
TypeDescription
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]>;
Parameters
NameDescription
request protos.google.cloud.asset.v1p5beta1.IListAssetsRequest
options CallOptions
Returns
TypeDescription
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;
Parameters
NameDescription
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>
Returns
TypeDescription
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;
Parameters
NameDescription
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>
Returns
TypeDescription
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.

Parameters
NameDescription
request protos.google.cloud.asset.v1p5beta1.IListAssetsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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.

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.

Parameters
NameDescription
request protos.google.cloud.asset.v1p5beta1.IListAssetsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.