Class v1p2beta1.AssetServiceClient (3.20.0)

Asset service definition. v1p2beta1

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; }

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
TypeDescription
{ [name: string]: gax.PathTemplate; }

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

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
TypeDescription
(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
TypeDescription
Promise<void>

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

createFeed(request, options)

createFeed(request?: protos.google.cloud.asset.v1p2beta1.ICreateFeedRequest, options?: CallOptions): Promise<[protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.ICreateFeedRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.asset.v1p2beta1.ICreateFeedRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.ICreateFeedRequest | undefined, {} | undefined]>

createFeed(request, options, callback)

createFeed(request: protos.google.cloud.asset.v1p2beta1.ICreateFeedRequest, options: CallOptions, callback: Callback<protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.ICreateFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.asset.v1p2beta1.ICreateFeedRequest
options CallOptions
callback Callback<protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.ICreateFeedRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createFeed(request, callback)

createFeed(request: protos.google.cloud.asset.v1p2beta1.ICreateFeedRequest, callback: Callback<protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.ICreateFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.asset.v1p2beta1.ICreateFeedRequest
callback Callback<protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.ICreateFeedRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteFeed(request, options)

deleteFeed(request?: protos.google.cloud.asset.v1p2beta1.IDeleteFeedRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.asset.v1p2beta1.IDeleteFeedRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.asset.v1p2beta1.IDeleteFeedRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.asset.v1p2beta1.IDeleteFeedRequest | undefined, {} | undefined]>

deleteFeed(request, options, callback)

deleteFeed(request: protos.google.cloud.asset.v1p2beta1.IDeleteFeedRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.asset.v1p2beta1.IDeleteFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.asset.v1p2beta1.IDeleteFeedRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.asset.v1p2beta1.IDeleteFeedRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteFeed(request, callback)

deleteFeed(request: protos.google.cloud.asset.v1p2beta1.IDeleteFeedRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.asset.v1p2beta1.IDeleteFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.asset.v1p2beta1.IDeleteFeedRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.asset.v1p2beta1.IDeleteFeedRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

folderFeedPath(folder, feed)

folderFeedPath(folder: string, feed: string): string;

Return a fully-qualified folderFeed resource name string.

Parameters
NameDescription
folder string
feed string
Returns
TypeDescription
string

{string} Resource name string.

getFeed(request, options)

getFeed(request?: protos.google.cloud.asset.v1p2beta1.IGetFeedRequest, options?: CallOptions): Promise<[protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.IGetFeedRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.asset.v1p2beta1.IGetFeedRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.IGetFeedRequest | undefined, {} | undefined]>

getFeed(request, options, callback)

getFeed(request: protos.google.cloud.asset.v1p2beta1.IGetFeedRequest, options: CallOptions, callback: Callback<protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.IGetFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.asset.v1p2beta1.IGetFeedRequest
options CallOptions
callback Callback<protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.IGetFeedRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getFeed(request, callback)

getFeed(request: protos.google.cloud.asset.v1p2beta1.IGetFeedRequest, callback: Callback<protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.IGetFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.asset.v1p2beta1.IGetFeedRequest
callback Callback<protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.IGetFeedRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

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.

listFeeds(request, options)

listFeeds(request?: protos.google.cloud.asset.v1p2beta1.IListFeedsRequest, options?: CallOptions): Promise<[protos.google.cloud.asset.v1p2beta1.IListFeedsResponse, protos.google.cloud.asset.v1p2beta1.IListFeedsRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.asset.v1p2beta1.IListFeedsRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.asset.v1p2beta1.IListFeedsResponse, protos.google.cloud.asset.v1p2beta1.IListFeedsRequest | undefined, {} | undefined]>

listFeeds(request, options, callback)

listFeeds(request: protos.google.cloud.asset.v1p2beta1.IListFeedsRequest, options: CallOptions, callback: Callback<protos.google.cloud.asset.v1p2beta1.IListFeedsResponse, protos.google.cloud.asset.v1p2beta1.IListFeedsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.asset.v1p2beta1.IListFeedsRequest
options CallOptions
callback Callback<protos.google.cloud.asset.v1p2beta1.IListFeedsResponse, protos.google.cloud.asset.v1p2beta1.IListFeedsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

listFeeds(request, callback)

listFeeds(request: protos.google.cloud.asset.v1p2beta1.IListFeedsRequest, callback: Callback<protos.google.cloud.asset.v1p2beta1.IListFeedsResponse, protos.google.cloud.asset.v1p2beta1.IListFeedsRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.asset.v1p2beta1.IListFeedsRequest
callback Callback<protos.google.cloud.asset.v1p2beta1.IListFeedsResponse, protos.google.cloud.asset.v1p2beta1.IListFeedsRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

matchFeedFromFolderFeedName(folderFeedName)

matchFeedFromFolderFeedName(folderFeedName: string): string | number;

Parse the feed from FolderFeed resource.

Parameter
NameDescription
folderFeedName string

A fully-qualified path representing folder_feed resource.

Returns
TypeDescription
string | number

{string} A string representing the feed.

matchFeedFromOrganizationFeedName(organizationFeedName)

matchFeedFromOrganizationFeedName(organizationFeedName: string): string | number;

Parse the feed from OrganizationFeed resource.

Parameter
NameDescription
organizationFeedName string

A fully-qualified path representing organization_feed resource.

Returns
TypeDescription
string | number

{string} A string representing the feed.

matchFeedFromProjectFeedName(projectFeedName)

matchFeedFromProjectFeedName(projectFeedName: string): string | number;

Parse the feed from ProjectFeed resource.

Parameter
NameDescription
projectFeedName string

A fully-qualified path representing project_feed resource.

Returns
TypeDescription
string | number

{string} A string representing the feed.

matchFolderFromFolderFeedName(folderFeedName)

matchFolderFromFolderFeedName(folderFeedName: string): string | number;

Parse the folder from FolderFeed resource.

Parameter
NameDescription
folderFeedName string

A fully-qualified path representing folder_feed resource.

Returns
TypeDescription
string | number

{string} A string representing the folder.

matchOrganizationFromOrganizationFeedName(organizationFeedName)

matchOrganizationFromOrganizationFeedName(organizationFeedName: string): string | number;

Parse the organization from OrganizationFeed resource.

Parameter
NameDescription
organizationFeedName string

A fully-qualified path representing organization_feed resource.

Returns
TypeDescription
string | number

{string} A string representing the organization.

matchProjectFromProjectFeedName(projectFeedName)

matchProjectFromProjectFeedName(projectFeedName: string): string | number;

Parse the project from ProjectFeed resource.

Parameter
NameDescription
projectFeedName string

A fully-qualified path representing project_feed resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

organizationFeedPath(organization, feed)

organizationFeedPath(organization: string, feed: string): string;

Return a fully-qualified organizationFeed resource name string.

Parameters
NameDescription
organization string
feed string
Returns
TypeDescription
string

{string} Resource name string.

projectFeedPath(project, feed)

projectFeedPath(project: string, feed: string): string;

Return a fully-qualified projectFeed resource name string.

Parameters
NameDescription
project string
feed string
Returns
TypeDescription
string

{string} Resource name string.

updateFeed(request, options)

updateFeed(request?: protos.google.cloud.asset.v1p2beta1.IUpdateFeedRequest, options?: CallOptions): Promise<[protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.IUpdateFeedRequest | undefined, {} | undefined]>;
Parameters
NameDescription
request protos.google.cloud.asset.v1p2beta1.IUpdateFeedRequest
options CallOptions
Returns
TypeDescription
Promise<[protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.IUpdateFeedRequest | undefined, {} | undefined]>

updateFeed(request, options, callback)

updateFeed(request: protos.google.cloud.asset.v1p2beta1.IUpdateFeedRequest, options: CallOptions, callback: Callback<protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.IUpdateFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.asset.v1p2beta1.IUpdateFeedRequest
options CallOptions
callback Callback<protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.IUpdateFeedRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateFeed(request, callback)

updateFeed(request: protos.google.cloud.asset.v1p2beta1.IUpdateFeedRequest, callback: Callback<protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.IUpdateFeedRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.asset.v1p2beta1.IUpdateFeedRequest
callback Callback<protos.google.cloud.asset.v1p2beta1.IFeed, protos.google.cloud.asset.v1p2beta1.IUpdateFeedRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void