Service for managing database backups. v1
Package
@google-cloud/sqlConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of SqlBackupRunsServiceClient.
Parameters
Name
Description
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 SqlBackupRunsServiceClient({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.
sqlBackupRunsServiceStub
sqlBackupRunsServiceStub
?:
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.
delete(request, options)
delete
(
request
?:
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsDeleteRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
sql
.
v1
.
IOperation
,
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsDeleteRequest
|
undefined
,
{}
|
undefined
]>;
Deletes the backup taken by a backup run.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.sql.v1.IOperation
, protos.google.cloud.sql.v1.ISqlBackupRunsDeleteRequest
| 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.
*/
/**
* The ID of the backup run to delete. To find a backup run ID, use the
* list (https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/backupRuns/list)
* method.
*/
// const id = 1234
/**
* 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'
// Imports the Sql library
const
{
SqlBackupRunsServiceClient
}
=
require
(
' @google-cloud/sql
'
).
v1
;
// Instantiates a client
const
sqlClient
=
new
SqlBackupRunsServiceClient
();
async
function
callDelete
()
{
// Construct request
const
request
=
{
};
// Run request
const
response
=
await
sqlClient
.
delete
(
request
);
console
.
log
(
response
);
}
callDelete
();
delete(request, options, callback)
delete
(
request
:
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsDeleteRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
sql
.
v1
.
IOperation
,
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsDeleteRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.sql.v1.IOperation
, protos.google.cloud.sql.v1.ISqlBackupRunsDeleteRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
delete(request, callback)
delete
(
request
:
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsDeleteRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
sql
.
v1
.
IOperation
,
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsDeleteRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.sql.v1.IOperation
, protos.google.cloud.sql.v1.ISqlBackupRunsDeleteRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
get(request, options)
get
(
request
?:
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsGetRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
sql
.
v1
.
IBackupRun
,
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsGetRequest
|
undefined
,
{}
|
undefined
]>;
Retrieves a resource containing information about a backup run.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.sql.v1.IBackupRun
, protos.google.cloud.sql.v1.ISqlBackupRunsGetRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing BackupRun . 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.
*/
/**
* The ID of this backup run.
*/
// const id = 1234
/**
* 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'
// Imports the Sql library
const
{
SqlBackupRunsServiceClient
}
=
require
(
' @google-cloud/sql
'
).
v1
;
// Instantiates a client
const
sqlClient
=
new
SqlBackupRunsServiceClient
();
async
function
callGet
()
{
// Construct request
const
request
=
{
};
// Run request
const
response
=
await
sqlClient
.
get
(
request
);
console
.
log
(
response
);
}
callGet
();
get(request, options, callback)
get
(
request
:
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsGetRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
sql
.
v1
.
IBackupRun
,
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsGetRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.sql.v1.IBackupRun
, protos.google.cloud.sql.v1.ISqlBackupRunsGetRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
get(request, callback)
get
(
request
:
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsGetRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
sql
.
v1
.
IBackupRun
,
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsGetRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.sql.v1.IBackupRun
, protos.google.cloud.sql.v1.ISqlBackupRunsGetRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
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.
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.
insert(request, options)
insert
(
request
?:
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsInsertRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
sql
.
v1
.
IOperation
,
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsInsertRequest
|
undefined
,
{}
|
undefined
]>;
Creates a new backup run on demand.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.sql.v1.IOperation
, protos.google.cloud.sql.v1.ISqlBackupRunsInsertRequest
| 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'
/**
*/
// const body = {}
// Imports the Sql library
const
{
SqlBackupRunsServiceClient
}
=
require
(
' @google-cloud/sql
'
).
v1
;
// Instantiates a client
const
sqlClient
=
new
SqlBackupRunsServiceClient
();
async
function
callInsert
()
{
// Construct request
const
request
=
{
};
// Run request
const
response
=
await
sqlClient
.
insert
(
request
);
console
.
log
(
response
);
}
callInsert
();
insert(request, options, callback)
insert
(
request
:
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsInsertRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
sql
.
v1
.
IOperation
,
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsInsertRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.sql.v1.IOperation
, protos.google.cloud.sql.v1.ISqlBackupRunsInsertRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
insert(request, callback)
insert
(
request
:
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsInsertRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
sql
.
v1
.
IOperation
,
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsInsertRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.sql.v1.IOperation
, protos.google.cloud.sql.v1.ISqlBackupRunsInsertRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
list(request, options)
list
(
request
?:
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsListRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
sql
.
v1
.
IBackupRunsListResponse
,
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsListRequest
|
undefined
,
{}
|
undefined
]>;
Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time.
Parameters
Name
Description
request
options
Returns
Type
Description
Promise
<[ protos.google.cloud.sql.v1.IBackupRunsListResponse
, protos.google.cloud.sql.v1.ISqlBackupRunsListRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing BackupRunsListResponse . 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, or "-" for all instances. This does not include
* the project ID.
*/
// const instance = 'abc123'
/**
* Maximum number of backup runs per response.
*/
// const maxResults = 1234
/**
* A previously-returned page token representing part of the larger set of
* results to view.
*/
// const pageToken = 'abc123'
/**
* Project ID of the project that contains the instance.
*/
// const project = 'my-project'
// Imports the Sql library
const
{
SqlBackupRunsServiceClient
}
=
require
(
' @google-cloud/sql
'
).
v1
;
// Instantiates a client
const
sqlClient
=
new
SqlBackupRunsServiceClient
();
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
.
v1
.
ISqlBackupRunsListRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
sql
.
v1
.
IBackupRunsListResponse
,
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsListRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
options
CallOptions
callback
Callback
< protos.google.cloud.sql.v1.IBackupRunsListResponse
, protos.google.cloud.sql.v1.ISqlBackupRunsListRequest
| null | undefined, {} | null | undefined>
Returns
Type
Description
void
list(request, callback)
list
(
request
:
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsListRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
sql
.
v1
.
IBackupRunsListResponse
,
protos
.
google
.
cloud
.
sql
.
v1
.
ISqlBackupRunsListRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters
Name
Description
request
callback
Callback
< protos.google.cloud.sql.v1.IBackupRunsListResponse
, protos.google.cloud.sql.v1.ISqlBackupRunsListRequest
| 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
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
}
