Class v1.InterconnectAttachmentsClient

The InterconnectAttachments API. v1

Package

@google-cloud/compute

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of InterconnectAttachmentsClient.

Parameter
NameDescription
opts ClientOptions

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;

innerApiCalls

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

interconnectAttachmentsStub

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

port

static get port(): number;

The port for this API service.

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

warn: (code: string, message: string, warnType?: string) => void;

Methods

aggregatedListAsync(request, options)

aggregatedListAsync(request?: protos.google.cloud.compute.v1.IAggregatedListInterconnectAttachmentsRequest, options?: CallOptions): AsyncIterable<[
        string,
        protos.google.cloud.compute.v1.IInterconnectAttachmentsScopedList
    ]>;

Equivalent to aggregatedList, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.compute.v1.IAggregatedListInterconnectAttachmentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<[ string, protos.google.cloud.compute.v1.IInterconnectAttachmentsScopedList ]>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing as tuple [string, [InterconnectAttachmentsScopedList]]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

const iterable = client.aggregatedListAsync(request);
for await (const [key, value] of iterable) {
  // process response
}

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
TypeDescription
Promise<void>

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

delete(request, options)

delete(request?: protos.google.cloud.compute.v1.IDeleteInterconnectAttachmentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IDeleteInterconnectAttachmentRequest
options CallOptions
Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>

delete(request, options, callback)

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

delete(request, callback)

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

get(request, options)

get(request?: protos.google.cloud.compute.v1.IGetInterconnectAttachmentRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IInterconnectAttachment,
        (protos.google.cloud.compute.v1.IGetInterconnectAttachmentRequest | undefined),
        {} | undefined
    ]>;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IGetInterconnectAttachmentRequest
options CallOptions
Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IInterconnectAttachment, (protos.google.cloud.compute.v1.IGetInterconnectAttachmentRequest | undefined), {} | undefined ]>

get(request, options, callback)

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

get(request, callback)

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

getProjectId()

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

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
NameDescription
callback Callback<string, undefined, undefined>
Returns
TypeDescription
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

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

{Promise} A promise that resolves to an authenticated service stub.

insert(request, options)

insert(request?: protos.google.cloud.compute.v1.IInsertInterconnectAttachmentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IInsertInterconnectAttachmentRequest
options CallOptions
Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>

insert(request, options, callback)

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

insert(request, callback)

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

list(request, options)

list(request?: protos.google.cloud.compute.v1.IListInterconnectAttachmentsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.compute.v1.IInterconnectAttachment[],
        protos.google.cloud.compute.v1.IListInterconnectAttachmentsRequest | null,
        protos.google.cloud.compute.v1.IInterconnectAttachmentList
    ]>;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IListInterconnectAttachmentsRequest
options CallOptions
Returns
TypeDescription
Promise<[ protos.google.cloud.compute.v1.IInterconnectAttachment[], protos.google.cloud.compute.v1.IListInterconnectAttachmentsRequest | null, protos.google.cloud.compute.v1.IInterconnectAttachmentList ]>

list(request, options, callback)

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

list(request, callback)

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

listAsync(request, options)

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

Equivalent to list, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.compute.v1.IListInterconnectAttachmentsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

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

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

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

listStream(request, options)

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

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

Parameters
NameDescription
request protos.google.cloud.compute.v1.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 listAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

patch(request, options)

patch(request?: protos.google.cloud.compute.v1.IPatchInterconnectAttachmentRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.compute.v1.IOperation, null>,
        protos.google.cloud.compute.v1.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
NameDescription
request protos.google.cloud.compute.v1.IPatchInterconnectAttachmentRequest
options CallOptions
Returns
TypeDescription
Promise<[ LROperation<protos.google.cloud.compute.v1.IOperation, null>, protos.google.cloud.compute.v1.IOperation | undefined, {} | undefined ]>

patch(request, options, callback)

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

patch(request, callback)

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