delete(); * } finally { * $sqlBackupRunsServiceClient->close(); * } * ``` * * @experimental */ class SqlBackupRunsServiceGapicClient { use GapicClientTrait; /** The name of the service. */ const SERVICE_NAME = 'google.cloud.sql.v1beta4.SqlBackupRunsService'; /** The default address of the service. */ const SERVICE_ADDRESS = 'sqladmin.googleapis.com'; /** The default port of the service. */ const DEFAULT_SERVICE_PORT = 443; /** The name of the code generator, to be included in the agent header. */ const CODEGEN_NAME = 'gapic'; /** The default scopes required by the service. */ public static $serviceScopes = [ 'https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/sqlservice.admin', ]; private static function getClientDefaults() { return [ 'serviceName' => self::SERVICE_NAME, 'apiEndpoint' => self::SERVICE_ADDRESS . ':' . self::DEFAULT_SERVICE_PORT, 'clientConfig' => __DIR__ . '/../resources/sql_backup_runs_service_client_config.json', 'descriptorsConfigPath' => __DIR__ . '/../resources/sql_backup_runs_service_descriptor_config.php', 'gcpApiConfigPath' => __DIR__ . '/../resources/sql_backup_runs_service_grpc_config.json', 'credentialsConfig' => [ 'defaultScopes' => self::$serviceScopes, ], 'transportConfig' => [ 'rest' => [ 'restClientConfigPath' => __DIR__ . '/../resources/sql_backup_runs_service_rest_client_config.php', ], ], ]; } /** * Constructor. * * @param array $options { * Optional. Options for configuring the service API wrapper. * * @type string $apiEndpoint * The address of the API remote host. May optionally include the port, formatted * as ":". Default 'sqladmin.googleapis.com:443'. * @type string|array|FetchAuthTokenInterface|CredentialsWrapper $credentials * The credentials to be used by the client to authorize API calls. This option * accepts either a path to a credentials file, or a decoded credentials file as a * PHP array. * *Advanced usage*: In addition, this option can also accept a pre-constructed * {@see \Google\Auth\FetchAuthTokenInterface} object or * {@see \Google\ApiCore\CredentialsWrapper} object. Note that when one of these * objects are provided, any settings in $credentialsConfig will be ignored. * @type array $credentialsConfig * Options used to configure credentials, including auth token caching, for the * client. For a full list of supporting configuration options, see * {@see \Google\ApiCore\CredentialsWrapper::build()} . * @type bool $disableRetries * Determines whether or not retries defined by the client configuration should be * disabled. Defaults to `false`. * @type string|array $clientConfig * Client method configuration, including retry settings. This option can be either * a path to a JSON file, or a PHP array containing the decoded JSON data. By * default this settings points to the default client config file, which is * provided in the resources folder. * @type string|TransportInterface $transport * The transport used for executing network requests. May be either the string * `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. * *Advanced usage*: Additionally, it is possible to pass in an already * instantiated {@see \Google\ApiCore\Transport\TransportInterface} object. Note * that when this object is provided, any settings in $transportConfig, and any * $apiEndpoint setting, will be ignored. * @type array $transportConfig * Configuration options that will be used to construct the transport. Options for * each supported transport type should be passed in a key for that transport. For * example: * $transportConfig = [ * 'grpc' => [...], * 'rest' => [...], * ]; * See the {@see \Google\ApiCore\Transport\GrpcTransport::build()} and * {@see \Google\ApiCore\Transport\RestTransport::build()} methods for the * supported options. * @type callable $clientCertSource * A callable which returns the client cert as a string. This can be used to * provide a certificate and private key to the transport layer for mTLS. * } * * @throws ValidationException * * @experimental */ public function __construct(array $options = []) { $clientOptions = $this->buildClientOptions($options); $this->setClientOptions($clientOptions); } /** * Deletes the backup taken by a backup run. * * Sample code: * ``` * $sqlBackupRunsServiceClient = new SqlBackupRunsServiceClient(); * try { * $response = $sqlBackupRunsServiceClient->delete(); * } finally { * $sqlBackupRunsServiceClient->close(); * } * ``` * * @param array $optionalArgs { * Optional. * * @type int $id * 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/v1beta4/backupRuns/list) * method. * @type string $instance * Cloud SQL instance ID. This does not include the project ID. * @type string $project * Project ID of the project that contains the instance. * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on * {@see RetrySettings} for example usage. * } * * @return \Google\Cloud\Sql\V1beta4\Operation * * @throws ApiException if the remote call fails * * @experimental */ public function delete(array $optionalArgs = []) { $request = new SqlBackupRunsDeleteRequest(); $requestParamHeaders = []; if (isset($optionalArgs['id'])) { $request->setId($optionalArgs['id']); $requestParamHeaders['id'] = $optionalArgs['id']; } if (isset($optionalArgs['instance'])) { $request->setInstance($optionalArgs['instance']); $requestParamHeaders['instance'] = $optionalArgs['instance']; } if (isset($optionalArgs['project'])) { $request->setProject($optionalArgs['project']); $requestParamHeaders['project'] = $optionalArgs['project']; } $requestParams = new RequestParamsHeaderDescriptor( $requestParamHeaders ); $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader(); return $this->startCall( 'Delete', Operation::class, $optionalArgs, $request )->wait(); } /** * Retrieves a resource containing information about a backup run. * * Sample code: * ``` * $sqlBackupRunsServiceClient = new SqlBackupRunsServiceClient(); * try { * $response = $sqlBackupRunsServiceClient->get(); * } finally { * $sqlBackupRunsServiceClient->close(); * } * ``` * * @param array $optionalArgs { * Optional. * * @type int $id * The ID of this backup run. * @type string $instance * Cloud SQL instance ID. This does not include the project ID. * @type string $project * Project ID of the project that contains the instance. * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on * {@see RetrySettings} for example usage. * } * * @return \Google\Cloud\Sql\V1beta4\BackupRun * * @throws ApiException if the remote call fails * * @experimental */ public function get(array $optionalArgs = []) { $request = new SqlBackupRunsGetRequest(); $requestParamHeaders = []; if (isset($optionalArgs['id'])) { $request->setId($optionalArgs['id']); $requestParamHeaders['id'] = $optionalArgs['id']; } if (isset($optionalArgs['instance'])) { $request->setInstance($optionalArgs['instance']); $requestParamHeaders['instance'] = $optionalArgs['instance']; } if (isset($optionalArgs['project'])) { $request->setProject($optionalArgs['project']); $requestParamHeaders['project'] = $optionalArgs['project']; } $requestParams = new RequestParamsHeaderDescriptor( $requestParamHeaders ); $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader(); return $this->startCall( 'Get', BackupRun::class, $optionalArgs, $request )->wait(); } /** * Creates a new backup run on demand. * * Sample code: * ``` * $sqlBackupRunsServiceClient = new SqlBackupRunsServiceClient(); * try { * $response = $sqlBackupRunsServiceClient->insert(); * } finally { * $sqlBackupRunsServiceClient->close(); * } * ``` * * @param array $optionalArgs { * Optional. * * @type string $instance * Cloud SQL instance ID. This does not include the project ID. * @type string $project * Project ID of the project that contains the instance. * @type BackupRun $body * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on * {@see RetrySettings} for example usage. * } * * @return \Google\Cloud\Sql\V1beta4\Operation * * @throws ApiException if the remote call fails * * @experimental */ public function insert(array $optionalArgs = []) { $request = new SqlBackupRunsInsertRequest(); $requestParamHeaders = []; if (isset($optionalArgs['instance'])) { $request->setInstance($optionalArgs['instance']); $requestParamHeaders['instance'] = $optionalArgs['instance']; } if (isset($optionalArgs['project'])) { $request->setProject($optionalArgs['project']); $requestParamHeaders['project'] = $optionalArgs['project']; } if (isset($optionalArgs['body'])) { $request->setBody($optionalArgs['body']); } $requestParams = new RequestParamsHeaderDescriptor( $requestParamHeaders ); $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader(); return $this->startCall( 'Insert', Operation::class, $optionalArgs, $request )->wait(); } /** * Lists all backup runs associated with the project or a given instance and * configuration in the reverse chronological order of the backup initiation * time. * * Sample code: * ``` * $sqlBackupRunsServiceClient = new SqlBackupRunsServiceClient(); * try { * $response = $sqlBackupRunsServiceClient->list(); * } finally { * $sqlBackupRunsServiceClient->close(); * } * ``` * * @param array $optionalArgs { * Optional. * * @type string $instance * Cloud SQL instance ID, or "-" for all instances. This does not include * the project ID. * @type int $maxResults * Maximum number of backup runs per response. * @type string $pageToken * A previously-returned page token representing part of the larger set of * results to view. * @type string $project * Project ID of the project that contains the instance. * @type RetrySettings|array $retrySettings * Retry settings to use for this call. Can be a {@see RetrySettings} object, or an * associative array of retry settings parameters. See the documentation on * {@see RetrySettings} for example usage. * } * * @return \Google\Cloud\Sql\V1beta4\BackupRunsListResponse * * @throws ApiException if the remote call fails * * @experimental */ public function list(array $optionalArgs = []) { $request = new SqlBackupRunsListRequest(); $requestParamHeaders = []; if (isset($optionalArgs['instance'])) { $request->setInstance($optionalArgs['instance']); $requestParamHeaders['instance'] = $optionalArgs['instance']; } if (isset($optionalArgs['maxResults'])) { $request->setMaxResults($optionalArgs['maxResults']); } if (isset($optionalArgs['pageToken'])) { $request->setPageToken($optionalArgs['pageToken']); } if (isset($optionalArgs['project'])) { $request->setProject($optionalArgs['project']); $requestParamHeaders['project'] = $optionalArgs['project']; } $requestParams = new RequestParamsHeaderDescriptor( $requestParamHeaders ); $optionalArgs['headers'] = isset($optionalArgs['headers']) ? array_merge($requestParams->getHeader(), $optionalArgs['headers']) : $requestParams->getHeader(); return $this->startCall( 'List', BackupRunsListResponse::class, $optionalArgs, $request )->wait(); } }