Class v1.ServiceManagerClient (0.2.6)

[Google Service Management API](https://cloud.google.com/service-management/overview) v1

Package

@google-cloud/service-management!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of ServiceManagerClient.

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

auth

auth: gax.GoogleAuth;

Property Value

Type	Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;

Property Value

Type	Description
Descriptors

innerApiCalls

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

Property Value

Type	Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;

Property Value

Type	Description
gax.OperationsClient

port

static get port(): number;

The port for this API service.

Property Value

Type	Description
number

scopes

static get scopes(): string[];

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

Property Value

Type	Description
string[]

serviceManagerStub

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

Property Value

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

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

checkCreateServiceProgress(name)

checkCreateServiceProgress(name: string): Promise<LROperation<protos.google.api.servicemanagement.v1.ManagedService, protos.google.api.servicemanagement.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.api.servicemanagement.v1.ManagedService, protos.google.api.servicemanagement.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.

checkCreateServiceRolloutProgress(name)

checkCreateServiceRolloutProgress(name: string): Promise<LROperation<protos.google.api.servicemanagement.v1.Rollout, protos.google.api.servicemanagement.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.api.servicemanagement.v1.Rollout, protos.google.api.servicemanagement.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.

checkDeleteServiceProgress(name)

checkDeleteServiceProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.api.servicemanagement.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.protobuf.Empty, protos.google.api.servicemanagement.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.

checkDisableServiceProgress(name)

checkDisableServiceProgress(name: string): Promise<LROperation<protos.google.api.servicemanagement.v1.DisableServiceResponse, protos.google.api.servicemanagement.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.api.servicemanagement.v1.DisableServiceResponse, protos.google.api.servicemanagement.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.

checkEnableServiceProgress(name)

checkEnableServiceProgress(name: string): Promise<LROperation<protos.google.api.servicemanagement.v1.EnableServiceResponse, protos.google.api.servicemanagement.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.api.servicemanagement.v1.EnableServiceResponse, protos.google.api.servicemanagement.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.

checkSubmitConfigSourceProgress(name)

checkSubmitConfigSourceProgress(name: string): Promise<LROperation<protos.google.api.servicemanagement.v1.SubmitConfigSourceResponse, protos.google.api.servicemanagement.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.api.servicemanagement.v1.SubmitConfigSourceResponse, protos.google.api.servicemanagement.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.

checkUndeleteServiceProgress(name)

checkUndeleteServiceProgress(name: string): Promise<LROperation<protos.google.api.servicemanagement.v1.UndeleteServiceResponse, protos.google.api.servicemanagement.v1.OperationMetadata>>;

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

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise<LROperation<protos.google.api.servicemanagement.v1.UndeleteServiceResponse, protos.google.api.servicemanagement.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.

createService(request, options)

createService(request?: protos.google.api.servicemanagement.v1.ICreateServiceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.api.servicemanagement.v1.IManagedService, protos.google.api.servicemanagement.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.ICreateServiceRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.api.servicemanagement.v1.IManagedService, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

createService(request, options, callback)

createService(request: protos.google.api.servicemanagement.v1.ICreateServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.api.servicemanagement.v1.IManagedService, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.ICreateServiceRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.api.servicemanagement.v1.IManagedService, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createService(request, callback)

createService(request: protos.google.api.servicemanagement.v1.ICreateServiceRequest, callback: Callback<LROperation<protos.google.api.servicemanagement.v1.IManagedService, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.ICreateServiceRequest`
callback	`Callback<LROperation<protos.google.api.servicemanagement.v1.IManagedService, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createServiceConfig(request, options)

createServiceConfig(request?: protos.google.api.servicemanagement.v1.ICreateServiceConfigRequest, options?: CallOptions): Promise<[
        protos.google.api.IService,
        (protos.google.api.servicemanagement.v1.ICreateServiceConfigRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.ICreateServiceConfigRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.api.IService, (protos.google.api.servicemanagement.v1.ICreateServiceConfigRequest \| undefined), {} \| undefined ]>

createServiceConfig(request, options, callback)

createServiceConfig(request: protos.google.api.servicemanagement.v1.ICreateServiceConfigRequest, options: CallOptions, callback: Callback<protos.google.api.IService, protos.google.api.servicemanagement.v1.ICreateServiceConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.ICreateServiceConfigRequest`
options	`CallOptions`
callback	`Callback<protos.google.api.IService, protos.google.api.servicemanagement.v1.ICreateServiceConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createServiceConfig(request, callback)

createServiceConfig(request: protos.google.api.servicemanagement.v1.ICreateServiceConfigRequest, callback: Callback<protos.google.api.IService, protos.google.api.servicemanagement.v1.ICreateServiceConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.ICreateServiceConfigRequest`
callback	`Callback<protos.google.api.IService, protos.google.api.servicemanagement.v1.ICreateServiceConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createServiceRollout(request, options)

createServiceRollout(request?: protos.google.api.servicemanagement.v1.ICreateServiceRolloutRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.api.servicemanagement.v1.IRollout, protos.google.api.servicemanagement.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.ICreateServiceRolloutRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.api.servicemanagement.v1.IRollout, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

createServiceRollout(request, options, callback)

createServiceRollout(request: protos.google.api.servicemanagement.v1.ICreateServiceRolloutRequest, options: CallOptions, callback: Callback<LROperation<protos.google.api.servicemanagement.v1.IRollout, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.ICreateServiceRolloutRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.api.servicemanagement.v1.IRollout, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createServiceRollout(request, callback)

createServiceRollout(request: protos.google.api.servicemanagement.v1.ICreateServiceRolloutRequest, callback: Callback<LROperation<protos.google.api.servicemanagement.v1.IRollout, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.ICreateServiceRolloutRequest`
callback	`Callback<LROperation<protos.google.api.servicemanagement.v1.IRollout, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteService(request, options)

deleteService(request?: protos.google.api.servicemanagement.v1.IDeleteServiceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.protobuf.IEmpty, protos.google.api.servicemanagement.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IDeleteServiceRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.protobuf.IEmpty, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

deleteService(request, options, callback)

deleteService(request: protos.google.api.servicemanagement.v1.IDeleteServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IDeleteServiceRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteService(request, callback)

deleteService(request: protos.google.api.servicemanagement.v1.IDeleteServiceRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IDeleteServiceRequest`
callback	`Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

disableService(request, options)

disableService(request?: protos.google.api.servicemanagement.v1.IDisableServiceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.api.servicemanagement.v1.IDisableServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IDisableServiceRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.api.servicemanagement.v1.IDisableServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

disableService(request, options, callback)

disableService(request: protos.google.api.servicemanagement.v1.IDisableServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.api.servicemanagement.v1.IDisableServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IDisableServiceRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.api.servicemanagement.v1.IDisableServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

disableService(request, callback)

disableService(request: protos.google.api.servicemanagement.v1.IDisableServiceRequest, callback: Callback<LROperation<protos.google.api.servicemanagement.v1.IDisableServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IDisableServiceRequest`
callback	`Callback<LROperation<protos.google.api.servicemanagement.v1.IDisableServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

enableService(request, options)

enableService(request?: protos.google.api.servicemanagement.v1.IEnableServiceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.api.servicemanagement.v1.IEnableServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IEnableServiceRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.api.servicemanagement.v1.IEnableServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

enableService(request, options, callback)

enableService(request: protos.google.api.servicemanagement.v1.IEnableServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.api.servicemanagement.v1.IEnableServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IEnableServiceRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.api.servicemanagement.v1.IEnableServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

enableService(request, callback)

enableService(request: protos.google.api.servicemanagement.v1.IEnableServiceRequest, callback: Callback<LROperation<protos.google.api.servicemanagement.v1.IEnableServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IEnableServiceRequest`
callback	`Callback<LROperation<protos.google.api.servicemanagement.v1.IEnableServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

generateConfigReport(request, options)

generateConfigReport(request?: protos.google.api.servicemanagement.v1.IGenerateConfigReportRequest, options?: CallOptions): Promise<[
        protos.google.api.servicemanagement.v1.IGenerateConfigReportResponse,
        (protos.google.api.servicemanagement.v1.IGenerateConfigReportRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IGenerateConfigReportRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.api.servicemanagement.v1.IGenerateConfigReportResponse, (protos.google.api.servicemanagement.v1.IGenerateConfigReportRequest \| undefined), {} \| undefined ]>

generateConfigReport(request, options, callback)

generateConfigReport(request: protos.google.api.servicemanagement.v1.IGenerateConfigReportRequest, options: CallOptions, callback: Callback<protos.google.api.servicemanagement.v1.IGenerateConfigReportResponse, protos.google.api.servicemanagement.v1.IGenerateConfigReportRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IGenerateConfigReportRequest`
options	`CallOptions`
callback	`Callback<protos.google.api.servicemanagement.v1.IGenerateConfigReportResponse, protos.google.api.servicemanagement.v1.IGenerateConfigReportRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

generateConfigReport(request, callback)

generateConfigReport(request: protos.google.api.servicemanagement.v1.IGenerateConfigReportRequest, callback: Callback<protos.google.api.servicemanagement.v1.IGenerateConfigReportResponse, protos.google.api.servicemanagement.v1.IGenerateConfigReportRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IGenerateConfigReportRequest`
callback	`Callback<protos.google.api.servicemanagement.v1.IGenerateConfigReportResponse, protos.google.api.servicemanagement.v1.IGenerateConfigReportRequest \| 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

getService(request, options)

getService(request?: protos.google.api.servicemanagement.v1.IGetServiceRequest, options?: CallOptions): Promise<[
        protos.google.api.servicemanagement.v1.IManagedService,
        protos.google.api.servicemanagement.v1.IGetServiceRequest | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IGetServiceRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.api.servicemanagement.v1.IManagedService, protos.google.api.servicemanagement.v1.IGetServiceRequest \| undefined, {} \| undefined ]>

getService(request, options, callback)

getService(request: protos.google.api.servicemanagement.v1.IGetServiceRequest, options: CallOptions, callback: Callback<protos.google.api.servicemanagement.v1.IManagedService, protos.google.api.servicemanagement.v1.IGetServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IGetServiceRequest`
options	`CallOptions`
callback	`Callback<protos.google.api.servicemanagement.v1.IManagedService, protos.google.api.servicemanagement.v1.IGetServiceRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getService(request, callback)

getService(request: protos.google.api.servicemanagement.v1.IGetServiceRequest, callback: Callback<protos.google.api.servicemanagement.v1.IManagedService, protos.google.api.servicemanagement.v1.IGetServiceRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IGetServiceRequest`
callback	`Callback<protos.google.api.servicemanagement.v1.IManagedService, protos.google.api.servicemanagement.v1.IGetServiceRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getServiceConfig(request, options)

getServiceConfig(request?: protos.google.api.servicemanagement.v1.IGetServiceConfigRequest, options?: CallOptions): Promise<[
        protos.google.api.IService,
        (protos.google.api.servicemanagement.v1.IGetServiceConfigRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IGetServiceConfigRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.api.IService, (protos.google.api.servicemanagement.v1.IGetServiceConfigRequest \| undefined), {} \| undefined ]>

getServiceConfig(request, options, callback)

getServiceConfig(request: protos.google.api.servicemanagement.v1.IGetServiceConfigRequest, options: CallOptions, callback: Callback<protos.google.api.IService, protos.google.api.servicemanagement.v1.IGetServiceConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IGetServiceConfigRequest`
options	`CallOptions`
callback	`Callback<protos.google.api.IService, protos.google.api.servicemanagement.v1.IGetServiceConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getServiceConfig(request, callback)

getServiceConfig(request: protos.google.api.servicemanagement.v1.IGetServiceConfigRequest, callback: Callback<protos.google.api.IService, protos.google.api.servicemanagement.v1.IGetServiceConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IGetServiceConfigRequest`
callback	`Callback<protos.google.api.IService, protos.google.api.servicemanagement.v1.IGetServiceConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getServiceRollout(request, options)

getServiceRollout(request?: protos.google.api.servicemanagement.v1.IGetServiceRolloutRequest, options?: CallOptions): Promise<[
        protos.google.api.servicemanagement.v1.IRollout,
        (protos.google.api.servicemanagement.v1.IGetServiceRolloutRequest | undefined),
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IGetServiceRolloutRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.api.servicemanagement.v1.IRollout, (protos.google.api.servicemanagement.v1.IGetServiceRolloutRequest \| undefined), {} \| undefined ]>

getServiceRollout(request, options, callback)

getServiceRollout(request: protos.google.api.servicemanagement.v1.IGetServiceRolloutRequest, options: CallOptions, callback: Callback<protos.google.api.servicemanagement.v1.IRollout, protos.google.api.servicemanagement.v1.IGetServiceRolloutRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IGetServiceRolloutRequest`
options	`CallOptions`
callback	`Callback<protos.google.api.servicemanagement.v1.IRollout, protos.google.api.servicemanagement.v1.IGetServiceRolloutRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getServiceRollout(request, callback)

getServiceRollout(request: protos.google.api.servicemanagement.v1.IGetServiceRolloutRequest, callback: Callback<protos.google.api.servicemanagement.v1.IRollout, protos.google.api.servicemanagement.v1.IGetServiceRolloutRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IGetServiceRolloutRequest`
callback	`Callback<protos.google.api.servicemanagement.v1.IRollout, protos.google.api.servicemanagement.v1.IGetServiceRolloutRequest \| null \| undefined, {} \| null \| 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.

listServiceConfigs(request, options)

listServiceConfigs(request?: protos.google.api.servicemanagement.v1.IListServiceConfigsRequest, options?: CallOptions): Promise<[
        protos.google.api.IService[],
        protos.google.api.servicemanagement.v1.IListServiceConfigsRequest | null,
        protos.google.api.servicemanagement.v1.IListServiceConfigsResponse
    ]>;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IListServiceConfigsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.api.IService[], protos.google.api.servicemanagement.v1.IListServiceConfigsRequest \| null, protos.google.api.servicemanagement.v1.IListServiceConfigsResponse ]>

listServiceConfigs(request, options, callback)

listServiceConfigs(request: protos.google.api.servicemanagement.v1.IListServiceConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.api.servicemanagement.v1.IListServiceConfigsRequest, protos.google.api.servicemanagement.v1.IListServiceConfigsResponse | null | undefined, protos.google.api.IService>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IListServiceConfigsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.api.servicemanagement.v1.IListServiceConfigsRequest, protos.google.api.servicemanagement.v1.IListServiceConfigsResponse \| null \| undefined, protos.google.api.IService>`

Returns

Type	Description
void

listServiceConfigs(request, callback)

listServiceConfigs(request: protos.google.api.servicemanagement.v1.IListServiceConfigsRequest, callback: PaginationCallback<protos.google.api.servicemanagement.v1.IListServiceConfigsRequest, protos.google.api.servicemanagement.v1.IListServiceConfigsResponse | null | undefined, protos.google.api.IService>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IListServiceConfigsRequest`
callback	`PaginationCallback<protos.google.api.servicemanagement.v1.IListServiceConfigsRequest, protos.google.api.servicemanagement.v1.IListServiceConfigsResponse \| null \| undefined, protos.google.api.IService>`

Returns

Type	Description
void

listServiceConfigsAsync(request, options)

listServiceConfigsAsync(request?: protos.google.api.servicemanagement.v1.IListServiceConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.api.IService>;

Equivalent to listServiceConfigs, 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.api.servicemanagement.v1.IListServiceConfigsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.api.IService>

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

listServiceConfigsStream(request, options)

listServiceConfigsStream(request?: protos.google.api.servicemanagement.v1.IListServiceConfigsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IListServiceConfigsRequest` 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 [Service] 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 listServiceConfigsAsync() 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.

listServiceRollouts(request, options)

listServiceRollouts(request?: protos.google.api.servicemanagement.v1.IListServiceRolloutsRequest, options?: CallOptions): Promise<[
        protos.google.api.servicemanagement.v1.IRollout[],
        protos.google.api.servicemanagement.v1.IListServiceRolloutsRequest | null,
        protos.google.api.servicemanagement.v1.IListServiceRolloutsResponse
    ]>;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IListServiceRolloutsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.api.servicemanagement.v1.IRollout[], protos.google.api.servicemanagement.v1.IListServiceRolloutsRequest \| null, protos.google.api.servicemanagement.v1.IListServiceRolloutsResponse ]>

listServiceRollouts(request, options, callback)

listServiceRollouts(request: protos.google.api.servicemanagement.v1.IListServiceRolloutsRequest, options: CallOptions, callback: PaginationCallback<protos.google.api.servicemanagement.v1.IListServiceRolloutsRequest, protos.google.api.servicemanagement.v1.IListServiceRolloutsResponse | null | undefined, protos.google.api.servicemanagement.v1.IRollout>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IListServiceRolloutsRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.api.servicemanagement.v1.IListServiceRolloutsRequest, protos.google.api.servicemanagement.v1.IListServiceRolloutsResponse \| null \| undefined, protos.google.api.servicemanagement.v1.IRollout>`

Returns

Type	Description
void

listServiceRollouts(request, callback)

listServiceRollouts(request: protos.google.api.servicemanagement.v1.IListServiceRolloutsRequest, callback: PaginationCallback<protos.google.api.servicemanagement.v1.IListServiceRolloutsRequest, protos.google.api.servicemanagement.v1.IListServiceRolloutsResponse | null | undefined, protos.google.api.servicemanagement.v1.IRollout>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IListServiceRolloutsRequest`
callback	`PaginationCallback<protos.google.api.servicemanagement.v1.IListServiceRolloutsRequest, protos.google.api.servicemanagement.v1.IListServiceRolloutsResponse \| null \| undefined, protos.google.api.servicemanagement.v1.IRollout>`

Returns

Type	Description
void

listServiceRolloutsAsync(request, options)

listServiceRolloutsAsync(request?: protos.google.api.servicemanagement.v1.IListServiceRolloutsRequest, options?: CallOptions): AsyncIterable<protos.google.api.servicemanagement.v1.IRollout>;

Equivalent to listServiceRollouts, 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.api.servicemanagement.v1.IListServiceRolloutsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.api.servicemanagement.v1.IRollout>

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

listServiceRolloutsStream(request, options)

listServiceRolloutsStream(request?: protos.google.api.servicemanagement.v1.IListServiceRolloutsRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IListServiceRolloutsRequest` 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 [Rollout] 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 listServiceRolloutsAsync() 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.

listServices(request, options)

listServices(request?: protos.google.api.servicemanagement.v1.IListServicesRequest, options?: CallOptions): Promise<[
        protos.google.api.servicemanagement.v1.IManagedService[],
        protos.google.api.servicemanagement.v1.IListServicesRequest | null,
        protos.google.api.servicemanagement.v1.IListServicesResponse
    ]>;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IListServicesRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ protos.google.api.servicemanagement.v1.IManagedService[], protos.google.api.servicemanagement.v1.IListServicesRequest \| null, protos.google.api.servicemanagement.v1.IListServicesResponse ]>

listServices(request, options, callback)

listServices(request: protos.google.api.servicemanagement.v1.IListServicesRequest, options: CallOptions, callback: PaginationCallback<protos.google.api.servicemanagement.v1.IListServicesRequest, protos.google.api.servicemanagement.v1.IListServicesResponse | null | undefined, protos.google.api.servicemanagement.v1.IManagedService>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IListServicesRequest`
options	`CallOptions`
callback	`PaginationCallback<protos.google.api.servicemanagement.v1.IListServicesRequest, protos.google.api.servicemanagement.v1.IListServicesResponse \| null \| undefined, protos.google.api.servicemanagement.v1.IManagedService>`

Returns

Type	Description
void

listServices(request, callback)

listServices(request: protos.google.api.servicemanagement.v1.IListServicesRequest, callback: PaginationCallback<protos.google.api.servicemanagement.v1.IListServicesRequest, protos.google.api.servicemanagement.v1.IListServicesResponse | null | undefined, protos.google.api.servicemanagement.v1.IManagedService>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IListServicesRequest`
callback	`PaginationCallback<protos.google.api.servicemanagement.v1.IListServicesRequest, protos.google.api.servicemanagement.v1.IListServicesResponse \| null \| undefined, protos.google.api.servicemanagement.v1.IManagedService>`

Returns

Type	Description
void

listServicesAsync(request, options)

listServicesAsync(request?: protos.google.api.servicemanagement.v1.IListServicesRequest, options?: CallOptions): AsyncIterable<protos.google.api.servicemanagement.v1.IManagedService>;

Equivalent to listServices, 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.api.servicemanagement.v1.IListServicesRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.api.servicemanagement.v1.IManagedService>

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

listServicesStream(request, options)

listServicesStream(request?: protos.google.api.servicemanagement.v1.IListServicesRequest, options?: CallOptions): Transform;

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

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IListServicesRequest` 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 [ManagedService] 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 listServicesAsync() 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.

submitConfigSource(request, options)

submitConfigSource(request?: protos.google.api.servicemanagement.v1.ISubmitConfigSourceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.api.servicemanagement.v1.ISubmitConfigSourceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.ISubmitConfigSourceRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.api.servicemanagement.v1.ISubmitConfigSourceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

submitConfigSource(request, options, callback)

submitConfigSource(request: protos.google.api.servicemanagement.v1.ISubmitConfigSourceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.api.servicemanagement.v1.ISubmitConfigSourceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.ISubmitConfigSourceRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.api.servicemanagement.v1.ISubmitConfigSourceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

submitConfigSource(request, callback)

submitConfigSource(request: protos.google.api.servicemanagement.v1.ISubmitConfigSourceRequest, callback: Callback<LROperation<protos.google.api.servicemanagement.v1.ISubmitConfigSourceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.ISubmitConfigSourceRequest`
callback	`Callback<LROperation<protos.google.api.servicemanagement.v1.ISubmitConfigSourceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

undeleteService(request, options)

undeleteService(request?: protos.google.api.servicemanagement.v1.IUndeleteServiceRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.api.servicemanagement.v1.IUndeleteServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IUndeleteServiceRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[ LROperation<protos.google.api.servicemanagement.v1.IUndeleteServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| undefined, {} \| undefined ]>

undeleteService(request, options, callback)

undeleteService(request: protos.google.api.servicemanagement.v1.IUndeleteServiceRequest, options: CallOptions, callback: Callback<LROperation<protos.google.api.servicemanagement.v1.IUndeleteServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IUndeleteServiceRequest`
options	`CallOptions`
callback	`Callback<LROperation<protos.google.api.servicemanagement.v1.IUndeleteServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

undeleteService(request, callback)

undeleteService(request: protos.google.api.servicemanagement.v1.IUndeleteServiceRequest, callback: Callback<LROperation<protos.google.api.servicemanagement.v1.IUndeleteServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	`protos.google.api.servicemanagement.v1.IUndeleteServiceRequest`
callback	`Callback<LROperation<protos.google.api.servicemanagement.v1.IUndeleteServiceResponse, protos.google.api.servicemanagement.v1.IOperationMetadata>, protos.google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void