Console
    Contact Us Start free

    Class v1p4beta1.AssetServiceClient (3.17.0)

    Asset service definition. v1p4beta1

    Package

    @google-cloud/asset!

    Constructors

    (constructor)(opts)

      constructor 
 ( 
 opts 
 ?: 
  
 ClientOptions 
 );

    Construct an instance of AssetServiceClient.

    Parameter
    Name Description
    opts ClientOptions

    Properties

    apiEndpoint

      static 
  
 get 
  
 apiEndpoint 
 () 
 : 
  
 string 
 ;

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

    Property Value
    Type Description
    string

    assetServiceStub

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

    auth

      auth 
 : 
  
 gax 
 . 
 GoogleAuth 
 ;
    Property Value
    Type Description
    gax. GoogleAuth

    descriptors

      descriptors 
 : 
  
 Descriptors 
 ;
    Property Value
    Type Description
    Descriptors

    innerApiCalls

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

    operationsClient

      operationsClient 
 : 
  
 gax 
 . 
 OperationsClient 
 ;
    Property Value
    Type Description
    gax. OperationsClient

    port

      static 
  
 get 
  
 port 
 () 
 : 
  
 number 
 ;

    The port for this API service.

    Property Value
    Type Description
    number

    scopes

      static 
  
 get 
  
 scopes 
 () 
 : 
  
 string 
 [];

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

    Property Value
    Type Description
    string[]

    servicePath

      static 
  
 get 
  
 servicePath 
 () 
 : 
  
 string 
 ;

    The DNS address for this API service.

    Property Value
    Type Description
    string

    warn

      warn 
 : 
  
 ( 
 code 
 : 
  
 string 
 , 
  
 message 
 : 
  
 string 
 , 
  
 warnType 
 ?: 
  
 string 
 ) 
  
 = 
>  
 void 
 ;
    Property Value
    Type Description
    (code: string, message: string, warnType?: string) => void

    Methods

    analyzeIamPolicy(request, options)

      analyzeIamPolicy 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IAnalyzeIamPolicyRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IAnalyzeIamPolicyResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IAnalyzeIamPolicyRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyRequest
    options CallOptions
    Returns
    Type Description
    Promise <[protos. google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyResponse , protos. google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyRequest | undefined, {} | undefined]>

    analyzeIamPolicy(request, options, callback)

      analyzeIamPolicy 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IAnalyzeIamPolicyRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IAnalyzeIamPolicyResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IAnalyzeIamPolicyRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyRequest
    options CallOptions
    callback Callback <protos. google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyResponse , protos. google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    analyzeIamPolicy(request, callback)

      analyzeIamPolicy 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IAnalyzeIamPolicyRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IAnalyzeIamPolicyResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IAnalyzeIamPolicyRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyRequest
    callback Callback <protos. google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyResponse , protos. google.cloud.asset.v1p4beta1.IAnalyzeIamPolicyRequest | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    checkExportIamPolicyAnalysisProgress(name)

      checkExportIamPolicyAnalysisProgress 
 ( 
 name 
 : 
  
 string 
 ) 
 : 
  
 Promise<LROperation<protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 ExportIamPolicyAnalysisResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 ExportIamPolicyAnalysisRequest 
>> ;

    Check the status of the long running operation returned by exportIamPolicyAnalysis() .

    Parameter
    Name Description
    name string

    The operation name that will be passed.
    Returns
    Type Description
    Promise < LROperation <protos. google.cloud.asset.v1p4beta1.ExportIamPolicyAnalysisResponse , protos. google.cloud.asset.v1p4beta1.ExportIamPolicyAnalysisRequest >>

    {Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

    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
    Type Description
    Promise <void>

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

    exportIamPolicyAnalysis(request, options)

      exportIamPolicyAnalysis 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IExportIamPolicyAnalysisRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 LROperation<protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IExportIamPolicyAnalysisResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IExportIamPolicyAnalysisRequest 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;
    Parameters
    Name Description
    request protos. google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisRequest
    options CallOptions
    Returns
    Type Description
    Promise <[ LROperation <protos. google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisResponse , protos. google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisRequest >, protos. google.longrunning.IOperation | undefined, {} | undefined]>

    exportIamPolicyAnalysis(request, options, callback)

      exportIamPolicyAnalysis 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IExportIamPolicyAnalysisRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<LROperation<protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IExportIamPolicyAnalysisResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IExportIamPolicyAnalysisRequest 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisRequest
    options CallOptions
    callback Callback < LROperation <protos. google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisResponse , protos. google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisRequest >, protos. google.longrunning.IOperation | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    exportIamPolicyAnalysis(request, callback)

      exportIamPolicyAnalysis 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IExportIamPolicyAnalysisRequest 
 , 
  
 callback 
 : 
  
 Callback<LROperation<protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IExportIamPolicyAnalysisResponse 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 asset 
 . 
 v1p4beta1 
 . 
 IExportIamPolicyAnalysisRequest 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;
    Parameters
    Name Description
    request protos. google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisRequest
    callback Callback < LROperation <protos. google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisResponse , protos. google.cloud.asset.v1p4beta1.IExportIamPolicyAnalysisRequest >, protos. google.longrunning.IOperation | null | undefined, {} | null | undefined>
    Returns
    Type Description
    void

    getProjectId()

      getProjectId 
 () 
 : 
  
 Promise<string> 
 ;
    Returns
    Type Description
    Promise <string>

    getProjectId(callback)

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

    Returns
    Type Description
    Promise <{ [name: string]: Function ; }>

    {Promise} A promise that resolves to an authenticated service stub.
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: