Class v1small.AddressesClient (3.1.2)

Services

The Addresses API. v1small

Package

@google-cloud/compute

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of AddressesClient.

Parameter
NameDescription
opts ClientOptions

Properties

addressesStub

addressesStub?: Promise<{
        [name: string]: Function;
    }>;

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

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

aggregatedListAsync(request, options)

aggregatedListAsync(request?: protos.google.cloud.compute.v1small.IAggregatedListAddressesRequest, options?: CallOptions): AsyncIterable<[
        string,
        protos.google.cloud.compute.v1small.IAddressesScopedList
    ]>;

Equivalent to aggregatedList, 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.compute.v1small.IAggregatedListAddressesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<[ string, protos.google.cloud.compute.v1small.IAddressesScopedList ]>

{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 as tuple [string, [AddressesScopedList]]. 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.

Example 

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. *="" for="" example,="" if="" you="" are="" filtering="" compute="" engine="" instances,="" you="" can="" exclude="" instances="" named="" `example-instance`="" by="" specifying="" `name="" !="example-instance`." *="" you="" can="" also="" filter="" nested="" fields.="" for="" example,="" you="" could="" specify="" `scheduling.automaticrestart="false`" to="" include="" instances="" only="" if="" they="" are="" not="" scheduled="" for="" automatic="" restarts.="" you="" can="" use="" filtering="" on="" nested="" fields="" to="" filter="" based="" on="" resource="" labels.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" parentheses.="" for="" example:="" ```="" (scheduling.automaticrestart="true)" (cpuplatform="Intel Skylake" )="" ```="" by="" default,="" each="" expression="" is="" an="" `and`="" expression.="" however,="" you="" can="" include="" `and`="" and="" `or`="" expressions="" explicitly.="" for="" example:="" ```="" (cpuplatform="Intel Skylake" )="" or="" (cpuplatform="Intel Broadwell" )="" and="" (scheduling.automaticrestart="true)" ```="" */="" const="" filter='abc123' *="" *="" indicates="" whether="" every="" visible="" scope="" for="" each="" scope="" type="" (zone,="" region,="" global)="" should="" be="" included="" in="" the="" response.="" for="" new="" resource="" types="" added="" after="" this="" field,="" the="" flag="" has="" no="" effect="" as="" new="" resource="" types="" will="" always="" include="" every="" visible="" scope="" for="" each="" scope="" type="" in="" response.="" for="" resource="" types="" which="" predate="" this="" field,="" if="" this="" flag="" is="" omitted="" or="" false,="" only="" scopes="" of="" the="" scope="" types="" where="" the="" resource="" type="" is="" expected="" to="" be="" found="" will="" be="" included.="" */="" const="" includeallscopes="true" *="" *="" the="" maximum="" number="" of="" results="" per="" page="" that="" should="" be="" returned.="" if="" the="" number="" of="" available="" results="" is="" larger="" than="" `maxresults`,="" compute="" engine="" returns="" a="" `nextpagetoken`="" that="" can="" be="" used="" to="" get="" the="" next="" page="" of="" results="" in="" subsequent="" list="" requests.="" acceptable="" values="" are="" `0`="" to="" `500`,="" inclusive.="" (default:="" `500`)="" */="" const="" maxresults="1234" *="" *="" sorts="" list="" results="" by="" a="" certain="" order.="" by="" default,="" results="" are="" returned="" in="" alphanumerical="" order="" based="" on="" the="" resource="" name.="" *="" you="" can="" also="" sort="" results="" in="" descending="" order="" based="" on="" the="" creation="" timestamp="" using="" `orderby="creationTimestamp desc" `.="" this="" sorts="" results="" based="" on="" the="" `creationtimestamp`="" field="" in="" reverse="" chronological="" order="" (newest="" result="" first).="" use="" this="" to="" sort="" resources="" like="" operations="" so="" that="" the="" newest="" operation="" is="" returned="" first.="" *="" currently,="" only="" sorting="" by="" `name`="" or="" `creationtimestamp="" desc`="" is="" supported.="" */="" const="" orderby='abc123' *="" *="" specifies="" a="" page="" token="" to="" use.="" set="" `pagetoken`="" to="" the="" `nextpagetoken`="" returned="" by="" a="" previous="" list="" request="" to="" get="" the="" next="" page="" of="" results.="" */="" const="" pagetoken='abc123' *="" *="" project="" id="" for="" this="" request.="" */="" const="" project='my-project' imports="" the="" compute="" library="" const="" {addressesclient}="require('@google-cloud/compute-small').v1small;" instantiates="" a="" client="" const="" computeclient="new" addressesclient();="" async="" function="" callaggregatedlist()="" {="" construct="" request="" const="" request="{" project,="" };="" run="" request="" const="" iterable="await" computeclient.aggregatedlistasync(request);="" for="" await="" (const="" [key,="" value]="" of="" iterable)="" {="" console.log(response);="" }="" }="" callaggregatedlist();="">

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.

delete(request, options)

delete(request?: protos.google.cloud.compute.v1small.IDeleteAddressRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1small.IOperation, null>,
        protos.google.cloud.compute.v1small.IOperation | undefined,
        {} | undefined
    ]>;

Deletes the specified address resource.

Parameters
NameDescription
request protos.google.cloud.compute.v1small.IDeleteAddressRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.compute.v1small.IOperation, null>, protos.google.cloud.compute.v1small.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.

Example 

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Name of the address resource to delete.
   */
  // const address = 'abc123'
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  Name of the region for this request.
   */
  // const region = 'us-central1'
  /**
   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
   *  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Compute library
  const {AddressesClient} = require('@google-cloud/compute-small').v1small;

  // Instantiates a client
  const computeClient = new AddressesClient();

  async function callDelete() {
    // Construct request
    const request = {
      address,
      project,
      region,
    };

    // Run request
    const response = await computeClient.delete(request);
    console.log(response);
  }

  callDelete();

delete(request, options, callback)

delete(request: protos.google.cloud.compute.v1small.IDeleteAddressRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IDeleteAddressRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1small.IDeleteAddressRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IDeleteAddressRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

delete(request, callback)

delete(request: protos.google.cloud.compute.v1small.IDeleteAddressRequest, callback: Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IDeleteAddressRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1small.IDeleteAddressRequest
callback Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IDeleteAddressRequest | 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.

insert(request, options)

insert(request?: protos.google.cloud.compute.v1small.IInsertAddressRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1small.IOperation, null>,
        protos.google.cloud.compute.v1small.IOperation | undefined,
        {} | undefined
    ]>;

Creates an address resource in the specified project by using the data included in the request.

Parameters
NameDescription
request protos.google.cloud.compute.v1small.IInsertAddressRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.compute.v1small.IOperation, null>, protos.google.cloud.compute.v1small.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples. This method is considered to be in beta. This means while stable it is still a work-in-progress and under active development, and might get backwards-incompatible changes at any time. .promise() is not supported yet.

Example 

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The body resource for this request
   */
  // const addressResource = {}
  /**
   *  Project ID for this request.
   */
  // const project = 'my-project'
  /**
   *  Name of the region for this request.
   */
  // const region = 'us-central1'
  /**
   *  An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.
   *  For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.
   *  The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
   */
  // const requestId = 'abc123'

  // Imports the Compute library
  const {AddressesClient} = require('@google-cloud/compute-small').v1small;

  // Instantiates a client
  const computeClient = new AddressesClient();

  async function callInsert() {
    // Construct request
    const request = {
      addressResource,
      project,
      region,
    };

    // Run request
    const response = await computeClient.insert(request);
    console.log(response);
  }

  callInsert();

insert(request, options, callback)

insert(request: protos.google.cloud.compute.v1small.IInsertAddressRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IInsertAddressRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1small.IInsertAddressRequest
options CallOptions
callback Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IInsertAddressRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

insert(request, callback)

insert(request: protos.google.cloud.compute.v1small.IInsertAddressRequest, callback: Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IInsertAddressRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1small.IInsertAddressRequest
callback Callback<protos.google.cloud.compute.v1small.IOperation, protos.google.cloud.compute.v1small.IInsertAddressRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

list(request, options)

list(request?: protos.google.cloud.compute.v1small.IListAddressesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1small.IAddress[],
        protos.google.cloud.compute.v1small.IListAddressesRequest | null,
        protos.google.cloud.compute.v1small.IAddressList
    ]>;

Retrieves a list of addresses contained within the specified region.

Parameters
NameDescription
request protos.google.cloud.compute.v1small.IListAddressesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1small.IAddress[], protos.google.cloud.compute.v1small.IListAddressesRequest | null, protos.google.cloud.compute.v1small.IAddressList ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Address]. 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 listAsync() 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.

list(request, options, callback)

list(request: protos.google.cloud.compute.v1small.IListAddressesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.compute.v1small.IListAddressesRequest, protos.google.cloud.compute.v1small.IAddressList | null | undefined, protos.google.cloud.compute.v1small.IAddress>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1small.IListAddressesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.compute.v1small.IListAddressesRequest, protos.google.cloud.compute.v1small.IAddressList | null | undefined, protos.google.cloud.compute.v1small.IAddress>
Returns
TypeDescription
void

list(request, callback)

list(request: protos.google.cloud.compute.v1small.IListAddressesRequest, callback: PaginationCallback<protos.google.cloud.compute.v1small.IListAddressesRequest, protos.google.cloud.compute.v1small.IAddressList | null | undefined, protos.google.cloud.compute.v1small.IAddress>): void;
Parameters
NameDescription
request protos.google.cloud.compute.v1small.IListAddressesRequest
callback PaginationCallback<protos.google.cloud.compute.v1small.IListAddressesRequest, protos.google.cloud.compute.v1small.IAddressList | null | undefined, protos.google.cloud.compute.v1small.IAddress>
Returns
TypeDescription
void

listAsync(request, options)

listAsync(request?: protos.google.cloud.compute.v1small.IListAddressesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.compute.v1small.IAddress>;

Equivalent to list, 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.compute.v1small.IListAddressesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.compute.v1small.IAddress>

{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 [Address]. 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.

Example 

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. *="" for="" example,="" if="" you="" are="" filtering="" compute="" engine="" instances,="" you="" can="" exclude="" instances="" named="" example-instance="" by="" specifying="" name="" !="example-instance." *="" you="" can="" also="" filter="" nested="" fields.="" for="" example,="" you="" could="" specify="" scheduling.automaticrestart="false" to="" include="" instances="" only="" if="" they="" are="" not="" scheduled="" for="" automatic="" restarts.="" you="" can="" use="" filtering="" on="" nested="" fields="" to="" filter="" based="" on="" resource="" labels.="" *="" to="" filter="" on="" multiple="" expressions,="" provide="" each="" separate="" expression="" within="" parentheses.="" for="" example,="" (scheduling.automaticrestart="true)" (cpuplatform="Intel Skylake" ).="" by="" default,="" each="" expression="" is="" an="" and="" expression.="" however,="" you="" can="" include="" and="" and="" or="" expressions="" explicitly.="" for="" example,="" (cpuplatform="Intel Skylake" )="" or="" (cpuplatform="Intel Broadwell" )="" and="" (scheduling.automaticrestart="true)." */="" const="" filter='abc123' *="" *="" the="" maximum="" number="" of="" results="" per="" page="" that="" should="" be="" returned.="" if="" the="" number="" of="" available="" results="" is="" larger="" than="" maxresults,="" compute="" engine="" returns="" a="" nextpagetoken="" that="" can="" be="" used="" to="" get="" the="" next="" page="" of="" results="" in="" subsequent="" list="" requests.="" acceptable="" values="" are="" 0="" to="" 500,="" inclusive.="" (default:="" 500)="" */="" const="" maxresults="1234" *="" *="" sorts="" list="" results="" by="" a="" certain="" order.="" by="" default,="" results="" are="" returned="" in="" alphanumerical="" order="" based="" on="" the="" resource="" name.="" *="" you="" can="" also="" sort="" results="" in="" descending="" order="" based="" on="" the="" creation="" timestamp="" using="" orderby="creationTimestamp desc" .="" this="" sorts="" results="" based="" on="" the="" creationtimestamp="" field="" in="" reverse="" chronological="" order="" (newest="" result="" first).="" use="" this="" to="" sort="" resources="" like="" operations="" so="" that="" the="" newest="" operation="" is="" returned="" first.="" *="" currently,="" only="" sorting="" by="" name="" or="" creationtimestamp="" desc="" is="" supported.="" */="" const="" orderby='abc123' *="" *="" specifies="" a="" page="" token="" to="" use.="" set="" pagetoken="" to="" the="" nextpagetoken="" returned="" by="" a="" previous="" list="" request="" to="" get="" the="" next="" page="" of="" results.="" */="" const="" pagetoken='abc123' *="" *="" project="" id="" for="" this="" request.="" */="" const="" project='my-project' *="" *="" name="" of="" the="" region="" for="" this="" request.="" */="" const="" region='us-central1' imports="" the="" compute="" library="" const="" {addressesclient}="require('@google-cloud/compute-small').v1small;" instantiates="" a="" client="" const="" computeclient="new" addressesclient();="" async="" function="" calllist()="" {="" construct="" request="" const="" request="{" orderby,="" project,="" region,="" };="" run="" request="" const="" iterable="await" computeclient.listasync(request);="" for="" await="" (const="" response="" of="" iterable)="" {="" console.log(response);="" }="" }="" calllist();="">

listStream(request, options)

listStream(request?: protos.google.cloud.compute.v1small.IListAddressesRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
NameDescription
request protos.google.cloud.compute.v1small.IListAddressesRequest

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 [Address] 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 listAsync() 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.