Package
@google-cloud/compute
Constructors
(constructor)(opts)
constructor(opts?: ClientOptions);
Construct an instance of LicenseCodesClient.
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.
auth
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
licenseCodesStub
licenseCodesStub?: Promise<{
[name: string]: Function;
}>;
port
static get port(): number;
The port for this API service.
scopes
static get scopes(): string[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static get servicePath(): string;
The DNS address for this API service.
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
close()
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.
|
get(request, options)
get(request?: protos.google.cloud.compute.v1.IGetLicenseCodeRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.ILicenseCode,
protos.google.cloud.compute.v1.IGetLicenseCodeRequest | undefined,
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IGetLicenseCodeRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.compute.v1.ILicenseCode,
protos.google.cloud.compute.v1.IGetLicenseCodeRequest | undefined,
{} | undefined
]> | |
get(request, options, callback)
get(request: protos.google.cloud.compute.v1.IGetLicenseCodeRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.ILicenseCode, protos.google.cloud.compute.v1.IGetLicenseCodeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IGetLicenseCodeRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.ILicenseCode, protos.google.cloud.compute.v1.IGetLicenseCodeRequest | null | undefined, {} | null | undefined>
|
Returns
get(request, callback)
get(request: protos.google.cloud.compute.v1.IGetLicenseCodeRequest, callback: Callback<protos.google.cloud.compute.v1.ILicenseCode, protos.google.cloud.compute.v1.IGetLicenseCodeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.IGetLicenseCodeRequest
|
callback |
Callback<protos.google.cloud.compute.v1.ILicenseCode, protos.google.cloud.compute.v1.IGetLicenseCodeRequest | null | undefined, {} | null | undefined>
|
Returns
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
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.
|
testIamPermissions(request, options)
testIamPermissions(request?: protos.google.cloud.compute.v1.ITestIamPermissionsLicenseCodeRequest, options?: CallOptions): Promise<[
protos.google.cloud.compute.v1.ITestPermissionsResponse,
(protos.google.cloud.compute.v1.ITestIamPermissionsLicenseCodeRequest | undefined),
{} | undefined
]>;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ITestIamPermissionsLicenseCodeRequest
|
options |
CallOptions
|
Returns
Type | Description |
Promise<[
protos.google.cloud.compute.v1.ITestPermissionsResponse,
(protos.google.cloud.compute.v1.ITestIamPermissionsLicenseCodeRequest | undefined),
{} | undefined
]> | |
testIamPermissions(request, options, callback)
testIamPermissions(request: protos.google.cloud.compute.v1.ITestIamPermissionsLicenseCodeRequest, options: CallOptions, callback: Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsLicenseCodeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ITestIamPermissionsLicenseCodeRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsLicenseCodeRequest | null | undefined, {} | null | undefined>
|
Returns
testIamPermissions(request, callback)
testIamPermissions(request: protos.google.cloud.compute.v1.ITestIamPermissionsLicenseCodeRequest, callback: Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsLicenseCodeRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name | Description |
request |
protos.google.cloud.compute.v1.ITestIamPermissionsLicenseCodeRequest
|
callback |
Callback<protos.google.cloud.compute.v1.ITestPermissionsResponse, protos.google.cloud.compute.v1.ITestIamPermissionsLicenseCodeRequest | null | undefined, {} | null | undefined>
|
Returns