Service for providing machine types (tiers) for Cloud SQL. v1beta4
Package
@google-cloud/sqlConstructors
(constructor)(opts, gaxInstance)
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
Construct an instance of SqlTiersServiceClient.
Parameters | |
---|---|
Name | Description |
opts |
ClientOptions
|
gaxInstance |
typeof gax | typeof fallback
: loaded instance of |
Properties
apiEndpoint
get apiEndpoint(): string;
The DNS address for this API service.
apiEndpoint
static get apiEndpoint(): string;
The DNS address for this API service - same as servicePath.
auth
auth: gax.GoogleAuth;
descriptors
descriptors: Descriptors;
innerApiCalls
innerApiCalls: {
[name: string]: Function;
};
locationsClient
locationsClient: LocationsClient;
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.
sqlTiersServiceStub
sqlTiersServiceStub?: Promise<{
[name: string]: Function;
}>;
universeDomain
get universeDomain(): string;
warn
warn: (code: string, message: string, warnType?: string) => void;
Methods
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. |
getLocation(request, options, callback)
getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent. |
options |
CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Call options. See CallOptions for more details. |
callback |
Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
Promise<google.cloud.location.ILocation> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples. |
const [response] = await client.getLocation(request);
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. |
list(request, options)
list(request?: protos.google.cloud.sql.v1beta4.ISqlTiersListRequest, options?: CallOptions): Promise<[
protos.google.cloud.sql.v1beta4.ITiersListResponse,
protos.google.cloud.sql.v1beta4.ISqlTiersListRequest | undefined,
{} | undefined
]>;
Lists all available machine types (tiers) for Cloud SQL, for example, db-custom-1-3840
. For related information, see [Pricing](/sql/pricing).
Parameters | |
---|---|
Name | Description |
request |
ISqlTiersListRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
Promise<[
protos.google.cloud.sql.v1beta4.ITiersListResponse,
protos.google.cloud.sql.v1beta4.ISqlTiersListRequest | undefined,
{} | undefined
]> |
{Promise} - The promise which resolves to an array. The first element of the array is an object representing TiersListResponse. Please see the documentation for more details and examples. |
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Project ID of the project for which to list tiers.
*/
// const project = 'my-project'
// Imports the Sql library
const {SqlTiersServiceClient} = require('@google-cloud/sql').v1beta4;
// Instantiates a client
const sqlClient = new SqlTiersServiceClient();
async function callList() {
// Construct request
const request = {
};
// Run request
const response = await sqlClient.list(request);
console.log(response);
}
callList();
list(request, options, callback)
list(request: protos.google.cloud.sql.v1beta4.ISqlTiersListRequest, options: CallOptions, callback: Callback<protos.google.cloud.sql.v1beta4.ITiersListResponse, protos.google.cloud.sql.v1beta4.ISqlTiersListRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISqlTiersListRequest
|
options |
CallOptions
|
callback |
Callback<protos.google.cloud.sql.v1beta4.ITiersListResponse, protos.google.cloud.sql.v1beta4.ISqlTiersListRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
list(request, callback)
list(request: protos.google.cloud.sql.v1beta4.ISqlTiersListRequest, callback: Callback<protos.google.cloud.sql.v1beta4.ITiersListResponse, protos.google.cloud.sql.v1beta4.ISqlTiersListRequest | null | undefined, {} | null | undefined>): void;
Parameters | |
---|---|
Name | Description |
request |
ISqlTiersListRequest
|
callback |
Callback<protos.google.cloud.sql.v1beta4.ITiersListResponse, protos.google.cloud.sql.v1beta4.ISqlTiersListRequest | null | undefined, {} | null | undefined>
|
Returns | |
---|---|
Type | Description |
void |
listLocationsAsync(request, options)
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
Lists information about the supported locations for this service. Returns an iterable object.
for
-await
-of
syntax is used with the iterable to get response elements on-demand.
Parameters | |
---|---|
Name | Description |
request |
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent. |
options |
CallOptions
Call options. See CallOptions for more details. |
Returns | |
---|---|
Type | Description |
AsyncIterable<google.cloud.location.ILocation> |
{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples. |
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
// process response
}