Class v1.EdgeNetworkClient (0.2.0)

EdgeNetwork API provides managed, highly available cloud dynamic network configuration service to the GEC customer to enable edge application and network function solutions. This allows the customers to easily define and configure the network setup and property to meet the workload requirement. v1

Package

@google-cloud/edgenetwork

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of EdgeNetworkClient.

Parameters
NameDescription
opts ClientOptions
gaxInstance typeof gax | typeof fallback

: loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new EdgeNetworkClient({fallback: true}, gax); ```

Properties

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;

edgeNetworkStub

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

innerApiCalls

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

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

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

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
NameDescription
request CancelOperationRequest

The request object that will be sent.

options CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

checkCreateInterconnectAttachmentProgress(name)

checkCreateInterconnectAttachmentProgress(name: string): Promise<LROperation<protos.google.cloud.edgenetwork.v1.InterconnectAttachment, protos.google.cloud.edgenetwork.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.edgenetwork.v1.InterconnectAttachment, protos.google.cloud.edgenetwork.v1.OperationMetadata>>

{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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting object
   *  If auto-generating Id server-side, remove this field and
   *  interconnect_attachment_id from the method_signature of Create RPC
   */
  // const interconnectAttachmentId = 'abc123'
  /**
   *  Required. The resource being created
   */
  // const interconnectAttachment = {}
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callCreateInterconnectAttachment() {
    // Construct request
    const request = {
      parent,
      interconnectAttachmentId,
      interconnectAttachment,
    };

    // Run request
    const [operation] = await edgenetworkClient.createInterconnectAttachment(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateInterconnectAttachment();

checkCreateNetworkProgress(name)

checkCreateNetworkProgress(name: string): Promise<LROperation<protos.google.cloud.edgenetwork.v1.Network, protos.google.cloud.edgenetwork.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.edgenetwork.v1.Network, protos.google.cloud.edgenetwork.v1.OperationMetadata>>

{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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting object
   *  If auto-generating Id server-side, remove this field and
   *  network_id from the method_signature of Create RPC
   */
  // const networkId = 'abc123'
  /**
   *  Required. The resource being created
   */
  // const network = {}
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callCreateNetwork() {
    // Construct request
    const request = {
      parent,
      networkId,
      network,
    };

    // Run request
    const [operation] = await edgenetworkClient.createNetwork(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateNetwork();

checkCreateRouterProgress(name)

checkCreateRouterProgress(name: string): Promise<LROperation<protos.google.cloud.edgenetwork.v1.Router, protos.google.cloud.edgenetwork.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.edgenetwork.v1.Router, protos.google.cloud.edgenetwork.v1.OperationMetadata>>

{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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting object
   *  If auto-generating Id server-side, remove this field and
   *  router_id from the method_signature of Create RPC
   */
  // const routerId = 'abc123'
  /**
   *  Required. The resource being created
   */
  // const router = {}
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callCreateRouter() {
    // Construct request
    const request = {
      parent,
      routerId,
      router,
    };

    // Run request
    const [operation] = await edgenetworkClient.createRouter(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateRouter();

checkCreateSubnetProgress(name)

checkCreateSubnetProgress(name: string): Promise<LROperation<protos.google.cloud.edgenetwork.v1.Subnet, protos.google.cloud.edgenetwork.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.edgenetwork.v1.Subnet, protos.google.cloud.edgenetwork.v1.OperationMetadata>>

{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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting object
   *  If auto-generating Id server-side, remove this field and
   *  subnet_id from the method_signature of Create RPC
   */
  // const subnetId = 'abc123'
  /**
   *  Required. The resource being created
   */
  // const subnet = {}
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callCreateSubnet() {
    // Construct request
    const request = {
      parent,
      subnetId,
      subnet,
    };

    // Run request
    const [operation] = await edgenetworkClient.createSubnet(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateSubnet();

checkDeleteInterconnectAttachmentProgress(name)

checkDeleteInterconnectAttachmentProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.edgenetwork.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.edgenetwork.v1.OperationMetadata>>

{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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callDeleteInterconnectAttachment() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await edgenetworkClient.deleteInterconnectAttachment(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteInterconnectAttachment();

checkDeleteNetworkProgress(name)

checkDeleteNetworkProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.edgenetwork.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.edgenetwork.v1.OperationMetadata>>

{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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callDeleteNetwork() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await edgenetworkClient.deleteNetwork(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteNetwork();

checkDeleteRouterProgress(name)

checkDeleteRouterProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.edgenetwork.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.edgenetwork.v1.OperationMetadata>>

{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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callDeleteRouter() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await edgenetworkClient.deleteRouter(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteRouter();

checkDeleteSubnetProgress(name)

checkDeleteSubnetProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.edgenetwork.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.edgenetwork.v1.OperationMetadata>>

{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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callDeleteSubnet() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await edgenetworkClient.deleteSubnet(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteSubnet();

checkUpdateRouterProgress(name)

checkUpdateRouterProgress(name: string): Promise<LROperation<protos.google.cloud.edgenetwork.v1.Router, protos.google.cloud.edgenetwork.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.edgenetwork.v1.Router, protos.google.cloud.edgenetwork.v1.OperationMetadata>>

{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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  Router resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The resource being updated
   */
  // const router = {}
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callUpdateRouter() {
    // Construct request
    const request = {
      updateMask,
      router,
    };

    // Run request
    const [operation] = await edgenetworkClient.updateRouter(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateRouter();

checkUpdateSubnetProgress(name)

checkUpdateSubnetProgress(name: string): Promise<LROperation<protos.google.cloud.edgenetwork.v1.Subnet, protos.google.cloud.edgenetwork.v1.OperationMetadata>>;

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

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.edgenetwork.v1.Subnet, protos.google.cloud.edgenetwork.v1.OperationMetadata>>

{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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  Subnet resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The resource being updated
   */
  // const subnet = {}
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callUpdateSubnet() {
    // Construct request
    const request = {
      updateMask,
      subnet,
    };

    // Run request
    const [operation] = await edgenetworkClient.updateSubnet(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateSubnet();

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.

createInterconnectAttachment(request, options)

createInterconnectAttachment(request?: protos.google.cloud.edgenetwork.v1.ICreateInterconnectAttachmentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.edgenetwork.v1.IInterconnectAttachment, protos.google.cloud.edgenetwork.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new InterconnectAttachment in a given project and location.

Parameters
NameDescription
request ICreateInterconnectAttachmentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.edgenetwork.v1.IInterconnectAttachment, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.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. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting object
   *  If auto-generating Id server-side, remove this field and
   *  interconnect_attachment_id from the method_signature of Create RPC
   */
  // const interconnectAttachmentId = 'abc123'
  /**
   *  Required. The resource being created
   */
  // const interconnectAttachment = {}
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callCreateInterconnectAttachment() {
    // Construct request
    const request = {
      parent,
      interconnectAttachmentId,
      interconnectAttachment,
    };

    // Run request
    const [operation] = await edgenetworkClient.createInterconnectAttachment(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateInterconnectAttachment();

createInterconnectAttachment(request, options, callback)

createInterconnectAttachment(request: protos.google.cloud.edgenetwork.v1.ICreateInterconnectAttachmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgenetwork.v1.IInterconnectAttachment, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateInterconnectAttachmentRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.edgenetwork.v1.IInterconnectAttachment, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createInterconnectAttachment(request, callback)

createInterconnectAttachment(request: protos.google.cloud.edgenetwork.v1.ICreateInterconnectAttachmentRequest, callback: Callback<LROperation<protos.google.cloud.edgenetwork.v1.IInterconnectAttachment, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateInterconnectAttachmentRequest
callback Callback<LROperation<protos.google.cloud.edgenetwork.v1.IInterconnectAttachment, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createNetwork(request, options)

createNetwork(request?: protos.google.cloud.edgenetwork.v1.ICreateNetworkRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.edgenetwork.v1.INetwork, protos.google.cloud.edgenetwork.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new Network in a given project and location.

Parameters
NameDescription
request ICreateNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.edgenetwork.v1.INetwork, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.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. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting object
   *  If auto-generating Id server-side, remove this field and
   *  network_id from the method_signature of Create RPC
   */
  // const networkId = 'abc123'
  /**
   *  Required. The resource being created
   */
  // const network = {}
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callCreateNetwork() {
    // Construct request
    const request = {
      parent,
      networkId,
      network,
    };

    // Run request
    const [operation] = await edgenetworkClient.createNetwork(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateNetwork();

createNetwork(request, options, callback)

createNetwork(request: protos.google.cloud.edgenetwork.v1.ICreateNetworkRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgenetwork.v1.INetwork, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateNetworkRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.edgenetwork.v1.INetwork, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createNetwork(request, callback)

createNetwork(request: protos.google.cloud.edgenetwork.v1.ICreateNetworkRequest, callback: Callback<LROperation<protos.google.cloud.edgenetwork.v1.INetwork, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateNetworkRequest
callback Callback<LROperation<protos.google.cloud.edgenetwork.v1.INetwork, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createRouter(request, options)

createRouter(request?: protos.google.cloud.edgenetwork.v1.ICreateRouterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new Router in a given project and location.

Parameters
NameDescription
request ICreateRouterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.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. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting object
   *  If auto-generating Id server-side, remove this field and
   *  router_id from the method_signature of Create RPC
   */
  // const routerId = 'abc123'
  /**
   *  Required. The resource being created
   */
  // const router = {}
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callCreateRouter() {
    // Construct request
    const request = {
      parent,
      routerId,
      router,
    };

    // Run request
    const [operation] = await edgenetworkClient.createRouter(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateRouter();

createRouter(request, options, callback)

createRouter(request: protos.google.cloud.edgenetwork.v1.ICreateRouterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateRouterRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createRouter(request, callback)

createRouter(request: protos.google.cloud.edgenetwork.v1.ICreateRouterRequest, callback: Callback<LROperation<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateRouterRequest
callback Callback<LROperation<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createSubnet(request, options)

createSubnet(request?: protos.google.cloud.edgenetwork.v1.ICreateSubnetRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Creates a new Subnet in a given project and location.

Parameters
NameDescription
request ICreateSubnetRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.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. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Value for parent.
   */
  // const parent = 'abc123'
  /**
   *  Required. Id of the requesting object
   *  If auto-generating Id server-side, remove this field and
   *  subnet_id from the method_signature of Create RPC
   */
  // const subnetId = 'abc123'
  /**
   *  Required. The resource being created
   */
  // const subnet = {}
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callCreateSubnet() {
    // Construct request
    const request = {
      parent,
      subnetId,
      subnet,
    };

    // Run request
    const [operation] = await edgenetworkClient.createSubnet(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callCreateSubnet();

createSubnet(request, options, callback)

createSubnet(request: protos.google.cloud.edgenetwork.v1.ICreateSubnetRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateSubnetRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createSubnet(request, callback)

createSubnet(request: protos.google.cloud.edgenetwork.v1.ICreateSubnetRequest, callback: Callback<LROperation<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request ICreateSubnetRequest
callback Callback<LROperation<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteInterconnectAttachment(request, options)

deleteInterconnectAttachment(request?: protos.google.cloud.edgenetwork.v1.IDeleteInterconnectAttachmentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a single InterconnectAttachment.

Parameters
NameDescription
request IDeleteInterconnectAttachmentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.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. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callDeleteInterconnectAttachment() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await edgenetworkClient.deleteInterconnectAttachment(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteInterconnectAttachment();

deleteInterconnectAttachment(request, options, callback)

deleteInterconnectAttachment(request: protos.google.cloud.edgenetwork.v1.IDeleteInterconnectAttachmentRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteInterconnectAttachmentRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteInterconnectAttachment(request, callback)

deleteInterconnectAttachment(request: protos.google.cloud.edgenetwork.v1.IDeleteInterconnectAttachmentRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteInterconnectAttachmentRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteNetwork(request, options)

deleteNetwork(request?: protos.google.cloud.edgenetwork.v1.IDeleteNetworkRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a single Network.

Parameters
NameDescription
request IDeleteNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.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. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callDeleteNetwork() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await edgenetworkClient.deleteNetwork(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteNetwork();

deleteNetwork(request, options, callback)

deleteNetwork(request: protos.google.cloud.edgenetwork.v1.IDeleteNetworkRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteNetworkRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteNetwork(request, callback)

deleteNetwork(request: protos.google.cloud.edgenetwork.v1.IDeleteNetworkRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteNetworkRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
NameDescription
request DeleteOperationRequest

The request object that will be sent.

options CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<protos.google.protobuf.Empty>
Example

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

deleteRouter(request, options)

deleteRouter(request?: protos.google.cloud.edgenetwork.v1.IDeleteRouterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a single Router.

Parameters
NameDescription
request IDeleteRouterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.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. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callDeleteRouter() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await edgenetworkClient.deleteRouter(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteRouter();

deleteRouter(request, options, callback)

deleteRouter(request: protos.google.cloud.edgenetwork.v1.IDeleteRouterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteRouterRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteRouter(request, callback)

deleteRouter(request: protos.google.cloud.edgenetwork.v1.IDeleteRouterRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteRouterRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteSubnet(request, options)

deleteSubnet(request?: protos.google.cloud.edgenetwork.v1.IDeleteSubnetRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Deletes a single Subnet.

Parameters
NameDescription
request IDeleteSubnetRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.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. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes after the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callDeleteSubnet() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const [operation] = await edgenetworkClient.deleteSubnet(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callDeleteSubnet();

deleteSubnet(request, options, callback)

deleteSubnet(request: protos.google.cloud.edgenetwork.v1.IDeleteSubnetRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteSubnetRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteSubnet(request, callback)

deleteSubnet(request: protos.google.cloud.edgenetwork.v1.IDeleteSubnetRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDeleteSubnetRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

diagnoseInterconnect(request, options)

diagnoseInterconnect(request?: protos.google.cloud.edgenetwork.v1.IDiagnoseInterconnectRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.IDiagnoseInterconnectResponse,
        (protos.google.cloud.edgenetwork.v1.IDiagnoseInterconnectRequest | undefined),
        {} | undefined
    ]>;

Get the diagnostics of a single interconnect resource.

Parameters
NameDescription
request IDiagnoseInterconnectRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.IDiagnoseInterconnectResponse, (protos.google.cloud.edgenetwork.v1.IDiagnoseInterconnectRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DiagnoseInterconnectResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the interconnect resource.
   */
  // const name = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callDiagnoseInterconnect() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await edgenetworkClient.diagnoseInterconnect(request);
    console.log(response);
  }

  callDiagnoseInterconnect();

diagnoseInterconnect(request, options, callback)

diagnoseInterconnect(request: protos.google.cloud.edgenetwork.v1.IDiagnoseInterconnectRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgenetwork.v1.IDiagnoseInterconnectResponse, protos.google.cloud.edgenetwork.v1.IDiagnoseInterconnectRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDiagnoseInterconnectRequest
options CallOptions
callback Callback<protos.google.cloud.edgenetwork.v1.IDiagnoseInterconnectResponse, protos.google.cloud.edgenetwork.v1.IDiagnoseInterconnectRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

diagnoseInterconnect(request, callback)

diagnoseInterconnect(request: protos.google.cloud.edgenetwork.v1.IDiagnoseInterconnectRequest, callback: Callback<protos.google.cloud.edgenetwork.v1.IDiagnoseInterconnectResponse, protos.google.cloud.edgenetwork.v1.IDiagnoseInterconnectRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDiagnoseInterconnectRequest
callback Callback<protos.google.cloud.edgenetwork.v1.IDiagnoseInterconnectResponse, protos.google.cloud.edgenetwork.v1.IDiagnoseInterconnectRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

diagnoseNetwork(request, options)

diagnoseNetwork(request?: protos.google.cloud.edgenetwork.v1.IDiagnoseNetworkRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.IDiagnoseNetworkResponse,
        protos.google.cloud.edgenetwork.v1.IDiagnoseNetworkRequest | undefined,
        {} | undefined
    ]>;

Get the diagnostics of a single network resource.

Parameters
NameDescription
request IDiagnoseNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.IDiagnoseNetworkResponse, protos.google.cloud.edgenetwork.v1.IDiagnoseNetworkRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the network resource.
   */
  // const name = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callDiagnoseNetwork() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await edgenetworkClient.diagnoseNetwork(request);
    console.log(response);
  }

  callDiagnoseNetwork();

diagnoseNetwork(request, options, callback)

diagnoseNetwork(request: protos.google.cloud.edgenetwork.v1.IDiagnoseNetworkRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgenetwork.v1.IDiagnoseNetworkResponse, protos.google.cloud.edgenetwork.v1.IDiagnoseNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDiagnoseNetworkRequest
options CallOptions
callback Callback<protos.google.cloud.edgenetwork.v1.IDiagnoseNetworkResponse, protos.google.cloud.edgenetwork.v1.IDiagnoseNetworkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

diagnoseNetwork(request, callback)

diagnoseNetwork(request: protos.google.cloud.edgenetwork.v1.IDiagnoseNetworkRequest, callback: Callback<protos.google.cloud.edgenetwork.v1.IDiagnoseNetworkResponse, protos.google.cloud.edgenetwork.v1.IDiagnoseNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDiagnoseNetworkRequest
callback Callback<protos.google.cloud.edgenetwork.v1.IDiagnoseNetworkResponse, protos.google.cloud.edgenetwork.v1.IDiagnoseNetworkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

diagnoseRouter(request, options)

diagnoseRouter(request?: protos.google.cloud.edgenetwork.v1.IDiagnoseRouterRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.IDiagnoseRouterResponse,
        protos.google.cloud.edgenetwork.v1.IDiagnoseRouterRequest | undefined,
        {} | undefined
    ]>;

Get the diagnostics of a single router resource.

Parameters
NameDescription
request IDiagnoseRouterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.IDiagnoseRouterResponse, protos.google.cloud.edgenetwork.v1.IDiagnoseRouterRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing DiagnoseRouterResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the router resource.
   */
  // const name = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callDiagnoseRouter() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await edgenetworkClient.diagnoseRouter(request);
    console.log(response);
  }

  callDiagnoseRouter();

diagnoseRouter(request, options, callback)

diagnoseRouter(request: protos.google.cloud.edgenetwork.v1.IDiagnoseRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgenetwork.v1.IDiagnoseRouterResponse, protos.google.cloud.edgenetwork.v1.IDiagnoseRouterRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDiagnoseRouterRequest
options CallOptions
callback Callback<protos.google.cloud.edgenetwork.v1.IDiagnoseRouterResponse, protos.google.cloud.edgenetwork.v1.IDiagnoseRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

diagnoseRouter(request, callback)

diagnoseRouter(request: protos.google.cloud.edgenetwork.v1.IDiagnoseRouterRequest, callback: Callback<protos.google.cloud.edgenetwork.v1.IDiagnoseRouterResponse, protos.google.cloud.edgenetwork.v1.IDiagnoseRouterRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IDiagnoseRouterRequest
callback Callback<protos.google.cloud.edgenetwork.v1.IDiagnoseRouterResponse, protos.google.cloud.edgenetwork.v1.IDiagnoseRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getInterconnect(request, options)

getInterconnect(request?: protos.google.cloud.edgenetwork.v1.IGetInterconnectRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.IInterconnect,
        protos.google.cloud.edgenetwork.v1.IGetInterconnectRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single Interconnect.

Parameters
NameDescription
request IGetInterconnectRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.IInterconnect, protos.google.cloud.edgenetwork.v1.IGetInterconnectRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callGetInterconnect() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await edgenetworkClient.getInterconnect(request);
    console.log(response);
  }

  callGetInterconnect();

getInterconnect(request, options, callback)

getInterconnect(request: protos.google.cloud.edgenetwork.v1.IGetInterconnectRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgenetwork.v1.IInterconnect, protos.google.cloud.edgenetwork.v1.IGetInterconnectRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetInterconnectRequest
options CallOptions
callback Callback<protos.google.cloud.edgenetwork.v1.IInterconnect, protos.google.cloud.edgenetwork.v1.IGetInterconnectRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getInterconnect(request, callback)

getInterconnect(request: protos.google.cloud.edgenetwork.v1.IGetInterconnectRequest, callback: Callback<protos.google.cloud.edgenetwork.v1.IInterconnect, protos.google.cloud.edgenetwork.v1.IGetInterconnectRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetInterconnectRequest
callback Callback<protos.google.cloud.edgenetwork.v1.IInterconnect, protos.google.cloud.edgenetwork.v1.IGetInterconnectRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getInterconnectAttachment(request, options)

getInterconnectAttachment(request?: protos.google.cloud.edgenetwork.v1.IGetInterconnectAttachmentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.IInterconnectAttachment,
        (protos.google.cloud.edgenetwork.v1.IGetInterconnectAttachmentRequest | undefined),
        {} | undefined
    ]>;

Gets details of a single InterconnectAttachment.

Parameters
NameDescription
request IGetInterconnectAttachmentRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.IInterconnectAttachment, (protos.google.cloud.edgenetwork.v1.IGetInterconnectAttachmentRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing InterconnectAttachment. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callGetInterconnectAttachment() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await edgenetworkClient.getInterconnectAttachment(request);
    console.log(response);
  }

  callGetInterconnectAttachment();

getInterconnectAttachment(request, options, callback)

getInterconnectAttachment(request: protos.google.cloud.edgenetwork.v1.IGetInterconnectAttachmentRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgenetwork.v1.IInterconnectAttachment, protos.google.cloud.edgenetwork.v1.IGetInterconnectAttachmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetInterconnectAttachmentRequest
options CallOptions
callback Callback<protos.google.cloud.edgenetwork.v1.IInterconnectAttachment, protos.google.cloud.edgenetwork.v1.IGetInterconnectAttachmentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getInterconnectAttachment(request, callback)

getInterconnectAttachment(request: protos.google.cloud.edgenetwork.v1.IGetInterconnectAttachmentRequest, callback: Callback<protos.google.cloud.edgenetwork.v1.IInterconnectAttachment, protos.google.cloud.edgenetwork.v1.IGetInterconnectAttachmentRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetInterconnectAttachmentRequest
callback Callback<protos.google.cloud.edgenetwork.v1.IInterconnectAttachment, protos.google.cloud.edgenetwork.v1.IGetInterconnectAttachmentRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
NameDescription
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

options CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.

callback Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
Promise<google.cloud.location.ILocation>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

const [response] = await client.getLocation(request);

getNetwork(request, options)

getNetwork(request?: protos.google.cloud.edgenetwork.v1.IGetNetworkRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.INetwork,
        protos.google.cloud.edgenetwork.v1.IGetNetworkRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single Network.

Parameters
NameDescription
request IGetNetworkRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.INetwork, protos.google.cloud.edgenetwork.v1.IGetNetworkRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Network. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callGetNetwork() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await edgenetworkClient.getNetwork(request);
    console.log(response);
  }

  callGetNetwork();

getNetwork(request, options, callback)

getNetwork(request: protos.google.cloud.edgenetwork.v1.IGetNetworkRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgenetwork.v1.INetwork, protos.google.cloud.edgenetwork.v1.IGetNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetNetworkRequest
options CallOptions
callback Callback<protos.google.cloud.edgenetwork.v1.INetwork, protos.google.cloud.edgenetwork.v1.IGetNetworkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getNetwork(request, callback)

getNetwork(request: protos.google.cloud.edgenetwork.v1.IGetNetworkRequest, callback: Callback<protos.google.cloud.edgenetwork.v1.INetwork, protos.google.cloud.edgenetwork.v1.IGetNetworkRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetNetworkRequest
callback Callback<protos.google.cloud.edgenetwork.v1.INetwork, protos.google.cloud.edgenetwork.v1.IGetNetworkRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
NameDescription
request GetOperationRequest

The request object that will be sent.

options CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.

Returns
TypeDescription
Promise<[protos.google.longrunning.Operation]>
Example

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

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

getRouter(request, options)

getRouter(request?: protos.google.cloud.edgenetwork.v1.IGetRouterRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.IRouter,
        protos.google.cloud.edgenetwork.v1.IGetRouterRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single Router.

Parameters
NameDescription
request IGetRouterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IGetRouterRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callGetRouter() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await edgenetworkClient.getRouter(request);
    console.log(response);
  }

  callGetRouter();

getRouter(request, options, callback)

getRouter(request: protos.google.cloud.edgenetwork.v1.IGetRouterRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IGetRouterRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetRouterRequest
options CallOptions
callback Callback<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IGetRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getRouter(request, callback)

getRouter(request: protos.google.cloud.edgenetwork.v1.IGetRouterRequest, callback: Callback<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IGetRouterRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetRouterRequest
callback Callback<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IGetRouterRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getSubnet(request, options)

getSubnet(request?: protos.google.cloud.edgenetwork.v1.IGetSubnetRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.ISubnet,
        protos.google.cloud.edgenetwork.v1.IGetSubnetRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single Subnet.

Parameters
NameDescription
request IGetSubnetRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IGetSubnetRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Subnet. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callGetSubnet() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await edgenetworkClient.getSubnet(request);
    console.log(response);
  }

  callGetSubnet();

getSubnet(request, options, callback)

getSubnet(request: protos.google.cloud.edgenetwork.v1.IGetSubnetRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IGetSubnetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetSubnetRequest
options CallOptions
callback Callback<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IGetSubnetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getSubnet(request, callback)

getSubnet(request: protos.google.cloud.edgenetwork.v1.IGetSubnetRequest, callback: Callback<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IGetSubnetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetSubnetRequest
callback Callback<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IGetSubnetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getZone(request, options)

getZone(request?: protos.google.cloud.edgenetwork.v1.IGetZoneRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.IZone,
        protos.google.cloud.edgenetwork.v1.IGetZoneRequest | undefined,
        {} | undefined
    ]>;

Gets details of a single Zone.

Parameters
NameDescription
request IGetZoneRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.IZone, protos.google.cloud.edgenetwork.v1.IGetZoneRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Zone. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Name of the resource
   */
  // const name = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callGetZone() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await edgenetworkClient.getZone(request);
    console.log(response);
  }

  callGetZone();

getZone(request, options, callback)

getZone(request: protos.google.cloud.edgenetwork.v1.IGetZoneRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgenetwork.v1.IZone, protos.google.cloud.edgenetwork.v1.IGetZoneRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetZoneRequest
options CallOptions
callback Callback<protos.google.cloud.edgenetwork.v1.IZone, protos.google.cloud.edgenetwork.v1.IGetZoneRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getZone(request, callback)

getZone(request: protos.google.cloud.edgenetwork.v1.IGetZoneRequest, callback: Callback<protos.google.cloud.edgenetwork.v1.IZone, protos.google.cloud.edgenetwork.v1.IGetZoneRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IGetZoneRequest
callback Callback<protos.google.cloud.edgenetwork.v1.IZone, protos.google.cloud.edgenetwork.v1.IGetZoneRequest | null | undefined, {} | null | 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.

initializeZone(request, options)

initializeZone(request?: protos.google.cloud.edgenetwork.v1.IInitializeZoneRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.IInitializeZoneResponse,
        protos.google.cloud.edgenetwork.v1.IInitializeZoneRequest | undefined,
        {} | undefined
    ]>;

InitializeZone will initialize resources for a zone in a project.

Parameters
NameDescription
request IInitializeZoneRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.IInitializeZoneResponse, protos.google.cloud.edgenetwork.v1.IInitializeZoneRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing InitializeZoneResponse. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The name of the zone resource.
   */
  // const name = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callInitializeZone() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await edgenetworkClient.initializeZone(request);
    console.log(response);
  }

  callInitializeZone();

initializeZone(request, options, callback)

initializeZone(request: protos.google.cloud.edgenetwork.v1.IInitializeZoneRequest, options: CallOptions, callback: Callback<protos.google.cloud.edgenetwork.v1.IInitializeZoneResponse, protos.google.cloud.edgenetwork.v1.IInitializeZoneRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IInitializeZoneRequest
options CallOptions
callback Callback<protos.google.cloud.edgenetwork.v1.IInitializeZoneResponse, protos.google.cloud.edgenetwork.v1.IInitializeZoneRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

initializeZone(request, callback)

initializeZone(request: protos.google.cloud.edgenetwork.v1.IInitializeZoneRequest, callback: Callback<protos.google.cloud.edgenetwork.v1.IInitializeZoneResponse, protos.google.cloud.edgenetwork.v1.IInitializeZoneRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IInitializeZoneRequest
callback Callback<protos.google.cloud.edgenetwork.v1.IInitializeZoneResponse, protos.google.cloud.edgenetwork.v1.IInitializeZoneRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

interconnectAttachmentPath(project, location, zone, interconnectAttachment)

interconnectAttachmentPath(project: string, location: string, zone: string, interconnectAttachment: string): string;

Return a fully-qualified interconnectAttachment resource name string.

Parameters
NameDescription
project string
location string
zone string
interconnectAttachment string
Returns
TypeDescription
string

{string} Resource name string.

interconnectPath(project, location, zone, interconnect)

interconnectPath(project: string, location: string, zone: string, interconnect: string): string;

Return a fully-qualified interconnect resource name string.

Parameters
NameDescription
project string
location string
zone string
interconnect string
Returns
TypeDescription
string

{string} Resource name string.

listInterconnectAttachments(request, options)

listInterconnectAttachments(request?: protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.IInterconnectAttachment[],
        protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsRequest | null,
        protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsResponse
    ]>;

Lists InterconnectAttachments in a given project and location.

Parameters
NameDescription
request IListInterconnectAttachmentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.IInterconnectAttachment[], protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsRequest | null, protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of InterconnectAttachment. 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 listInterconnectAttachmentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInterconnectAttachments(request, options, callback)

listInterconnectAttachments(request: protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsRequest, protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IInterconnectAttachment>): void;
Parameters
NameDescription
request IListInterconnectAttachmentsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsRequest, protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IInterconnectAttachment>
Returns
TypeDescription
void

listInterconnectAttachments(request, callback)

listInterconnectAttachments(request: protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsRequest, callback: PaginationCallback<protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsRequest, protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IInterconnectAttachment>): void;
Parameters
NameDescription
request IListInterconnectAttachmentsRequest
callback PaginationCallback<protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsRequest, protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IInterconnectAttachment>
Returns
TypeDescription
void

listInterconnectAttachmentsAsync(request, options)

listInterconnectAttachmentsAsync(request?: protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.edgenetwork.v1.IInterconnectAttachment>;

Equivalent to listInterconnectAttachments, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListInterconnectAttachmentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.edgenetwork.v1.IInterconnectAttachment>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing InterconnectAttachment. 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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent value for ListInterconnectAttachmentsRequest
   */
  // const parent = 'abc123'
  /**
   *  Requested page size. Server may return fewer items than requested.
   *  If unspecified, server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Filtering results
   */
  // const filter = 'abc123'
  /**
   *  Hint for how to order the results
   */
  // const orderBy = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callListInterconnectAttachments() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await edgenetworkClient.listInterconnectAttachmentsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListInterconnectAttachments();

listInterconnectAttachmentsStream(request, options)

listInterconnectAttachmentsStream(request?: protos.google.cloud.edgenetwork.v1.IListInterconnectAttachmentsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListInterconnectAttachmentsRequest

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 InterconnectAttachment 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 listInterconnectAttachmentsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInterconnects(request, options)

listInterconnects(request?: protos.google.cloud.edgenetwork.v1.IListInterconnectsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.IInterconnect[],
        protos.google.cloud.edgenetwork.v1.IListInterconnectsRequest | null,
        protos.google.cloud.edgenetwork.v1.IListInterconnectsResponse
    ]>;

Lists Interconnects in a given project and location.

Parameters
NameDescription
request IListInterconnectsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.IInterconnect[], protos.google.cloud.edgenetwork.v1.IListInterconnectsRequest | null, protos.google.cloud.edgenetwork.v1.IListInterconnectsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listInterconnectsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInterconnects(request, options, callback)

listInterconnects(request: protos.google.cloud.edgenetwork.v1.IListInterconnectsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.edgenetwork.v1.IListInterconnectsRequest, protos.google.cloud.edgenetwork.v1.IListInterconnectsResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IInterconnect>): void;
Parameters
NameDescription
request IListInterconnectsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.edgenetwork.v1.IListInterconnectsRequest, protos.google.cloud.edgenetwork.v1.IListInterconnectsResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IInterconnect>
Returns
TypeDescription
void

listInterconnects(request, callback)

listInterconnects(request: protos.google.cloud.edgenetwork.v1.IListInterconnectsRequest, callback: PaginationCallback<protos.google.cloud.edgenetwork.v1.IListInterconnectsRequest, protos.google.cloud.edgenetwork.v1.IListInterconnectsResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IInterconnect>): void;
Parameters
NameDescription
request IListInterconnectsRequest
callback PaginationCallback<protos.google.cloud.edgenetwork.v1.IListInterconnectsRequest, protos.google.cloud.edgenetwork.v1.IListInterconnectsResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IInterconnect>
Returns
TypeDescription
void

listInterconnectsAsync(request, options)

listInterconnectsAsync(request?: protos.google.cloud.edgenetwork.v1.IListInterconnectsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.edgenetwork.v1.IInterconnect>;

Equivalent to listInterconnects, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListInterconnectsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.edgenetwork.v1.IInterconnect>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent value for ListInterconnectsRequest
   */
  // const parent = 'abc123'
  /**
   *  Requested page size. Server may return fewer items than requested.
   *  If unspecified, server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Filtering results
   */
  // const filter = 'abc123'
  /**
   *  Hint for how to order the results
   */
  // const orderBy = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callListInterconnects() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await edgenetworkClient.listInterconnectsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListInterconnects();

listInterconnectsStream(request, options)

listInterconnectsStream(request?: protos.google.cloud.edgenetwork.v1.IListInterconnectsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListInterconnectsRequest

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 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 listInterconnectsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<google.cloud.location.ILocation>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 for more details and examples.

Example

const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}

listNetworks(request, options)

listNetworks(request?: protos.google.cloud.edgenetwork.v1.IListNetworksRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.INetwork[],
        protos.google.cloud.edgenetwork.v1.IListNetworksRequest | null,
        protos.google.cloud.edgenetwork.v1.IListNetworksResponse
    ]>;

Lists Networks in a given project and location.

Parameters
NameDescription
request IListNetworksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.INetwork[], protos.google.cloud.edgenetwork.v1.IListNetworksRequest | null, protos.google.cloud.edgenetwork.v1.IListNetworksResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of Network. 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 listNetworksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNetworks(request, options, callback)

listNetworks(request: protos.google.cloud.edgenetwork.v1.IListNetworksRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.edgenetwork.v1.IListNetworksRequest, protos.google.cloud.edgenetwork.v1.IListNetworksResponse | null | undefined, protos.google.cloud.edgenetwork.v1.INetwork>): void;
Parameters
NameDescription
request IListNetworksRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.edgenetwork.v1.IListNetworksRequest, protos.google.cloud.edgenetwork.v1.IListNetworksResponse | null | undefined, protos.google.cloud.edgenetwork.v1.INetwork>
Returns
TypeDescription
void

listNetworks(request, callback)

listNetworks(request: protos.google.cloud.edgenetwork.v1.IListNetworksRequest, callback: PaginationCallback<protos.google.cloud.edgenetwork.v1.IListNetworksRequest, protos.google.cloud.edgenetwork.v1.IListNetworksResponse | null | undefined, protos.google.cloud.edgenetwork.v1.INetwork>): void;
Parameters
NameDescription
request IListNetworksRequest
callback PaginationCallback<protos.google.cloud.edgenetwork.v1.IListNetworksRequest, protos.google.cloud.edgenetwork.v1.IListNetworksResponse | null | undefined, protos.google.cloud.edgenetwork.v1.INetwork>
Returns
TypeDescription
void

listNetworksAsync(request, options)

listNetworksAsync(request?: protos.google.cloud.edgenetwork.v1.IListNetworksRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.edgenetwork.v1.INetwork>;

Equivalent to listNetworks, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListNetworksRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.edgenetwork.v1.INetwork>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Network. 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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent value for ListNetworksRequest
   */
  // const parent = 'abc123'
  /**
   *  Requested page size. Server may return fewer items than requested.
   *  If unspecified, server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Filtering results
   */
  // const filter = 'abc123'
  /**
   *  Hint for how to order the results
   */
  // const orderBy = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callListNetworks() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await edgenetworkClient.listNetworksAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListNetworks();

listNetworksStream(request, options)

listNetworksStream(request?: protos.google.cloud.edgenetwork.v1.IListNetworksRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListNetworksRequest

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 Network 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 listNetworksAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
NameDescription
request ListOperationsRequest

The request object that will be sent.

options CallOptions

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

Returns
TypeDescription
AsyncIterable<protos.google.longrunning.ListOperationsResponse>

{Object} An iterable Object that conforms to iteration protocols.

Example

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

listRouters(request, options)

listRouters(request?: protos.google.cloud.edgenetwork.v1.IListRoutersRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.IRouter[],
        protos.google.cloud.edgenetwork.v1.IListRoutersRequest | null,
        protos.google.cloud.edgenetwork.v1.IListRoutersResponse
    ]>;

Lists Routers in a given project and location.

Parameters
NameDescription
request IListRoutersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.IRouter[], protos.google.cloud.edgenetwork.v1.IListRoutersRequest | null, protos.google.cloud.edgenetwork.v1.IListRoutersResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of . 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 listRoutersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listRouters(request, options, callback)

listRouters(request: protos.google.cloud.edgenetwork.v1.IListRoutersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.edgenetwork.v1.IListRoutersRequest, protos.google.cloud.edgenetwork.v1.IListRoutersResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IRouter>): void;
Parameters
NameDescription
request IListRoutersRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.edgenetwork.v1.IListRoutersRequest, protos.google.cloud.edgenetwork.v1.IListRoutersResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IRouter>
Returns
TypeDescription
void

listRouters(request, callback)

listRouters(request: protos.google.cloud.edgenetwork.v1.IListRoutersRequest, callback: PaginationCallback<protos.google.cloud.edgenetwork.v1.IListRoutersRequest, protos.google.cloud.edgenetwork.v1.IListRoutersResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IRouter>): void;
Parameters
NameDescription
request IListRoutersRequest
callback PaginationCallback<protos.google.cloud.edgenetwork.v1.IListRoutersRequest, protos.google.cloud.edgenetwork.v1.IListRoutersResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IRouter>
Returns
TypeDescription
void

listRoutersAsync(request, options)

listRoutersAsync(request?: protos.google.cloud.edgenetwork.v1.IListRoutersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.edgenetwork.v1.IRouter>;

Equivalent to listRouters, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListRoutersRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.edgenetwork.v1.IRouter>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . 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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent value for ListRoutersRequest
   */
  // const parent = 'abc123'
  /**
   *  Requested page size. Server may return fewer items than requested.
   *  If unspecified, server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Filtering results
   */
  // const filter = 'abc123'
  /**
   *  Hint for how to order the results
   */
  // const orderBy = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callListRouters() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await edgenetworkClient.listRoutersAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListRouters();

listRoutersStream(request, options)

listRoutersStream(request?: protos.google.cloud.edgenetwork.v1.IListRoutersRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListRoutersRequest

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 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 listRoutersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSubnets(request, options)

listSubnets(request?: protos.google.cloud.edgenetwork.v1.IListSubnetsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.ISubnet[],
        protos.google.cloud.edgenetwork.v1.IListSubnetsRequest | null,
        protos.google.cloud.edgenetwork.v1.IListSubnetsResponse
    ]>;

Lists Subnets in a given project and location.

Parameters
NameDescription
request IListSubnetsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.ISubnet[], protos.google.cloud.edgenetwork.v1.IListSubnetsRequest | null, protos.google.cloud.edgenetwork.v1.IListSubnetsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of Subnet. 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 listSubnetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listSubnets(request, options, callback)

listSubnets(request: protos.google.cloud.edgenetwork.v1.IListSubnetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.edgenetwork.v1.IListSubnetsRequest, protos.google.cloud.edgenetwork.v1.IListSubnetsResponse | null | undefined, protos.google.cloud.edgenetwork.v1.ISubnet>): void;
Parameters
NameDescription
request IListSubnetsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.edgenetwork.v1.IListSubnetsRequest, protos.google.cloud.edgenetwork.v1.IListSubnetsResponse | null | undefined, protos.google.cloud.edgenetwork.v1.ISubnet>
Returns
TypeDescription
void

listSubnets(request, callback)

listSubnets(request: protos.google.cloud.edgenetwork.v1.IListSubnetsRequest, callback: PaginationCallback<protos.google.cloud.edgenetwork.v1.IListSubnetsRequest, protos.google.cloud.edgenetwork.v1.IListSubnetsResponse | null | undefined, protos.google.cloud.edgenetwork.v1.ISubnet>): void;
Parameters
NameDescription
request IListSubnetsRequest
callback PaginationCallback<protos.google.cloud.edgenetwork.v1.IListSubnetsRequest, protos.google.cloud.edgenetwork.v1.IListSubnetsResponse | null | undefined, protos.google.cloud.edgenetwork.v1.ISubnet>
Returns
TypeDescription
void

listSubnetsAsync(request, options)

listSubnetsAsync(request?: protos.google.cloud.edgenetwork.v1.IListSubnetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.edgenetwork.v1.ISubnet>;

Equivalent to listSubnets, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListSubnetsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.edgenetwork.v1.ISubnet>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Subnet. 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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent value for ListSubnetsRequest
   */
  // const parent = 'abc123'
  /**
   *  Requested page size. Server may return fewer items than requested.
   *  If unspecified, server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Filtering results
   */
  // const filter = 'abc123'
  /**
   *  Hint for how to order the results
   */
  // const orderBy = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callListSubnets() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await edgenetworkClient.listSubnetsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListSubnets();

listSubnetsStream(request, options)

listSubnetsStream(request?: protos.google.cloud.edgenetwork.v1.IListSubnetsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListSubnetsRequest

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 Subnet 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 listSubnetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listZones(request, options)

listZones(request?: protos.google.cloud.edgenetwork.v1.IListZonesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.edgenetwork.v1.IZone[],
        protos.google.cloud.edgenetwork.v1.IListZonesRequest | null,
        protos.google.cloud.edgenetwork.v1.IListZonesResponse
    ]>;

Lists Zones in a given project and location.

Parameters
NameDescription
request IListZonesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ protos.google.cloud.edgenetwork.v1.IZone[], protos.google.cloud.edgenetwork.v1.IListZonesRequest | null, protos.google.cloud.edgenetwork.v1.IListZonesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of Zone. 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 listZonesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listZones(request, options, callback)

listZones(request: protos.google.cloud.edgenetwork.v1.IListZonesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.edgenetwork.v1.IListZonesRequest, protos.google.cloud.edgenetwork.v1.IListZonesResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IZone>): void;
Parameters
NameDescription
request IListZonesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.edgenetwork.v1.IListZonesRequest, protos.google.cloud.edgenetwork.v1.IListZonesResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IZone>
Returns
TypeDescription
void

listZones(request, callback)

listZones(request: protos.google.cloud.edgenetwork.v1.IListZonesRequest, callback: PaginationCallback<protos.google.cloud.edgenetwork.v1.IListZonesRequest, protos.google.cloud.edgenetwork.v1.IListZonesResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IZone>): void;
Parameters
NameDescription
request IListZonesRequest
callback PaginationCallback<protos.google.cloud.edgenetwork.v1.IListZonesRequest, protos.google.cloud.edgenetwork.v1.IListZonesResponse | null | undefined, protos.google.cloud.edgenetwork.v1.IZone>
Returns
TypeDescription
void

listZonesAsync(request, options)

listZonesAsync(request?: protos.google.cloud.edgenetwork.v1.IListZonesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.edgenetwork.v1.IZone>;

Equivalent to listZones, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
NameDescription
request IListZonesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.edgenetwork.v1.IZone>

{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Zone. 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 for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Parent value for ListZonesRequest
   */
  // const parent = 'abc123'
  /**
   *  Requested page size. Server may return fewer items than requested.
   *  If unspecified, server will pick an appropriate default.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results the server should return.
   */
  // const pageToken = 'abc123'
  /**
   *  Filtering results
   */
  // const filter = 'abc123'
  /**
   *  Hint for how to order the results
   */
  // const orderBy = 'abc123'

  // Imports the Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callListZones() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = await edgenetworkClient.listZonesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListZones();

listZonesStream(request, options)

listZonesStream(request?: protos.google.cloud.edgenetwork.v1.IListZonesRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request IListZonesRequest

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 Zone 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 listZonesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchInterconnectAttachmentFromInterconnectAttachmentName(interconnectAttachmentName)

matchInterconnectAttachmentFromInterconnectAttachmentName(interconnectAttachmentName: string): string | number;

Parse the interconnect_attachment from InterconnectAttachment resource.

Parameter
NameDescription
interconnectAttachmentName string

A fully-qualified path representing InterconnectAttachment resource.

Returns
TypeDescription
string | number

{string} A string representing the interconnect_attachment.

matchInterconnectFromInterconnectName(interconnectName)

matchInterconnectFromInterconnectName(interconnectName: string): string | number;

Parse the interconnect from Interconnect resource.

Parameter
NameDescription
interconnectName string

A fully-qualified path representing Interconnect resource.

Returns
TypeDescription
string | number

{string} A string representing the interconnect.

matchLocationFromInterconnectAttachmentName(interconnectAttachmentName)

matchLocationFromInterconnectAttachmentName(interconnectAttachmentName: string): string | number;

Parse the location from InterconnectAttachment resource.

Parameter
NameDescription
interconnectAttachmentName string

A fully-qualified path representing InterconnectAttachment resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromInterconnectName(interconnectName)

matchLocationFromInterconnectName(interconnectName: string): string | number;

Parse the location from Interconnect resource.

Parameter
NameDescription
interconnectName string

A fully-qualified path representing Interconnect resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromNetworkName(networkName)

matchLocationFromNetworkName(networkName: string): string | number;

Parse the location from Network resource.

Parameter
NameDescription
networkName string

A fully-qualified path representing Network resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromRouterName(routerName)

matchLocationFromRouterName(routerName: string): string | number;

Parse the location from Router resource.

Parameter
NameDescription
routerName string

A fully-qualified path representing Router resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromSubnetName(subnetName)

matchLocationFromSubnetName(subnetName: string): string | number;

Parse the location from Subnet resource.

Parameter
NameDescription
subnetName string

A fully-qualified path representing Subnet resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromZoneName(zoneName)

matchLocationFromZoneName(zoneName: string): string | number;

Parse the location from Zone resource.

Parameter
NameDescription
zoneName string

A fully-qualified path representing Zone resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchNetworkFromNetworkName(networkName)

matchNetworkFromNetworkName(networkName: string): string | number;

Parse the network from Network resource.

Parameter
NameDescription
networkName string

A fully-qualified path representing Network resource.

Returns
TypeDescription
string | number

{string} A string representing the network.

matchProjectFromInterconnectAttachmentName(interconnectAttachmentName)

matchProjectFromInterconnectAttachmentName(interconnectAttachmentName: string): string | number;

Parse the project from InterconnectAttachment resource.

Parameter
NameDescription
interconnectAttachmentName string

A fully-qualified path representing InterconnectAttachment resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromInterconnectName(interconnectName)

matchProjectFromInterconnectName(interconnectName: string): string | number;

Parse the project from Interconnect resource.

Parameter
NameDescription
interconnectName string

A fully-qualified path representing Interconnect resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromNetworkName(networkName)

matchProjectFromNetworkName(networkName: string): string | number;

Parse the project from Network resource.

Parameter
NameDescription
networkName string

A fully-qualified path representing Network resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
NameDescription
projectName string

A fully-qualified path representing Project resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromRouterName(routerName)

matchProjectFromRouterName(routerName: string): string | number;

Parse the project from Router resource.

Parameter
NameDescription
routerName string

A fully-qualified path representing Router resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromSubnetName(subnetName)

matchProjectFromSubnetName(subnetName: string): string | number;

Parse the project from Subnet resource.

Parameter
NameDescription
subnetName string

A fully-qualified path representing Subnet resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromZoneName(zoneName)

matchProjectFromZoneName(zoneName: string): string | number;

Parse the project from Zone resource.

Parameter
NameDescription
zoneName string

A fully-qualified path representing Zone resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchRouterFromRouterName(routerName)

matchRouterFromRouterName(routerName: string): string | number;

Parse the router from Router resource.

Parameter
NameDescription
routerName string

A fully-qualified path representing Router resource.

Returns
TypeDescription
string | number

{string} A string representing the router.

matchSubnetFromSubnetName(subnetName)

matchSubnetFromSubnetName(subnetName: string): string | number;

Parse the subnet from Subnet resource.

Parameter
NameDescription
subnetName string

A fully-qualified path representing Subnet resource.

Returns
TypeDescription
string | number

{string} A string representing the subnet.

matchZoneFromInterconnectAttachmentName(interconnectAttachmentName)

matchZoneFromInterconnectAttachmentName(interconnectAttachmentName: string): string | number;

Parse the zone from InterconnectAttachment resource.

Parameter
NameDescription
interconnectAttachmentName string

A fully-qualified path representing InterconnectAttachment resource.

Returns
TypeDescription
string | number

{string} A string representing the zone.

matchZoneFromInterconnectName(interconnectName)

matchZoneFromInterconnectName(interconnectName: string): string | number;

Parse the zone from Interconnect resource.

Parameter
NameDescription
interconnectName string

A fully-qualified path representing Interconnect resource.

Returns
TypeDescription
string | number

{string} A string representing the zone.

matchZoneFromNetworkName(networkName)

matchZoneFromNetworkName(networkName: string): string | number;

Parse the zone from Network resource.

Parameter
NameDescription
networkName string

A fully-qualified path representing Network resource.

Returns
TypeDescription
string | number

{string} A string representing the zone.

matchZoneFromRouterName(routerName)

matchZoneFromRouterName(routerName: string): string | number;

Parse the zone from Router resource.

Parameter
NameDescription
routerName string

A fully-qualified path representing Router resource.

Returns
TypeDescription
string | number

{string} A string representing the zone.

matchZoneFromSubnetName(subnetName)

matchZoneFromSubnetName(subnetName: string): string | number;

Parse the zone from Subnet resource.

Parameter
NameDescription
subnetName string

A fully-qualified path representing Subnet resource.

Returns
TypeDescription
string | number

{string} A string representing the zone.

matchZoneFromZoneName(zoneName)

matchZoneFromZoneName(zoneName: string): string | number;

Parse the zone from Zone resource.

Parameter
NameDescription
zoneName string

A fully-qualified path representing Zone resource.

Returns
TypeDescription
string | number

{string} A string representing the zone.

networkPath(project, location, zone, network)

networkPath(project: string, location: string, zone: string, network: string): string;

Return a fully-qualified network resource name string.

Parameters
NameDescription
project string
location string
zone string
network string
Returns
TypeDescription
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
NameDescription
project string
Returns
TypeDescription
string

{string} Resource name string.

routerPath(project, location, zone, router)

routerPath(project: string, location: string, zone: string, router: string): string;

Return a fully-qualified router resource name string.

Parameters
NameDescription
project string
location string
zone string
router string
Returns
TypeDescription
string

{string} Resource name string.

subnetPath(project, location, zone, subnet)

subnetPath(project: string, location: string, zone: string, subnet: string): string;

Return a fully-qualified subnet resource name string.

Parameters
NameDescription
project string
location string
zone string
subnet string
Returns
TypeDescription
string

{string} Resource name string.

updateRouter(request, options)

updateRouter(request?: protos.google.cloud.edgenetwork.v1.IUpdateRouterRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of a single Router.

Parameters
NameDescription
request IUpdateRouterRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.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. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  Router resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The resource being updated
   */
  // const router = {}
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callUpdateRouter() {
    // Construct request
    const request = {
      updateMask,
      router,
    };

    // Run request
    const [operation] = await edgenetworkClient.updateRouter(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateRouter();

updateRouter(request, options, callback)

updateRouter(request: protos.google.cloud.edgenetwork.v1.IUpdateRouterRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateRouterRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateRouter(request, callback)

updateRouter(request: protos.google.cloud.edgenetwork.v1.IUpdateRouterRequest, callback: Callback<LROperation<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateRouterRequest
callback Callback<LROperation<protos.google.cloud.edgenetwork.v1.IRouter, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateSubnet(request, options)

updateSubnet(request?: protos.google.cloud.edgenetwork.v1.IUpdateSubnetRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Updates the parameters of a single Subnet.

Parameters
NameDescription
request IUpdateSubnetRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.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. Its promise() method returns a promise you can await for. Please see the documentation for more details and examples.

Example

  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Field mask is used to specify the fields to be overwritten in the
   *  Subnet resource by the update.
   *  The fields specified in the update_mask are relative to the resource, not
   *  the full request. A field will be overwritten if it is in the mask. If the
   *  user does not provide a mask then all fields will be overwritten.
   */
  // const updateMask = {}
  /**
   *  Required. The resource being updated
   */
  // const subnet = {}
  /**
   *  Optional. 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. The server will
   *  guarantee that for at least 60 minutes since the first request.
   *  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 Edgenetwork library
  const {EdgeNetworkClient} = require('@google-cloud/edgenetwork').v1;

  // Instantiates a client
  const edgenetworkClient = new EdgeNetworkClient();

  async function callUpdateSubnet() {
    // Construct request
    const request = {
      updateMask,
      subnet,
    };

    // Run request
    const [operation] = await edgenetworkClient.updateSubnet(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callUpdateSubnet();

updateSubnet(request, options, callback)

updateSubnet(request: protos.google.cloud.edgenetwork.v1.IUpdateSubnetRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateSubnetRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateSubnet(request, callback)

updateSubnet(request: protos.google.cloud.edgenetwork.v1.IUpdateSubnetRequest, callback: Callback<LROperation<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request IUpdateSubnetRequest
callback Callback<LROperation<protos.google.cloud.edgenetwork.v1.ISubnet, protos.google.cloud.edgenetwork.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

zonePath(project, location, zone)

zonePath(project: string, location: string, zone: string): string;

Return a fully-qualified zone resource name string.

Parameters
NameDescription
project string
location string
zone string
Returns
TypeDescription
string

{string} Resource name string.