Cloud SQL connect service. v1
Package
@google-cloud/sqlConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of SqlConnectServiceClient.
opts
ClientOptions
gaxInstance
typeof gax
| typeof fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new SqlConnectServiceClient({fallback: true}, gax); ```
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.
sqlConnectServiceStub
sqlConnectServiceStub
?:
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.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
generateEphemeralCert(request, options)
generateEphemeralCert
(
request
?:
protos
.
google
.
cloud
.
sql
.
v1
.
IGenerateEphemeralCertRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
sql
.
v1
.
IGenerateEphemeralCertResponse
,
protos
.
google
.
cloud
.
sql
.
v1
.
IGenerateEphemeralCertRequest
|
undefined
,
{}
|
undefined
]>;
Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.
request
options
Promise
<[ protos.google.cloud.sql.v1.IGenerateEphemeralCertResponse
, protos.google.cloud.sql.v1.IGenerateEphemeralCertRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing GenerateEphemeralCertResponse . 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.
*/
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
// const instance = 'abc123'
/**
* Project ID of the project that contains the instance.
*/
// const project = 'my-project'
/**
* PEM encoded public key to include in the signed certificate.
*/
// const publicKey = 'abc123'
/**
* Optional. Access token to include in the signed certificate.
*/
// const accessToken = 'abc123'
/**
* Optional. Optional snapshot read timestamp to trade freshness for
* performance.
*/
// const readTime = {}
/**
* Optional. If set, it will contain the cert valid duration.
*/
// const validDuration = {}
// Imports the Sql library
const
{
SqlConnectServiceClient
}
=
require
(
' @google-cloud/sql
'
).
v1
;
// Instantiates a client
const
sqlClient
=
new
SqlConnectServiceClient
();
async
function
callGenerateEphemeralCert
()
{
// Construct request
const
request
=
{
};
// Run request
const
response
=
await
sqlClient
.
generateEphemeralCert
(
request
);
console
.
log
(
response
);
}
callGenerateEphemeralCert
();
generateEphemeralCert(request, options, callback)
generateEphemeralCert
(
request
:
protos
.
google
.
cloud
.
sql
.
v1
.
IGenerateEphemeralCertRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
sql
.
v1
.
IGenerateEphemeralCertResponse
,
protos
.
google
.
cloud
.
sql
.
v1
.
IGenerateEphemeralCertRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.sql.v1.IGenerateEphemeralCertResponse
, protos.google.cloud.sql.v1.IGenerateEphemeralCertRequest
| null | undefined, {} | null | undefined>
void
generateEphemeralCert(request, callback)
generateEphemeralCert
(
request
:
protos
.
google
.
cloud
.
sql
.
v1
.
IGenerateEphemeralCertRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
sql
.
v1
.
IGenerateEphemeralCertResponse
,
protos
.
google
.
cloud
.
sql
.
v1
.
IGenerateEphemeralCertRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.sql.v1.IGenerateEphemeralCertResponse
, protos.google.cloud.sql.v1.IGenerateEphemeralCertRequest
| null | undefined, {} | null | undefined>
void
getConnectSettings(request, options)
getConnectSettings
(
request
?:
protos
.
google
.
cloud
.
sql
.
v1
.
IGetConnectSettingsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
sql
.
v1
.
IConnectSettings
,
protos
.
google
.
cloud
.
sql
.
v1
.
IGetConnectSettingsRequest
|
undefined
,
{}
|
undefined
]>;
Retrieves connect settings about a Cloud SQL instance.
request
options
Promise
<[ protos.google.cloud.sql.v1.IConnectSettings
, protos.google.cloud.sql.v1.IGetConnectSettingsRequest
| undefined,
{} | undefined
]>
{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.
/**
* 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.
*/
/**
* Cloud SQL instance ID. This does not include the project ID.
*/
// const instance = 'abc123'
/**
* Project ID of the project that contains the instance.
*/
// const project = 'my-project'
/**
* Optional. Optional snapshot read timestamp to trade freshness for
* performance.
*/
// const readTime = {}
// Imports the Sql library
const
{
SqlConnectServiceClient
}
=
require
(
' @google-cloud/sql
'
).
v1
;
// Instantiates a client
const
sqlClient
=
new
SqlConnectServiceClient
();
async
function
callGetConnectSettings
()
{
// Construct request
const
request
=
{
};
// Run request
const
response
=
await
sqlClient
.
getConnectSettings
(
request
);
console
.
log
(
response
);
}
callGetConnectSettings
();
getConnectSettings(request, options, callback)
getConnectSettings
(
request
:
protos
.
google
.
cloud
.
sql
.
v1
.
IGetConnectSettingsRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
sql
.
v1
.
IConnectSettings
,
protos
.
google
.
cloud
.
sql
.
v1
.
IGetConnectSettingsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.sql.v1.IConnectSettings
, protos.google.cloud.sql.v1.IGetConnectSettingsRequest
| null | undefined, {} | null | undefined>
void
getConnectSettings(request, callback)
getConnectSettings
(
request
:
protos
.
google
.
cloud
.
sql
.
v1
.
IGetConnectSettingsRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
sql
.
v1
.
IConnectSettings
,
protos
.
google
.
cloud
.
sql
.
v1
.
IGetConnectSettingsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.sql.v1.IConnectSettings
, protos.google.cloud.sql.v1.IGetConnectSettingsRequest
| null | undefined, {} | null | undefined>
void
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.
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>
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>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
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.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
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.
request
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent.
options
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
}
