Class v1.ApiGatewayServiceClient (1.1.6)

The API Gateway Service is the interface for managing API Gateways. v1

Package

@google-cloud/api-gateway!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of ApiGatewayServiceClient.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

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

Property Value
Type Description
string

apiGatewayServiceStub

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

auth

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

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

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

operationsClient

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

pathTemplates

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

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

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

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

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

Methods

apiConfigPath(project, api, apiConfig)

apiConfigPath(project: string, api: string, apiConfig: string): string;

Return a fully-qualified apiConfig resource name string.

Parameters
Name Description
project string
api string
apiConfig string
Returns
Type Description
string

{string} Resource name string.

apiPath(project, api)

apiPath(project: string, api: string): string;

Return a fully-qualified api resource name string.

Parameters
Name Description
project string
api string
Returns
Type Description
string

{string} Resource name string.

checkCreateApiConfigProgress(name)

checkCreateApiConfigProgress(name: string): Promise<LROperation<protos.google.cloud.apigateway.v1.ApiConfig, protos.google.cloud.apigateway.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.apigateway.v1.ApiConfig, protos.google.cloud.apigateway.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkCreateApiProgress(name)

checkCreateApiProgress(name: string): Promise<LROperation<protos.google.cloud.apigateway.v1.Api, protos.google.cloud.apigateway.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.apigateway.v1.Api, protos.google.cloud.apigateway.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkCreateGatewayProgress(name)

checkCreateGatewayProgress(name: string): Promise<LROperation<protos.google.cloud.apigateway.v1.Gateway, protos.google.cloud.apigateway.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.apigateway.v1.Gateway, protos.google.cloud.apigateway.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkDeleteApiConfigProgress(name)

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

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.apigateway.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkDeleteApiProgress(name)

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

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.apigateway.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkDeleteGatewayProgress(name)

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

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.apigateway.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkUpdateApiConfigProgress(name)

checkUpdateApiConfigProgress(name: string): Promise<LROperation<protos.google.cloud.apigateway.v1.ApiConfig, protos.google.cloud.apigateway.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.apigateway.v1.ApiConfig, protos.google.cloud.apigateway.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkUpdateApiProgress(name)

checkUpdateApiProgress(name: string): Promise<LROperation<protos.google.cloud.apigateway.v1.Api, protos.google.cloud.apigateway.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.apigateway.v1.Api, protos.google.cloud.apigateway.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

checkUpdateGatewayProgress(name)

checkUpdateGatewayProgress(name: string): Promise<LROperation<protos.google.cloud.apigateway.v1.Gateway, protos.google.cloud.apigateway.v1.OperationMetadata>>;

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

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.apigateway.v1.Gateway, protos.google.cloud.apigateway.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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

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

Returns
Type Description
Promise<void>

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

createApi(request, options)

createApi(request?: protos.google.cloud.apigateway.v1.ICreateApiRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.ICreateApiRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

createApi(request, options, callback)

createApi(request: protos.google.cloud.apigateway.v1.ICreateApiRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.ICreateApiRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createApi(request, callback)

createApi(request: protos.google.cloud.apigateway.v1.ICreateApiRequest, callback: Callback<LROperation<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.ICreateApiRequest
callback Callback<LROperation<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createApiConfig(request, options)

createApiConfig(request?: protos.google.cloud.apigateway.v1.ICreateApiConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.ICreateApiConfigRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

createApiConfig(request, options, callback)

createApiConfig(request: protos.google.cloud.apigateway.v1.ICreateApiConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.ICreateApiConfigRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createApiConfig(request, callback)

createApiConfig(request: protos.google.cloud.apigateway.v1.ICreateApiConfigRequest, callback: Callback<LROperation<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.ICreateApiConfigRequest
callback Callback<LROperation<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createGateway(request, options)

createGateway(request?: protos.google.cloud.apigateway.v1.ICreateGatewayRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.ICreateGatewayRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

createGateway(request, options, callback)

createGateway(request: protos.google.cloud.apigateway.v1.ICreateGatewayRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.ICreateGatewayRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

createGateway(request, callback)

createGateway(request: protos.google.cloud.apigateway.v1.ICreateGatewayRequest, callback: Callback<LROperation<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.ICreateGatewayRequest
callback Callback<LROperation<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteApi(request, options)

deleteApi(request?: protos.google.cloud.apigateway.v1.IDeleteApiRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IDeleteApiRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

deleteApi(request, options, callback)

deleteApi(request: protos.google.cloud.apigateway.v1.IDeleteApiRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IDeleteApiRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteApi(request, callback)

deleteApi(request: protos.google.cloud.apigateway.v1.IDeleteApiRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IDeleteApiRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteApiConfig(request, options)

deleteApiConfig(request?: protos.google.cloud.apigateway.v1.IDeleteApiConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IDeleteApiConfigRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

deleteApiConfig(request, options, callback)

deleteApiConfig(request: protos.google.cloud.apigateway.v1.IDeleteApiConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IDeleteApiConfigRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteApiConfig(request, callback)

deleteApiConfig(request: protos.google.cloud.apigateway.v1.IDeleteApiConfigRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IDeleteApiConfigRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteGateway(request, options)

deleteGateway(request?: protos.google.cloud.apigateway.v1.IDeleteGatewayRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IDeleteGatewayRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

deleteGateway(request, options, callback)

deleteGateway(request: protos.google.cloud.apigateway.v1.IDeleteGatewayRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IDeleteGatewayRequest
options CallOptions
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

deleteGateway(request, callback)

deleteGateway(request: protos.google.cloud.apigateway.v1.IDeleteGatewayRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IDeleteGatewayRequest
callback Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

gatewayPath(project, location, gateway)

gatewayPath(project: string, location: string, gateway: string): string;

Return a fully-qualified gateway resource name string.

Parameters
Name Description
project string
location string
gateway string
Returns
Type Description
string

{string} Resource name string.

getApi(request, options)

getApi(request?: protos.google.cloud.apigateway.v1.IGetApiRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigateway.v1.IApi,
        protos.google.cloud.apigateway.v1.IGetApiRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IGetApiRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IGetApiRequest | undefined, {} | undefined ]>

getApi(request, options, callback)

getApi(request: protos.google.cloud.apigateway.v1.IGetApiRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IGetApiRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IGetApiRequest
options CallOptions
callback Callback<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IGetApiRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getApi(request, callback)

getApi(request: protos.google.cloud.apigateway.v1.IGetApiRequest, callback: Callback<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IGetApiRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IGetApiRequest
callback Callback<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IGetApiRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getApiConfig(request, options)

getApiConfig(request?: protos.google.cloud.apigateway.v1.IGetApiConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigateway.v1.IApiConfig,
        protos.google.cloud.apigateway.v1.IGetApiConfigRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IGetApiConfigRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IGetApiConfigRequest | undefined, {} | undefined ]>

getApiConfig(request, options, callback)

getApiConfig(request: protos.google.cloud.apigateway.v1.IGetApiConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IGetApiConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IGetApiConfigRequest
options CallOptions
callback Callback<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IGetApiConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getApiConfig(request, callback)

getApiConfig(request: protos.google.cloud.apigateway.v1.IGetApiConfigRequest, callback: Callback<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IGetApiConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IGetApiConfigRequest
callback Callback<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IGetApiConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getGateway(request, options)

getGateway(request?: protos.google.cloud.apigateway.v1.IGetGatewayRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigateway.v1.IGateway,
        protos.google.cloud.apigateway.v1.IGetGatewayRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IGetGatewayRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IGetGatewayRequest | undefined, {} | undefined ]>

getGateway(request, options, callback)

getGateway(request: protos.google.cloud.apigateway.v1.IGetGatewayRequest, options: CallOptions, callback: Callback<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IGetGatewayRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IGetGatewayRequest
options CallOptions
callback Callback<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IGetGatewayRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getGateway(request, callback)

getGateway(request: protos.google.cloud.apigateway.v1.IGetGatewayRequest, callback: Callback<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IGetGatewayRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IGetGatewayRequest
callback Callback<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IGetGatewayRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

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

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

initialize()

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

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

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

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

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

listApiConfigs(request, options)

listApiConfigs(request?: protos.google.cloud.apigateway.v1.IListApiConfigsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigateway.v1.IApiConfig[],
        protos.google.cloud.apigateway.v1.IListApiConfigsRequest | null,
        protos.google.cloud.apigateway.v1.IListApiConfigsResponse
    ]>;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IListApiConfigsRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.apigateway.v1.IApiConfig[], protos.google.cloud.apigateway.v1.IListApiConfigsRequest | null, protos.google.cloud.apigateway.v1.IListApiConfigsResponse ]>

listApiConfigs(request, options, callback)

listApiConfigs(request: protos.google.cloud.apigateway.v1.IListApiConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.apigateway.v1.IListApiConfigsRequest, protos.google.cloud.apigateway.v1.IListApiConfigsResponse | null | undefined, protos.google.cloud.apigateway.v1.IApiConfig>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IListApiConfigsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.apigateway.v1.IListApiConfigsRequest, protos.google.cloud.apigateway.v1.IListApiConfigsResponse | null | undefined, protos.google.cloud.apigateway.v1.IApiConfig>
Returns
Type Description
void

listApiConfigs(request, callback)

listApiConfigs(request: protos.google.cloud.apigateway.v1.IListApiConfigsRequest, callback: PaginationCallback<protos.google.cloud.apigateway.v1.IListApiConfigsRequest, protos.google.cloud.apigateway.v1.IListApiConfigsResponse | null | undefined, protos.google.cloud.apigateway.v1.IApiConfig>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IListApiConfigsRequest
callback PaginationCallback<protos.google.cloud.apigateway.v1.IListApiConfigsRequest, protos.google.cloud.apigateway.v1.IListApiConfigsResponse | null | undefined, protos.google.cloud.apigateway.v1.IApiConfig>
Returns
Type Description
void

listApiConfigsAsync(request, options)

listApiConfigsAsync(request?: protos.google.cloud.apigateway.v1.IListApiConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.apigateway.v1.IApiConfig>;

Equivalent to listApiConfigs, but returns an iterable object.

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

Parameters
Name Description
request protos.google.cloud.apigateway.v1.IListApiConfigsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.apigateway.v1.IApiConfig>

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

listApiConfigsStream(request, options)

listApiConfigsStream(request?: protos.google.cloud.apigateway.v1.IListApiConfigsRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.apigateway.v1.IListApiConfigsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [ApiConfig] 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 listApiConfigsAsync() 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.

listApis(request, options)

listApis(request?: protos.google.cloud.apigateway.v1.IListApisRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigateway.v1.IApi[],
        protos.google.cloud.apigateway.v1.IListApisRequest | null,
        protos.google.cloud.apigateway.v1.IListApisResponse
    ]>;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IListApisRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.apigateway.v1.IApi[], protos.google.cloud.apigateway.v1.IListApisRequest | null, protos.google.cloud.apigateway.v1.IListApisResponse ]>

listApis(request, options, callback)

listApis(request: protos.google.cloud.apigateway.v1.IListApisRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.apigateway.v1.IListApisRequest, protos.google.cloud.apigateway.v1.IListApisResponse | null | undefined, protos.google.cloud.apigateway.v1.IApi>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IListApisRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.apigateway.v1.IListApisRequest, protos.google.cloud.apigateway.v1.IListApisResponse | null | undefined, protos.google.cloud.apigateway.v1.IApi>
Returns
Type Description
void

listApis(request, callback)

listApis(request: protos.google.cloud.apigateway.v1.IListApisRequest, callback: PaginationCallback<protos.google.cloud.apigateway.v1.IListApisRequest, protos.google.cloud.apigateway.v1.IListApisResponse | null | undefined, protos.google.cloud.apigateway.v1.IApi>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IListApisRequest
callback PaginationCallback<protos.google.cloud.apigateway.v1.IListApisRequest, protos.google.cloud.apigateway.v1.IListApisResponse | null | undefined, protos.google.cloud.apigateway.v1.IApi>
Returns
Type Description
void

listApisAsync(request, options)

listApisAsync(request?: protos.google.cloud.apigateway.v1.IListApisRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.apigateway.v1.IApi>;

Equivalent to listApis, but returns an iterable object.

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

Parameters
Name Description
request protos.google.cloud.apigateway.v1.IListApisRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.apigateway.v1.IApi>

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

listApisStream(request, options)

listApisStream(request?: protos.google.cloud.apigateway.v1.IListApisRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.apigateway.v1.IListApisRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Api] 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 listApisAsync() 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.

listGateways(request, options)

listGateways(request?: protos.google.cloud.apigateway.v1.IListGatewaysRequest, options?: CallOptions): Promise<[
        protos.google.cloud.apigateway.v1.IGateway[],
        protos.google.cloud.apigateway.v1.IListGatewaysRequest | null,
        protos.google.cloud.apigateway.v1.IListGatewaysResponse
    ]>;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IListGatewaysRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.apigateway.v1.IGateway[], protos.google.cloud.apigateway.v1.IListGatewaysRequest | null, protos.google.cloud.apigateway.v1.IListGatewaysResponse ]>

listGateways(request, options, callback)

listGateways(request: protos.google.cloud.apigateway.v1.IListGatewaysRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.apigateway.v1.IListGatewaysRequest, protos.google.cloud.apigateway.v1.IListGatewaysResponse | null | undefined, protos.google.cloud.apigateway.v1.IGateway>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IListGatewaysRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.apigateway.v1.IListGatewaysRequest, protos.google.cloud.apigateway.v1.IListGatewaysResponse | null | undefined, protos.google.cloud.apigateway.v1.IGateway>
Returns
Type Description
void

listGateways(request, callback)

listGateways(request: protos.google.cloud.apigateway.v1.IListGatewaysRequest, callback: PaginationCallback<protos.google.cloud.apigateway.v1.IListGatewaysRequest, protos.google.cloud.apigateway.v1.IListGatewaysResponse | null | undefined, protos.google.cloud.apigateway.v1.IGateway>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IListGatewaysRequest
callback PaginationCallback<protos.google.cloud.apigateway.v1.IListGatewaysRequest, protos.google.cloud.apigateway.v1.IListGatewaysResponse | null | undefined, protos.google.cloud.apigateway.v1.IGateway>
Returns
Type Description
void

listGatewaysAsync(request, options)

listGatewaysAsync(request?: protos.google.cloud.apigateway.v1.IListGatewaysRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.apigateway.v1.IGateway>;

Equivalent to listGateways, but returns an iterable object.

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

Parameters
Name Description
request protos.google.cloud.apigateway.v1.IListGatewaysRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.cloud.apigateway.v1.IGateway>

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

listGatewaysStream(request, options)

listGatewaysStream(request?: protos.google.cloud.apigateway.v1.IListGatewaysRequest, options?: CallOptions): Transform;

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

Parameters
Name Description
request protos.google.cloud.apigateway.v1.IListGatewaysRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [Gateway] 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 listGatewaysAsync() 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.

matchApiConfigFromApiConfigName(apiConfigName)

matchApiConfigFromApiConfigName(apiConfigName: string): string | number;

Parse the api_config from ApiConfig resource.

Parameter
Name Description
apiConfigName string

A fully-qualified path representing ApiConfig resource.
Returns
Type Description
string | number

{string} A string representing the api_config.

matchApiFromApiConfigName(apiConfigName)

matchApiFromApiConfigName(apiConfigName: string): string | number;

Parse the api from ApiConfig resource.

Parameter
Name Description
apiConfigName string

A fully-qualified path representing ApiConfig resource.
Returns
Type Description
string | number

{string} A string representing the api.

matchApiFromApiName(apiName)

matchApiFromApiName(apiName: string): string | number;

Parse the api from Api resource.

Parameter
Name Description
apiName string

A fully-qualified path representing Api resource.
Returns
Type Description
string | number

{string} A string representing the api.

matchGatewayFromGatewayName(gatewayName)

matchGatewayFromGatewayName(gatewayName: string): string | number;

Parse the gateway from Gateway resource.

Parameter
Name Description
gatewayName string

A fully-qualified path representing Gateway resource.
Returns
Type Description
string | number

{string} A string representing the gateway.

matchLocationFromGatewayName(gatewayName)

matchLocationFromGatewayName(gatewayName: string): string | number;

Parse the location from Gateway resource.

Parameter
Name Description
gatewayName string

A fully-qualified path representing Gateway resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchProjectFromApiConfigName(apiConfigName)

matchProjectFromApiConfigName(apiConfigName: string): string | number;

Parse the project from ApiConfig resource.

Parameter
Name Description
apiConfigName string

A fully-qualified path representing ApiConfig resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromApiName(apiName)

matchProjectFromApiName(apiName: string): string | number;

Parse the project from Api resource.

Parameter
Name Description
apiName string

A fully-qualified path representing Api resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromGatewayName(gatewayName)

matchProjectFromGatewayName(gatewayName: string): string | number;

Parse the project from Gateway resource.

Parameter
Name Description
gatewayName string

A fully-qualified path representing Gateway resource.
Returns
Type Description
string | number

{string} A string representing the project.

updateApi(request, options)

updateApi(request?: protos.google.cloud.apigateway.v1.IUpdateApiRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IUpdateApiRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

updateApi(request, options, callback)

updateApi(request: protos.google.cloud.apigateway.v1.IUpdateApiRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IUpdateApiRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateApi(request, callback)

updateApi(request: protos.google.cloud.apigateway.v1.IUpdateApiRequest, callback: Callback<LROperation<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IUpdateApiRequest
callback Callback<LROperation<protos.google.cloud.apigateway.v1.IApi, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateApiConfig(request, options)

updateApiConfig(request?: protos.google.cloud.apigateway.v1.IUpdateApiConfigRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IUpdateApiConfigRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

updateApiConfig(request, options, callback)

updateApiConfig(request: protos.google.cloud.apigateway.v1.IUpdateApiConfigRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IUpdateApiConfigRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateApiConfig(request, callback)

updateApiConfig(request: protos.google.cloud.apigateway.v1.IUpdateApiConfigRequest, callback: Callback<LROperation<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IUpdateApiConfigRequest
callback Callback<LROperation<protos.google.cloud.apigateway.v1.IApiConfig, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateGateway(request, options)

updateGateway(request?: protos.google.cloud.apigateway.v1.IUpdateGatewayRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IUpdateGatewayRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

updateGateway(request, options, callback)

updateGateway(request: protos.google.cloud.apigateway.v1.IUpdateGatewayRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IUpdateGatewayRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateGateway(request, callback)

updateGateway(request: protos.google.cloud.apigateway.v1.IUpdateGatewayRequest, callback: Callback<LROperation<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.apigateway.v1.IUpdateGatewayRequest
callback Callback<LROperation<protos.google.cloud.apigateway.v1.IGateway, protos.google.cloud.apigateway.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void