Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 39 and 402] [Versions 39 and 403]

(no description)

File Size: 1475 lines (42 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 32 classes

Google_Service_Storagetransfer:: (1 method):
  __construct()

Google_Service_Storagetransfer_GoogleServiceAccounts_Resource:: (1 method):
  get()

Google_Service_Storagetransfer_TransferJobs_Resource:: (4 methods):
  create()
  get()
  listTransferJobs()
  patch()

Google_Service_Storagetransfer_TransferOperations_Resource:: (6 methods):
  cancel()
  delete()
  get()
  listTransferOperations()
  pause()
  resume()

Google_Service_Storagetransfer_V1_Resource:: (1 method):
  getGoogleServiceAccount()

Google_Service_Storagetransfer_AwsAccessKey:: (4 methods):
  setAccessKeyId()
  getAccessKeyId()
  setSecretAccessKey()
  getSecretAccessKey()

Google_Service_Storagetransfer_AwsS3Data:: (4 methods):
  setAwsAccessKey()
  getAwsAccessKey()
  setBucketName()
  getBucketName()

Google_Service_Storagetransfer_Date:: (6 methods):
  setDay()
  getDay()
  setMonth()
  getMonth()
  setYear()
  getYear()

Google_Service_Storagetransfer_Empty:: (0 methods):

Google_Service_Storagetransfer_ErrorLogEntry:: (4 methods):
  setErrorDetails()
  getErrorDetails()
  setUrl()
  getUrl()

Google_Service_Storagetransfer_ErrorSummary:: (6 methods):
  setErrorCode()
  getErrorCode()
  setErrorCount()
  getErrorCount()
  setErrorLogEntries()
  getErrorLogEntries()

Google_Service_Storagetransfer_GcsData:: (2 methods):
  setBucketName()
  getBucketName()

Google_Service_Storagetransfer_GoogleServiceAccount:: (2 methods):
  setAccountEmail()
  getAccountEmail()

Google_Service_Storagetransfer_HttpData:: (2 methods):
  setListUrl()
  getListUrl()

Google_Service_Storagetransfer_ListOperationsResponse:: (4 methods):
  setNextPageToken()
  getNextPageToken()
  setOperations()
  getOperations()

Google_Service_Storagetransfer_ListTransferJobsResponse:: (4 methods):
  setNextPageToken()
  getNextPageToken()
  setTransferJobs()
  getTransferJobs()

Google_Service_Storagetransfer_ObjectConditions:: (8 methods):
  setExcludePrefixes()
  getExcludePrefixes()
  setIncludePrefixes()
  getIncludePrefixes()
  setMaxTimeElapsedSinceLastModification()
  getMaxTimeElapsedSinceLastModification()
  setMinTimeElapsedSinceLastModification()
  getMinTimeElapsedSinceLastModification()

Google_Service_Storagetransfer_Operation:: (10 methods):
  setDone()
  getDone()
  setError()
  getError()
  setMetadata()
  getMetadata()
  setName()
  getName()
  setResponse()
  getResponse()

Google_Service_Storagetransfer_OperationMetadata:: (0 methods):

Google_Service_Storagetransfer_OperationResponse:: (0 methods):

Google_Service_Storagetransfer_PauseTransferOperationRequest:: (0 methods):

Google_Service_Storagetransfer_ResumeTransferOperationRequest:: (0 methods):

Google_Service_Storagetransfer_Schedule:: (6 methods):
  setScheduleEndDate()
  getScheduleEndDate()
  setScheduleStartDate()
  getScheduleStartDate()
  setStartTimeOfDay()
  getStartTimeOfDay()

Google_Service_Storagetransfer_Status:: (6 methods):
  setCode()
  getCode()
  setDetails()
  getDetails()
  setMessage()
  getMessage()

Google_Service_Storagetransfer_StatusDetails:: (0 methods):

Google_Service_Storagetransfer_TimeOfDay:: (8 methods):
  setHours()
  getHours()
  setMinutes()
  getMinutes()
  setNanos()
  getNanos()
  setSeconds()
  getSeconds()

Google_Service_Storagetransfer_TransferCounters:: (32 methods):
  setBytesCopiedToSink()
  getBytesCopiedToSink()
  setBytesDeletedFromSink()
  getBytesDeletedFromSink()
  setBytesDeletedFromSource()
  getBytesDeletedFromSource()
  setBytesFailedToDeleteFromSink()
  getBytesFailedToDeleteFromSink()
  setBytesFoundFromSource()
  getBytesFoundFromSource()
  setBytesFoundOnlyFromSink()
  getBytesFoundOnlyFromSink()
  setBytesFromSourceFailed()
  getBytesFromSourceFailed()
  setBytesFromSourceSkippedBySync()
  getBytesFromSourceSkippedBySync()
  setObjectsCopiedToSink()
  getObjectsCopiedToSink()
  setObjectsDeletedFromSink()
  getObjectsDeletedFromSink()
  setObjectsDeletedFromSource()
  getObjectsDeletedFromSource()
  setObjectsFailedToDeleteFromSink()
  getObjectsFailedToDeleteFromSink()
  setObjectsFoundFromSource()
  getObjectsFoundFromSource()
  setObjectsFoundOnlyFromSink()
  getObjectsFoundOnlyFromSink()
  setObjectsFromSourceFailed()
  getObjectsFromSourceFailed()
  setObjectsFromSourceSkippedBySync()
  getObjectsFromSourceSkippedBySync()

Google_Service_Storagetransfer_TransferJob:: (18 methods):
  setCreationTime()
  getCreationTime()
  setDeletionTime()
  getDeletionTime()
  setDescription()
  getDescription()
  setLastModificationTime()
  getLastModificationTime()
  setName()
  getName()
  setProjectId()
  getProjectId()
  setSchedule()
  getSchedule()
  setStatus()
  getStatus()
  setTransferSpec()
  getTransferSpec()

Google_Service_Storagetransfer_TransferOperation:: (18 methods):
  setCounters()
  getCounters()
  setEndTime()
  getEndTime()
  setErrorBreakdowns()
  getErrorBreakdowns()
  setName()
  getName()
  setProjectId()
  getProjectId()
  setStartTime()
  getStartTime()
  setStatus()
  getStatus()
  setTransferJobName()
  getTransferJobName()
  setTransferSpec()
  getTransferSpec()

Google_Service_Storagetransfer_TransferOptions:: (6 methods):
  setDeleteObjectsFromSourceAfterTransfer()
  getDeleteObjectsFromSourceAfterTransfer()
  setDeleteObjectsUniqueInSink()
  getDeleteObjectsUniqueInSink()
  setOverwriteObjectsAlreadyExistingInSink()
  getOverwriteObjectsAlreadyExistingInSink()

Google_Service_Storagetransfer_TransferSpec:: (12 methods):
  setAwsS3DataSource()
  getAwsS3DataSource()
  setGcsDataSink()
  getGcsDataSink()
  setGcsDataSource()
  getGcsDataSource()
  setHttpDataSource()
  getHttpDataSource()
  setObjectConditions()
  getObjectConditions()
  setTransferOptions()
  getTransferOptions()

Google_Service_Storagetransfer_UpdateTransferJobRequest:: (6 methods):
  setProjectId()
  getProjectId()
  setTransferJob()
  getTransferJob()
  setUpdateTransferJobFieldMask()
  getUpdateTransferJobFieldMask()


Class: Google_Service_Storagetransfer  - X-Ref

Service definition for Storagetransfer (v1).

<p>
Transfers data from external data sources to a Google Cloud Storage bucket or
between Google Cloud Storage buckets.</p>

<p>
For more information about this service, see the API
<a href="https://cloud.google.com/storage/transfer" target="_blank">Documentation</a>
</p>

__construct(Google_Client $client)   X-Ref
Constructs the internal representation of the Storagetransfer service.

param: Google_Client $client

Class: Google_Service_Storagetransfer_GoogleServiceAccounts_Resource  - X-Ref

The "googleServiceAccounts" collection of methods.
Typical usage is:
<code>
$storagetransferService = new Google_Service_Storagetransfer(...);
$googleServiceAccounts = $storagetransferService->googleServiceAccounts;
</code>

get($projectId, $optParams = array()   X-Ref
Returns the Google service account that is used by Storage Transfer Service
to access buckets in the project where transfers run or in other projects.
Each Google service account is associated with one Google Developers Console
project. Users should add this service account to the Google Cloud Storage
bucket ACLs to grant access to Storage Transfer Service. This service account
is created and owned by Storage Transfer Service and can only be used by
Storage Transfer Service. (googleServiceAccounts.get)

param: string $projectId The ID of the Google Developers Console project that
param: array $optParams Optional parameters.
return: Google_Service_Storagetransfer_GoogleServiceAccount

Class: Google_Service_Storagetransfer_TransferJobs_Resource  - X-Ref

The "transferJobs" collection of methods.
Typical usage is:
<code>
$storagetransferService = new Google_Service_Storagetransfer(...);
$transferJobs = $storagetransferService->transferJobs;
</code>

create(Google_Service_Storagetransfer_TransferJob $postBody, $optParams = array()   X-Ref
Creates a transfer job that runs periodically. (transferJobs.create)

param: Google_TransferJob $postBody
param: array $optParams Optional parameters.
return: Google_Service_Storagetransfer_TransferJob

get($jobName, $optParams = array()   X-Ref
Gets a transfer job. (transferJobs.get)

param: string $jobName The job to get. Required.
param: array $optParams Optional parameters.
return: Google_Service_Storagetransfer_TransferJob

listTransferJobs($optParams = array()   X-Ref
Lists transfer jobs. (transferJobs.listTransferJobs)

param: array $optParams Optional parameters.
return: Google_Service_Storagetransfer_ListTransferJobsResponse

patch($jobName, Google_Service_Storagetransfer_UpdateTransferJobRequest $postBody, $optParams = array()   X-Ref
Updates a transfer job. Updating a job's transfer spec does not affect
transfer operations that are running already. Updating the scheduling of a
job is not allowed. (transferJobs.patch)

param: string $jobName The name of job to update. Required.
param: Google_UpdateTransferJobRequest $postBody
param: array $optParams Optional parameters.
return: Google_Service_Storagetransfer_TransferJob

Class: Google_Service_Storagetransfer_TransferOperations_Resource  - X-Ref

The "transferOperations" collection of methods.
Typical usage is:
<code>
$storagetransferService = new Google_Service_Storagetransfer(...);
$transferOperations = $storagetransferService->transferOperations;
</code>

cancel($name, $optParams = array()   X-Ref
Cancels a transfer. Use the get method to check whether the cancellation
succeeded or whether the operation completed despite cancellation.
(transferOperations.cancel)

param: string $name The name of the operation resource to be cancelled.
param: array $optParams Optional parameters.
return: Google_Service_Storagetransfer_Empty

delete($name, $optParams = array()   X-Ref
This method is not supported and the server returns `UNIMPLEMENTED`.
(transferOperations.delete)

param: string $name The name of the operation resource to be deleted.
param: array $optParams Optional parameters.
return: Google_Service_Storagetransfer_Empty

get($name, $optParams = array()   X-Ref
Gets the latest state of a long-running operation. Clients can use this
method to poll the operation result at intervals as recommended by the API
service. (transferOperations.get)

param: string $name The name of the operation resource.
param: array $optParams Optional parameters.
return: Google_Service_Storagetransfer_Operation

listTransferOperations($name, $optParams = array()   X-Ref
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the
`name` binding below allows API services to override the binding to use
different resource name schemes, such as `users/operations`.
(transferOperations.listTransferOperations)

param: string $name The value `transferOperations`.
param: array $optParams Optional parameters.
return: Google_Service_Storagetransfer_ListOperationsResponse

pause($name, Google_Service_Storagetransfer_PauseTransferOperationRequest $postBody, $optParams = array()   X-Ref
Pauses a transfer operation. (transferOperations.pause)

param: string $name The name of the transfer operation. Required.
param: Google_PauseTransferOperationRequest $postBody
param: array $optParams Optional parameters.
return: Google_Service_Storagetransfer_Empty

resume($name, Google_Service_Storagetransfer_ResumeTransferOperationRequest $postBody, $optParams = array()   X-Ref
Resumes a transfer operation that is paused. (transferOperations.resume)

param: string $name The name of the transfer operation. Required.
param: Google_ResumeTransferOperationRequest $postBody
param: array $optParams Optional parameters.
return: Google_Service_Storagetransfer_Empty

Class: Google_Service_Storagetransfer_V1_Resource  - X-Ref

The "v1" collection of methods.
Typical usage is:
<code>
$storagetransferService = new Google_Service_Storagetransfer(...);
$v1 = $storagetransferService->v1;
</code>

getGoogleServiceAccount($optParams = array()   X-Ref
Returns the Google service account that is used by Storage Transfer Service
to access buckets in the project where transfers run or in other projects.
Each Google service account is associated with one Google Developers Console
project. Users should add this service account to the Google Cloud Storage
bucket ACLs to grant access to Storage Transfer Service. This service account
is created and owned by Storage Transfer Service and can only be used by
Storage Transfer Service. (v1.getGoogleServiceAccount)

param: array $optParams Optional parameters.
return: Google_Service_Storagetransfer_GoogleServiceAccount

Class: Google_Service_Storagetransfer_AwsAccessKey  - X-Ref

setAccessKeyId($accessKeyId)   X-Ref
No description

getAccessKeyId()   X-Ref
No description

setSecretAccessKey($secretAccessKey)   X-Ref
No description

getSecretAccessKey()   X-Ref
No description

Class: Google_Service_Storagetransfer_AwsS3Data  - X-Ref

setAwsAccessKey(Google_Service_Storagetransfer_AwsAccessKey $awsAccessKey)   X-Ref
No description

getAwsAccessKey()   X-Ref
No description

setBucketName($bucketName)   X-Ref
No description

getBucketName()   X-Ref
No description

Class: Google_Service_Storagetransfer_Date  - X-Ref

setDay($day)   X-Ref
No description

getDay()   X-Ref
No description

setMonth($month)   X-Ref
No description

getMonth()   X-Ref
No description

setYear($year)   X-Ref
No description

getYear()   X-Ref
No description

Class: Google_Service_Storagetransfer_ErrorLogEntry  - X-Ref

setErrorDetails($errorDetails)   X-Ref
No description

getErrorDetails()   X-Ref
No description

setUrl($url)   X-Ref
No description

getUrl()   X-Ref
No description

Class: Google_Service_Storagetransfer_ErrorSummary  - X-Ref

setErrorCode($errorCode)   X-Ref
No description

getErrorCode()   X-Ref
No description

setErrorCount($errorCount)   X-Ref
No description

getErrorCount()   X-Ref
No description

setErrorLogEntries($errorLogEntries)   X-Ref
No description

getErrorLogEntries()   X-Ref
No description

Class: Google_Service_Storagetransfer_GcsData  - X-Ref

setBucketName($bucketName)   X-Ref
No description

getBucketName()   X-Ref
No description

Class: Google_Service_Storagetransfer_HttpData  - X-Ref

setListUrl($listUrl)   X-Ref
No description

getListUrl()   X-Ref
No description

Class: Google_Service_Storagetransfer_Operation  - X-Ref

setDone($done)   X-Ref
No description

getDone()   X-Ref
No description

setError(Google_Service_Storagetransfer_Status $error)   X-Ref
No description

getError()   X-Ref
No description

setMetadata($metadata)   X-Ref
No description

getMetadata()   X-Ref
No description

setName($name)   X-Ref
No description

getName()   X-Ref
No description

setResponse($response)   X-Ref
No description

getResponse()   X-Ref
No description

Class: Google_Service_Storagetransfer_Schedule  - X-Ref

setScheduleEndDate(Google_Service_Storagetransfer_Date $scheduleEndDate)   X-Ref
No description

getScheduleEndDate()   X-Ref
No description

setScheduleStartDate(Google_Service_Storagetransfer_Date $scheduleStartDate)   X-Ref
No description

getScheduleStartDate()   X-Ref
No description

setStartTimeOfDay(Google_Service_Storagetransfer_TimeOfDay $startTimeOfDay)   X-Ref
No description

getStartTimeOfDay()   X-Ref
No description

Class: Google_Service_Storagetransfer_Status  - X-Ref

setCode($code)   X-Ref
No description

getCode()   X-Ref
No description

setDetails($details)   X-Ref
No description

getDetails()   X-Ref
No description

setMessage($message)   X-Ref
No description

getMessage()   X-Ref
No description

Class: Google_Service_Storagetransfer_TimeOfDay  - X-Ref

setHours($hours)   X-Ref
No description

getHours()   X-Ref
No description

setMinutes($minutes)   X-Ref
No description

getMinutes()   X-Ref
No description

setNanos($nanos)   X-Ref
No description

getNanos()   X-Ref
No description

setSeconds($seconds)   X-Ref
No description

getSeconds()   X-Ref
No description

Class: Google_Service_Storagetransfer_TransferCounters  - X-Ref

setBytesCopiedToSink($bytesCopiedToSink)   X-Ref
No description

getBytesCopiedToSink()   X-Ref
No description

setBytesDeletedFromSink($bytesDeletedFromSink)   X-Ref
No description

getBytesDeletedFromSink()   X-Ref
No description

setBytesDeletedFromSource($bytesDeletedFromSource)   X-Ref
No description

getBytesDeletedFromSource()   X-Ref
No description

setBytesFailedToDeleteFromSink($bytesFailedToDeleteFromSink)   X-Ref
No description

getBytesFailedToDeleteFromSink()   X-Ref
No description

setBytesFoundFromSource($bytesFoundFromSource)   X-Ref
No description

getBytesFoundFromSource()   X-Ref
No description

setBytesFoundOnlyFromSink($bytesFoundOnlyFromSink)   X-Ref
No description

getBytesFoundOnlyFromSink()   X-Ref
No description

setBytesFromSourceFailed($bytesFromSourceFailed)   X-Ref
No description

getBytesFromSourceFailed()   X-Ref
No description

setBytesFromSourceSkippedBySync($bytesFromSourceSkippedBySync)   X-Ref
No description

getBytesFromSourceSkippedBySync()   X-Ref
No description

setObjectsCopiedToSink($objectsCopiedToSink)   X-Ref
No description

getObjectsCopiedToSink()   X-Ref
No description

setObjectsDeletedFromSink($objectsDeletedFromSink)   X-Ref
No description

getObjectsDeletedFromSink()   X-Ref
No description

setObjectsDeletedFromSource($objectsDeletedFromSource)   X-Ref
No description

getObjectsDeletedFromSource()   X-Ref
No description

setObjectsFailedToDeleteFromSink($objectsFailedToDeleteFromSink)   X-Ref
No description

getObjectsFailedToDeleteFromSink()   X-Ref
No description

setObjectsFoundFromSource($objectsFoundFromSource)   X-Ref
No description

getObjectsFoundFromSource()   X-Ref
No description

setObjectsFoundOnlyFromSink($objectsFoundOnlyFromSink)   X-Ref
No description

getObjectsFoundOnlyFromSink()   X-Ref
No description

setObjectsFromSourceFailed($objectsFromSourceFailed)   X-Ref
No description

getObjectsFromSourceFailed()   X-Ref
No description

setObjectsFromSourceSkippedBySync($objectsFromSourceSkippedBySync)   X-Ref
No description

getObjectsFromSourceSkippedBySync()   X-Ref
No description

Class: Google_Service_Storagetransfer_TransferJob  - X-Ref

setCreationTime($creationTime)   X-Ref
No description

getCreationTime()   X-Ref
No description

setDeletionTime($deletionTime)   X-Ref
No description

getDeletionTime()   X-Ref
No description

setDescription($description)   X-Ref
No description

getDescription()   X-Ref
No description

setLastModificationTime($lastModificationTime)   X-Ref
No description

getLastModificationTime()   X-Ref
No description

setName($name)   X-Ref
No description

getName()   X-Ref
No description

setProjectId($projectId)   X-Ref
No description

getProjectId()   X-Ref
No description

setSchedule(Google_Service_Storagetransfer_Schedule $schedule)   X-Ref
No description

getSchedule()   X-Ref
No description

setStatus($status)   X-Ref
No description

getStatus()   X-Ref
No description

setTransferSpec(Google_Service_Storagetransfer_TransferSpec $transferSpec)   X-Ref
No description

getTransferSpec()   X-Ref
No description

Class: Google_Service_Storagetransfer_TransferOperation  - X-Ref

setCounters(Google_Service_Storagetransfer_TransferCounters $counters)   X-Ref
No description

getCounters()   X-Ref
No description

setEndTime($endTime)   X-Ref
No description

getEndTime()   X-Ref
No description

setErrorBreakdowns($errorBreakdowns)   X-Ref
No description

getErrorBreakdowns()   X-Ref
No description

setName($name)   X-Ref
No description

getName()   X-Ref
No description

setProjectId($projectId)   X-Ref
No description

getProjectId()   X-Ref
No description

setStartTime($startTime)   X-Ref
No description

getStartTime()   X-Ref
No description

setStatus($status)   X-Ref
No description

getStatus()   X-Ref
No description

setTransferJobName($transferJobName)   X-Ref
No description

getTransferJobName()   X-Ref
No description

setTransferSpec(Google_Service_Storagetransfer_TransferSpec $transferSpec)   X-Ref
No description

getTransferSpec()   X-Ref
No description

Class: Google_Service_Storagetransfer_TransferSpec  - X-Ref

setAwsS3DataSource(Google_Service_Storagetransfer_AwsS3Data $awsS3DataSource)   X-Ref
No description

getAwsS3DataSource()   X-Ref
No description

setGcsDataSink(Google_Service_Storagetransfer_GcsData $gcsDataSink)   X-Ref
No description

getGcsDataSink()   X-Ref
No description

setGcsDataSource(Google_Service_Storagetransfer_GcsData $gcsDataSource)   X-Ref
No description

getGcsDataSource()   X-Ref
No description

setHttpDataSource(Google_Service_Storagetransfer_HttpData $httpDataSource)   X-Ref
No description

getHttpDataSource()   X-Ref
No description

setObjectConditions(Google_Service_Storagetransfer_ObjectConditions $objectConditions)   X-Ref
No description

getObjectConditions()   X-Ref
No description

setTransferOptions(Google_Service_Storagetransfer_TransferOptions $transferOptions)   X-Ref
No description

getTransferOptions()   X-Ref
No description

Class: Google_Service_Storagetransfer_UpdateTransferJobRequest  - X-Ref

setProjectId($projectId)   X-Ref
No description

getProjectId()   X-Ref
No description

setTransferJob(Google_Service_Storagetransfer_TransferJob $transferJob)   X-Ref
No description

getTransferJob()   X-Ref
No description

setUpdateTransferJobFieldMask($updateTransferJobFieldMask)   X-Ref
No description

getUpdateTransferJobFieldMask()   X-Ref
No description