gestione documentale avanzata 1 parte

This commit is contained in:
2026-05-28 09:34:28 +02:00
parent 3471befb1a
commit f2b0833b90
34482 changed files with 4312269 additions and 546 deletions
@@ -0,0 +1,134 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class AgentPool extends \Google\Model
{
/**
* Default value. This value is unused.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* This is an initialization state. During this stage, resources are allocated
* for the AgentPool.
*/
public const STATE_CREATING = 'CREATING';
/**
* Determines that the AgentPool is created for use. At this state, Agents can
* join the AgentPool and participate in the transfer jobs in that pool.
*/
public const STATE_CREATED = 'CREATED';
/**
* Determines that the AgentPool deletion has been initiated, and all the
* resources are scheduled to be cleaned up and freed.
*/
public const STATE_DELETING = 'DELETING';
protected $bandwidthLimitType = BandwidthLimit::class;
protected $bandwidthLimitDataType = '';
/**
* Specifies the client-specified AgentPool description.
*
* @var string
*/
public $displayName;
/**
* Required. Specifies a unique string that identifies the agent pool. Format:
* `projects/{project_id}/agentPools/{agent_pool_id}`
*
* @var string
*/
public $name;
/**
* Output only. Specifies the state of the AgentPool.
*
* @var string
*/
public $state;
/**
* Specifies the bandwidth limit details. If this field is unspecified, the
* default value is set as 'No Limit'.
*
* @param BandwidthLimit $bandwidthLimit
*/
public function setBandwidthLimit(BandwidthLimit $bandwidthLimit)
{
$this->bandwidthLimit = $bandwidthLimit;
}
/**
* @return BandwidthLimit
*/
public function getBandwidthLimit()
{
return $this->bandwidthLimit;
}
/**
* Specifies the client-specified AgentPool description.
*
* @param string $displayName
*/
public function setDisplayName($displayName)
{
$this->displayName = $displayName;
}
/**
* @return string
*/
public function getDisplayName()
{
return $this->displayName;
}
/**
* Required. Specifies a unique string that identifies the agent pool. Format:
* `projects/{project_id}/agentPools/{agent_pool_id}`
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Output only. Specifies the state of the AgentPool.
*
* Accepted values: STATE_UNSPECIFIED, CREATING, CREATED, DELETING
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AgentPool::class, 'Google_Service_Storagetransfer_AgentPool');
@@ -0,0 +1,72 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class AwsAccessKey extends \Google\Model
{
/**
* Required. AWS access key ID.
*
* @var string
*/
public $accessKeyId;
/**
* Required. AWS secret access key. This field is not returned in RPC
* responses.
*
* @var string
*/
public $secretAccessKey;
/**
* Required. AWS access key ID.
*
* @param string $accessKeyId
*/
public function setAccessKeyId($accessKeyId)
{
$this->accessKeyId = $accessKeyId;
}
/**
* @return string
*/
public function getAccessKeyId()
{
return $this->accessKeyId;
}
/**
* Required. AWS secret access key. This field is not returned in RPC
* responses.
*
* @param string $secretAccessKey
*/
public function setSecretAccessKey($secretAccessKey)
{
$this->secretAccessKey = $secretAccessKey;
}
/**
* @return string
*/
public function getSecretAccessKey()
{
return $this->secretAccessKey;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AwsAccessKey::class, 'Google_Service_Storagetransfer_AwsAccessKey');
@@ -0,0 +1,138 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class AwsS3CompatibleData extends \Google\Model
{
/**
* Required. Specifies the name of the bucket.
*
* @var string
*/
public $bucketName;
/**
* Required. Specifies the endpoint of the storage service.
*
* @var string
*/
public $endpoint;
/**
* Specifies the root path to transfer objects. Must be an empty string or
* full path name that ends with a '/'. This field is treated as an object
* prefix. As such, it should generally not begin with a '/'.
*
* @var string
*/
public $path;
/**
* Specifies the region to sign requests with. This can be left blank if
* requests should be signed with an empty region.
*
* @var string
*/
public $region;
protected $s3MetadataType = S3CompatibleMetadata::class;
protected $s3MetadataDataType = '';
/**
* Required. Specifies the name of the bucket.
*
* @param string $bucketName
*/
public function setBucketName($bucketName)
{
$this->bucketName = $bucketName;
}
/**
* @return string
*/
public function getBucketName()
{
return $this->bucketName;
}
/**
* Required. Specifies the endpoint of the storage service.
*
* @param string $endpoint
*/
public function setEndpoint($endpoint)
{
$this->endpoint = $endpoint;
}
/**
* @return string
*/
public function getEndpoint()
{
return $this->endpoint;
}
/**
* Specifies the root path to transfer objects. Must be an empty string or
* full path name that ends with a '/'. This field is treated as an object
* prefix. As such, it should generally not begin with a '/'.
*
* @param string $path
*/
public function setPath($path)
{
$this->path = $path;
}
/**
* @return string
*/
public function getPath()
{
return $this->path;
}
/**
* Specifies the region to sign requests with. This can be left blank if
* requests should be signed with an empty region.
*
* @param string $region
*/
public function setRegion($region)
{
$this->region = $region;
}
/**
* @return string
*/
public function getRegion()
{
return $this->region;
}
/**
* A S3 compatible metadata.
*
* @param S3CompatibleMetadata $s3Metadata
*/
public function setS3Metadata(S3CompatibleMetadata $s3Metadata)
{
$this->s3Metadata = $s3Metadata;
}
/**
* @return S3CompatibleMetadata
*/
public function getS3Metadata()
{
return $this->s3Metadata;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AwsS3CompatibleData::class, 'Google_Service_Storagetransfer_AwsS3CompatibleData');
@@ -0,0 +1,252 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class AwsS3Data extends \Google\Model
{
protected $awsAccessKeyType = AwsAccessKey::class;
protected $awsAccessKeyDataType = '';
/**
* Required. S3 Bucket name (see [Creating a
* bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-
* location-example.html)).
*
* @var string
*/
public $bucketName;
/**
* Optional. The CloudFront distribution domain name pointing to this bucket,
* to use when fetching. See [Transfer from S3 via
* CloudFront](https://cloud.google.com/storage-transfer/docs/s3-cloudfront)
* for more information. Format: `https://{id}.cloudfront.net` or any valid
* custom domain. Must begin with `https://`.
*
* @var string
*/
public $cloudfrontDomain;
/**
* Optional. The Resource name of a secret in Secret Manager. AWS credentials
* must be stored in Secret Manager in JSON format: { "access_key_id":
* "ACCESS_KEY_ID", "secret_access_key": "SECRET_ACCESS_KEY" }
* GoogleServiceAccount must be granted `roles/secretmanager.secretAccessor`
* for the resource. See [Configure access to a source: Amazon S3]
* (https://cloud.google.com/storage-transfer/docs/source-
* amazon-s3#secret_manager) for more information. If `credentials_secret` is
* specified, do not specify role_arn or aws_access_key. Format:
* `projects/{project_number}/secrets/{secret_name}`
*
* @var string
*/
public $credentialsSecret;
/**
* Egress bytes over a Google-managed private network. This network is shared
* between other users of Storage Transfer Service.
*
* @var bool
*/
public $managedPrivateNetwork;
/**
* Root path to transfer objects. Must be an empty string or full path name
* that ends with a '/'. This field is treated as an object prefix. As such,
* it should generally not begin with a '/'.
*
* @var string
*/
public $path;
/**
* Service Directory Service to be used as the endpoint for transfers from a
* custom VPC. Format: `projects/{project_id}/locations/{location}/namespaces/
* {namespace}/services/{service}`
*
* @var string
*/
public $privateNetworkService;
/**
* The Amazon Resource Name (ARN) of the role to support temporary credentials
* via `AssumeRoleWithWebIdentity`. For more information about ARNs, see [IAM
* ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifier
* s.html#identifiers-arns). When a role ARN is provided, Transfer Service
* fetches temporary credentials for the session using a
* `AssumeRoleWithWebIdentity` call for the provided role using the
* GoogleServiceAccount for this project.
*
* @var string
*/
public $roleArn;
/**
* Input only. AWS access key used to sign the API requests to the AWS S3
* bucket. Permissions on the bucket must be granted to the access ID of the
* AWS access key. For information on our data retention policy for user
* credentials, see [User credentials](/storage-transfer/docs/data-
* retention#user-credentials).
*
* @param AwsAccessKey $awsAccessKey
*/
public function setAwsAccessKey(AwsAccessKey $awsAccessKey)
{
$this->awsAccessKey = $awsAccessKey;
}
/**
* @return AwsAccessKey
*/
public function getAwsAccessKey()
{
return $this->awsAccessKey;
}
/**
* Required. S3 Bucket name (see [Creating a
* bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-
* location-example.html)).
*
* @param string $bucketName
*/
public function setBucketName($bucketName)
{
$this->bucketName = $bucketName;
}
/**
* @return string
*/
public function getBucketName()
{
return $this->bucketName;
}
/**
* Optional. The CloudFront distribution domain name pointing to this bucket,
* to use when fetching. See [Transfer from S3 via
* CloudFront](https://cloud.google.com/storage-transfer/docs/s3-cloudfront)
* for more information. Format: `https://{id}.cloudfront.net` or any valid
* custom domain. Must begin with `https://`.
*
* @param string $cloudfrontDomain
*/
public function setCloudfrontDomain($cloudfrontDomain)
{
$this->cloudfrontDomain = $cloudfrontDomain;
}
/**
* @return string
*/
public function getCloudfrontDomain()
{
return $this->cloudfrontDomain;
}
/**
* Optional. The Resource name of a secret in Secret Manager. AWS credentials
* must be stored in Secret Manager in JSON format: { "access_key_id":
* "ACCESS_KEY_ID", "secret_access_key": "SECRET_ACCESS_KEY" }
* GoogleServiceAccount must be granted `roles/secretmanager.secretAccessor`
* for the resource. See [Configure access to a source: Amazon S3]
* (https://cloud.google.com/storage-transfer/docs/source-
* amazon-s3#secret_manager) for more information. If `credentials_secret` is
* specified, do not specify role_arn or aws_access_key. Format:
* `projects/{project_number}/secrets/{secret_name}`
*
* @param string $credentialsSecret
*/
public function setCredentialsSecret($credentialsSecret)
{
$this->credentialsSecret = $credentialsSecret;
}
/**
* @return string
*/
public function getCredentialsSecret()
{
return $this->credentialsSecret;
}
/**
* Egress bytes over a Google-managed private network. This network is shared
* between other users of Storage Transfer Service.
*
* @param bool $managedPrivateNetwork
*/
public function setManagedPrivateNetwork($managedPrivateNetwork)
{
$this->managedPrivateNetwork = $managedPrivateNetwork;
}
/**
* @return bool
*/
public function getManagedPrivateNetwork()
{
return $this->managedPrivateNetwork;
}
/**
* Root path to transfer objects. Must be an empty string or full path name
* that ends with a '/'. This field is treated as an object prefix. As such,
* it should generally not begin with a '/'.
*
* @param string $path
*/
public function setPath($path)
{
$this->path = $path;
}
/**
* @return string
*/
public function getPath()
{
return $this->path;
}
/**
* Service Directory Service to be used as the endpoint for transfers from a
* custom VPC. Format: `projects/{project_id}/locations/{location}/namespaces/
* {namespace}/services/{service}`
*
* @param string $privateNetworkService
*/
public function setPrivateNetworkService($privateNetworkService)
{
$this->privateNetworkService = $privateNetworkService;
}
/**
* @return string
*/
public function getPrivateNetworkService()
{
return $this->privateNetworkService;
}
/**
* The Amazon Resource Name (ARN) of the role to support temporary credentials
* via `AssumeRoleWithWebIdentity`. For more information about ARNs, see [IAM
* ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifier
* s.html#identifiers-arns). When a role ARN is provided, Transfer Service
* fetches temporary credentials for the session using a
* `AssumeRoleWithWebIdentity` call for the provided role using the
* GoogleServiceAccount for this project.
*
* @param string $roleArn
*/
public function setRoleArn($roleArn)
{
$this->roleArn = $roleArn;
}
/**
* @return string
*/
public function getRoleArn()
{
return $this->roleArn;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AwsS3Data::class, 'Google_Service_Storagetransfer_AwsS3Data');
@@ -0,0 +1,201 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class AzureBlobStorageData extends \Google\Model
{
protected $azureCredentialsType = AzureCredentials::class;
protected $azureCredentialsDataType = '';
/**
* Required. The container to transfer from the Azure Storage account.
*
* @var string
*/
public $container;
/**
* Optional. The Resource name of a secret in Secret Manager. The Azure SAS
* token must be stored in Secret Manager in JSON format: { "sas_token" :
* "SAS_TOKEN" } GoogleServiceAccount must be granted
* `roles/secretmanager.secretAccessor` for the resource. See [Configure
* access to a source: Microsoft Azure Blob Storage]
* (https://cloud.google.com/storage-transfer/docs/source-microsoft-
* azure#secret_manager) for more information. If `credentials_secret` is
* specified, do not specify azure_credentials. Format:
* `projects/{project_number}/secrets/{secret_name}`
*
* @var string
*/
public $credentialsSecret;
protected $federatedIdentityConfigType = FederatedIdentityConfig::class;
protected $federatedIdentityConfigDataType = '';
/**
* Root path to transfer objects. Must be an empty string or full path name
* that ends with a '/'. This field is treated as an object prefix. As such,
* it should generally not begin with a '/'.
*
* @var string
*/
public $path;
/**
* Service Directory Service to be used as the endpoint for transfers from a
* custom VPC. Format: `projects/{project_id}/locations/{location}/namespaces/
* {namespace}/services/{service}`
*
* @var string
*/
public $privateNetworkService;
/**
* Required. The name of the Azure Storage account.
*
* @var string
*/
public $storageAccount;
/**
* Required. Input only. Credentials used to authenticate API requests to
* Azure. For information on our data retention policy for user credentials,
* see [User credentials](/storage-transfer/docs/data-retention#user-
* credentials).
*
* @param AzureCredentials $azureCredentials
*/
public function setAzureCredentials(AzureCredentials $azureCredentials)
{
$this->azureCredentials = $azureCredentials;
}
/**
* @return AzureCredentials
*/
public function getAzureCredentials()
{
return $this->azureCredentials;
}
/**
* Required. The container to transfer from the Azure Storage account.
*
* @param string $container
*/
public function setContainer($container)
{
$this->container = $container;
}
/**
* @return string
*/
public function getContainer()
{
return $this->container;
}
/**
* Optional. The Resource name of a secret in Secret Manager. The Azure SAS
* token must be stored in Secret Manager in JSON format: { "sas_token" :
* "SAS_TOKEN" } GoogleServiceAccount must be granted
* `roles/secretmanager.secretAccessor` for the resource. See [Configure
* access to a source: Microsoft Azure Blob Storage]
* (https://cloud.google.com/storage-transfer/docs/source-microsoft-
* azure#secret_manager) for more information. If `credentials_secret` is
* specified, do not specify azure_credentials. Format:
* `projects/{project_number}/secrets/{secret_name}`
*
* @param string $credentialsSecret
*/
public function setCredentialsSecret($credentialsSecret)
{
$this->credentialsSecret = $credentialsSecret;
}
/**
* @return string
*/
public function getCredentialsSecret()
{
return $this->credentialsSecret;
}
/**
* Optional. Federated identity config of a user registered Azure application.
* If `federated_identity_config` is specified, do not specify
* azure_credentials or credentials_secret.
*
* @param FederatedIdentityConfig $federatedIdentityConfig
*/
public function setFederatedIdentityConfig(FederatedIdentityConfig $federatedIdentityConfig)
{
$this->federatedIdentityConfig = $federatedIdentityConfig;
}
/**
* @return FederatedIdentityConfig
*/
public function getFederatedIdentityConfig()
{
return $this->federatedIdentityConfig;
}
/**
* Root path to transfer objects. Must be an empty string or full path name
* that ends with a '/'. This field is treated as an object prefix. As such,
* it should generally not begin with a '/'.
*
* @param string $path
*/
public function setPath($path)
{
$this->path = $path;
}
/**
* @return string
*/
public function getPath()
{
return $this->path;
}
/**
* Service Directory Service to be used as the endpoint for transfers from a
* custom VPC. Format: `projects/{project_id}/locations/{location}/namespaces/
* {namespace}/services/{service}`
*
* @param string $privateNetworkService
*/
public function setPrivateNetworkService($privateNetworkService)
{
$this->privateNetworkService = $privateNetworkService;
}
/**
* @return string
*/
public function getPrivateNetworkService()
{
return $this->privateNetworkService;
}
/**
* Required. The name of the Azure Storage account.
*
* @param string $storageAccount
*/
public function setStorageAccount($storageAccount)
{
$this->storageAccount = $storageAccount;
}
/**
* @return string
*/
public function getStorageAccount()
{
return $this->storageAccount;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AzureBlobStorageData::class, 'Google_Service_Storagetransfer_AzureBlobStorageData');
@@ -0,0 +1,54 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class AzureCredentials extends \Google\Model
{
/**
* Required. Azure shared access signature (SAS). For more information about
* SAS, see [Grant limited access to Azure Storage resources using shared
* access signatures (SAS)](https://docs.microsoft.com/en-
* us/azure/storage/common/storage-sas-overview).
*
* @var string
*/
public $sasToken;
/**
* Required. Azure shared access signature (SAS). For more information about
* SAS, see [Grant limited access to Azure Storage resources using shared
* access signatures (SAS)](https://docs.microsoft.com/en-
* us/azure/storage/common/storage-sas-overview).
*
* @param string $sasToken
*/
public function setSasToken($sasToken)
{
$this->sasToken = $sasToken;
}
/**
* @return string
*/
public function getSasToken()
{
return $this->sasToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AzureCredentials::class, 'Google_Service_Storagetransfer_AzureCredentials');
@@ -0,0 +1,50 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class BandwidthLimit extends \Google\Model
{
/**
* Bandwidth rate in megabytes per second, distributed across all the agents
* in the pool.
*
* @var string
*/
public $limitMbps;
/**
* Bandwidth rate in megabytes per second, distributed across all the agents
* in the pool.
*
* @param string $limitMbps
*/
public function setLimitMbps($limitMbps)
{
$this->limitMbps = $limitMbps;
}
/**
* @return string
*/
public function getLimitMbps()
{
return $this->limitMbps;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BandwidthLimit::class, 'Google_Service_Storagetransfer_BandwidthLimit');
@@ -0,0 +1,74 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class BatchTaskSpec extends \Google\Model
{
protected $deleteObjectTaskSpecType = DeleteObjectTaskSpec::class;
protected $deleteObjectTaskSpecDataType = '';
protected $listTaskSpecType = ListTaskSpec::class;
protected $listTaskSpecDataType = '';
protected $metadataTaskSpecType = MetadataTaskSpec::class;
protected $metadataTaskSpecDataType = '';
/**
* @param DeleteObjectTaskSpec
*/
public function setDeleteObjectTaskSpec(DeleteObjectTaskSpec $deleteObjectTaskSpec)
{
$this->deleteObjectTaskSpec = $deleteObjectTaskSpec;
}
/**
* @return DeleteObjectTaskSpec
*/
public function getDeleteObjectTaskSpec()
{
return $this->deleteObjectTaskSpec;
}
/**
* @param ListTaskSpec
*/
public function setListTaskSpec(ListTaskSpec $listTaskSpec)
{
$this->listTaskSpec = $listTaskSpec;
}
/**
* @return ListTaskSpec
*/
public function getListTaskSpec()
{
return $this->listTaskSpec;
}
/**
* @param MetadataTaskSpec
*/
public function setMetadataTaskSpec(MetadataTaskSpec $metadataTaskSpec)
{
$this->metadataTaskSpec = $metadataTaskSpec;
}
/**
* @return MetadataTaskSpec
*/
public function getMetadataTaskSpec()
{
return $this->metadataTaskSpec;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BatchTaskSpec::class, 'Google_Service_Storagetransfer_BatchTaskSpec');
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class CancelOperationRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CancelOperationRequest::class, 'Google_Service_Storagetransfer_CancelOperationRequest');
@@ -0,0 +1,100 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class Date extends \Google\Model
{
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
* to specify a year by itself or a year and month where the day isn't
* significant.
*
* @var int
*/
public $day;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a
* month and day.
*
* @var int
*/
public $month;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
* year.
*
* @var int
*/
public $year;
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0
* to specify a year by itself or a year and month where the day isn't
* significant.
*
* @param int $day
*/
public function setDay($day)
{
$this->day = $day;
}
/**
* @return int
*/
public function getDay()
{
return $this->day;
}
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a
* month and day.
*
* @param int $month
*/
public function setMonth($month)
{
$this->month = $month;
}
/**
* @return int
*/
public function getMonth()
{
return $this->month;
}
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a
* year.
*
* @param int $year
*/
public function setYear($year)
{
$this->year = $year;
}
/**
* @return int
*/
public function getYear()
{
return $this->year;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Date::class, 'Google_Service_Storagetransfer_Date');
@@ -0,0 +1,98 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class DeleteObjectTaskSpec extends \Google\Model
{
/**
* @var string
*/
public $generation;
/**
* @var bool
*/
public $hardDeleteVersionedObject;
/**
* @var string
*/
public $name;
/**
* @var string
*/
public $size;
/**
* @param string
*/
public function setGeneration($generation)
{
$this->generation = $generation;
}
/**
* @return string
*/
public function getGeneration()
{
return $this->generation;
}
/**
* @param bool
*/
public function setHardDeleteVersionedObject($hardDeleteVersionedObject)
{
$this->hardDeleteVersionedObject = $hardDeleteVersionedObject;
}
/**
* @return bool
*/
public function getHardDeleteVersionedObject()
{
return $this->hardDeleteVersionedObject;
}
/**
* @param string
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* @param string
*/
public function setSize($size)
{
$this->size = $size;
}
/**
* @return string
*/
public function getSize()
{
return $this->size;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DeleteObjectTaskSpec::class, 'Google_Service_Storagetransfer_DeleteObjectTaskSpec');
@@ -0,0 +1,73 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class ErrorLogEntry extends \Google\Collection
{
protected $collection_key = 'errorDetails';
/**
* Optional. A list of messages that carry the error details.
*
* @var string[]
*/
public $errorDetails;
/**
* Output only. A URL that refers to the target (a data source, a data sink,
* or an object) with which the error is associated.
*
* @var string
*/
public $url;
/**
* Optional. A list of messages that carry the error details.
*
* @param string[] $errorDetails
*/
public function setErrorDetails($errorDetails)
{
$this->errorDetails = $errorDetails;
}
/**
* @return string[]
*/
public function getErrorDetails()
{
return $this->errorDetails;
}
/**
* Output only. A URL that refers to the target (a data source, a data sink,
* or an object) with which the error is associated.
*
* @param string $url
*/
public function setUrl($url)
{
$this->url = $url;
}
/**
* @return string
*/
public function getUrl()
{
return $this->url;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ErrorLogEntry::class, 'Google_Service_Storagetransfer_ErrorLogEntry');
@@ -0,0 +1,222 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class ErrorSummary extends \Google\Collection
{
/**
* Not an error; returned on success. HTTP Mapping: 200 OK
*/
public const ERROR_CODE_OK = 'OK';
/**
* The operation was cancelled, typically by the caller. HTTP Mapping: 499
* Client Closed Request
*/
public const ERROR_CODE_CANCELLED = 'CANCELLED';
/**
* Unknown error. For example, this error may be returned when a `Status`
* value received from another address space belongs to an error space that is
* not known in this address space. Also errors raised by APIs that do not
* return enough error information may be converted to this error. HTTP
* Mapping: 500 Internal Server Error
*/
public const ERROR_CODE_UNKNOWN = 'UNKNOWN';
/**
* The client specified an invalid argument. Note that this differs from
* `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are
* problematic regardless of the state of the system (e.g., a malformed file
* name). HTTP Mapping: 400 Bad Request
*/
public const ERROR_CODE_INVALID_ARGUMENT = 'INVALID_ARGUMENT';
/**
* The deadline expired before the operation could complete. For operations
* that change the state of the system, this error may be returned even if the
* operation has completed successfully. For example, a successful response
* from a server could have been delayed long enough for the deadline to
* expire. HTTP Mapping: 504 Gateway Timeout
*/
public const ERROR_CODE_DEADLINE_EXCEEDED = 'DEADLINE_EXCEEDED';
/**
* Some requested entity (e.g., file or directory) was not found. Note to
* server developers: if a request is denied for an entire class of users,
* such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may
* be used. If a request is denied for some users within a class of users,
* such as user-based access control, `PERMISSION_DENIED` must be used. HTTP
* Mapping: 404 Not Found
*/
public const ERROR_CODE_NOT_FOUND = 'NOT_FOUND';
/**
* The entity that a client attempted to create (e.g., file or directory)
* already exists. HTTP Mapping: 409 Conflict
*/
public const ERROR_CODE_ALREADY_EXISTS = 'ALREADY_EXISTS';
/**
* The caller does not have permission to execute the specified operation.
* `PERMISSION_DENIED` must not be used for rejections caused by exhausting
* some resource (use `RESOURCE_EXHAUSTED` instead for those errors).
* `PERMISSION_DENIED` must not be used if the caller can not be identified
* (use `UNAUTHENTICATED` instead for those errors). This error code does not
* imply the request is valid or the requested entity exists or satisfies
* other pre-conditions. HTTP Mapping: 403 Forbidden
*/
public const ERROR_CODE_PERMISSION_DENIED = 'PERMISSION_DENIED';
/**
* The request does not have valid authentication credentials for the
* operation. HTTP Mapping: 401 Unauthorized
*/
public const ERROR_CODE_UNAUTHENTICATED = 'UNAUTHENTICATED';
/**
* Some resource has been exhausted, perhaps a per-user quota, or perhaps the
* entire file system is out of space. HTTP Mapping: 429 Too Many Requests
*/
public const ERROR_CODE_RESOURCE_EXHAUSTED = 'RESOURCE_EXHAUSTED';
/**
* The operation was rejected because the system is not in a state required
* for the operation's execution. For example, the directory to be deleted is
* non-empty, an rmdir operation is applied to a non-directory, etc. Service
* implementors can use the following guidelines to decide between
* `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE`
* if the client can retry just the failing call. (b) Use `ABORTED` if the
* client should retry at a higher level. For example, when a client-specified
* test-and-set fails, indicating the client should restart a read-modify-
* write sequence. (c) Use `FAILED_PRECONDITION` if the client should not
* retry until the system state has been explicitly fixed. For example, if an
* "rmdir" fails because the directory is non-empty, `FAILED_PRECONDITION`
* should be returned since the client should not retry unless the files are
* deleted from the directory. HTTP Mapping: 400 Bad Request
*/
public const ERROR_CODE_FAILED_PRECONDITION = 'FAILED_PRECONDITION';
/**
* The operation was aborted, typically due to a concurrency issue such as a
* sequencer check failure or transaction abort. See the guidelines above for
* deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP
* Mapping: 409 Conflict
*/
public const ERROR_CODE_ABORTED = 'ABORTED';
/**
* The operation was attempted past the valid range. E.g., seeking or reading
* past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem
* that may be fixed if the system state changes. For example, a 32-bit file
* system will generate `INVALID_ARGUMENT` if asked to read at an offset that
* is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if
* asked to read from an offset past the current file size. There is a fair
* bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We
* recommend using `OUT_OF_RANGE` (the more specific error) when it applies so
* that callers who are iterating through a space can easily look for an
* `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad
* Request
*/
public const ERROR_CODE_OUT_OF_RANGE = 'OUT_OF_RANGE';
/**
* The operation is not implemented or is not supported/enabled in this
* service. HTTP Mapping: 501 Not Implemented
*/
public const ERROR_CODE_UNIMPLEMENTED = 'UNIMPLEMENTED';
/**
* Internal errors. This means that some invariants expected by the underlying
* system have been broken. This error code is reserved for serious errors.
* HTTP Mapping: 500 Internal Server Error
*/
public const ERROR_CODE_INTERNAL = 'INTERNAL';
/**
* The service is currently unavailable. This is most likely a transient
* condition, which can be corrected by retrying with a backoff. Note that it
* is not always safe to retry non-idempotent operations. See the guidelines
* above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and
* `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable
*/
public const ERROR_CODE_UNAVAILABLE = 'UNAVAILABLE';
/**
* Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server
* Error
*/
public const ERROR_CODE_DATA_LOSS = 'DATA_LOSS';
protected $collection_key = 'errorLogEntries';
/**
* Required.
*
* @var string
*/
public $errorCode;
/**
* Required. Count of this type of error.
*
* @var string
*/
public $errorCount;
protected $errorLogEntriesType = ErrorLogEntry::class;
protected $errorLogEntriesDataType = 'array';
/**
* Required.
*
* Accepted values: OK, CANCELLED, UNKNOWN, INVALID_ARGUMENT,
* DEADLINE_EXCEEDED, NOT_FOUND, ALREADY_EXISTS, PERMISSION_DENIED,
* UNAUTHENTICATED, RESOURCE_EXHAUSTED, FAILED_PRECONDITION, ABORTED,
* OUT_OF_RANGE, UNIMPLEMENTED, INTERNAL, UNAVAILABLE, DATA_LOSS
*
* @param self::ERROR_CODE_* $errorCode
*/
public function setErrorCode($errorCode)
{
$this->errorCode = $errorCode;
}
/**
* @return self::ERROR_CODE_*
*/
public function getErrorCode()
{
return $this->errorCode;
}
/**
* Required. Count of this type of error.
*
* @param string $errorCount
*/
public function setErrorCount($errorCount)
{
$this->errorCount = $errorCount;
}
/**
* @return string
*/
public function getErrorCount()
{
return $this->errorCount;
}
/**
* Error samples. At most 5 error log entries are recorded for a given error
* code for a single transfer operation.
*
* @param ErrorLogEntry[] $errorLogEntries
*/
public function setErrorLogEntries($errorLogEntries)
{
$this->errorLogEntries = $errorLogEntries;
}
/**
* @return ErrorLogEntry[]
*/
public function getErrorLogEntries()
{
return $this->errorLogEntries;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ErrorSummary::class, 'Google_Service_Storagetransfer_ErrorSummary');
@@ -0,0 +1,106 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class EventStream extends \Google\Model
{
/**
* Specifies the data and time at which Storage Transfer Service stops
* listening for events from this stream. After this time, any transfers in
* progress will complete, but no new transfers are initiated.
*
* @var string
*/
public $eventStreamExpirationTime;
/**
* Specifies the date and time that Storage Transfer Service starts listening
* for events from this stream. If no start time is specified or start time is
* in the past, Storage Transfer Service starts listening immediately.
*
* @var string
*/
public $eventStreamStartTime;
/**
* Required. Specifies a unique name of the resource such as AWS SQS ARN in
* the form 'arn:aws:sqs:region:account_id:queue_name', or Pub/Sub
* subscription resource name in the form
* 'projects/{project}/subscriptions/{sub}'.
*
* @var string
*/
public $name;
/**
* Specifies the data and time at which Storage Transfer Service stops
* listening for events from this stream. After this time, any transfers in
* progress will complete, but no new transfers are initiated.
*
* @param string $eventStreamExpirationTime
*/
public function setEventStreamExpirationTime($eventStreamExpirationTime)
{
$this->eventStreamExpirationTime = $eventStreamExpirationTime;
}
/**
* @return string
*/
public function getEventStreamExpirationTime()
{
return $this->eventStreamExpirationTime;
}
/**
* Specifies the date and time that Storage Transfer Service starts listening
* for events from this stream. If no start time is specified or start time is
* in the past, Storage Transfer Service starts listening immediately.
*
* @param string $eventStreamStartTime
*/
public function setEventStreamStartTime($eventStreamStartTime)
{
$this->eventStreamStartTime = $eventStreamStartTime;
}
/**
* @return string
*/
public function getEventStreamStartTime()
{
return $this->eventStreamStartTime;
}
/**
* Required. Specifies a unique name of the resource such as AWS SQS ARN in
* the form 'arn:aws:sqs:region:account_id:queue_name', or Pub/Sub
* subscription resource name in the form
* 'projects/{project}/subscriptions/{sub}'.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(EventStream::class, 'Google_Service_Storagetransfer_EventStream');
@@ -0,0 +1,74 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class FederatedIdentityConfig extends \Google\Model
{
/**
* Required. The client (application) ID of the application with federated
* credentials.
*
* @var string
*/
public $clientId;
/**
* Required. The tenant (directory) ID of the application with federated
* credentials.
*
* @var string
*/
public $tenantId;
/**
* Required. The client (application) ID of the application with federated
* credentials.
*
* @param string $clientId
*/
public function setClientId($clientId)
{
$this->clientId = $clientId;
}
/**
* @return string
*/
public function getClientId()
{
return $this->clientId;
}
/**
* Required. The tenant (directory) ID of the application with federated
* credentials.
*
* @param string $tenantId
*/
public function setTenantId($tenantId)
{
$this->tenantId = $tenantId;
}
/**
* @return string
*/
public function getTenantId()
{
return $this->tenantId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(FederatedIdentityConfig::class, 'Google_Service_Storagetransfer_FederatedIdentityConfig');
@@ -0,0 +1,110 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class GcsData extends \Google\Model
{
/**
* Required. Cloud Storage bucket name. Must meet [Bucket Name
* Requirements](/storage/docs/naming#requirements).
*
* @var string
*/
public $bucketName;
/**
* Preview. Enables the transfer of managed folders between Cloud Storage
* buckets. Set this option on the gcs_data_source. If set to true: - Managed
* folders in the source bucket are transferred to the destination bucket. -
* Managed folders in the destination bucket are overwritten. Other OVERWRITE
* options are not supported. See [Transfer Cloud Storage managed
* folders](/storage-transfer/docs/managed-folders).
*
* @var bool
*/
public $managedFolderTransferEnabled;
/**
* Root path to transfer objects. Must be an empty string or full path name
* that ends with a '/'. This field is treated as an object prefix. As such,
* it should generally not begin with a '/'. The root path value must meet
* [Object Name Requirements](/storage/docs/naming#objectnames).
*
* @var string
*/
public $path;
/**
* Required. Cloud Storage bucket name. Must meet [Bucket Name
* Requirements](/storage/docs/naming#requirements).
*
* @param string $bucketName
*/
public function setBucketName($bucketName)
{
$this->bucketName = $bucketName;
}
/**
* @return string
*/
public function getBucketName()
{
return $this->bucketName;
}
/**
* Preview. Enables the transfer of managed folders between Cloud Storage
* buckets. Set this option on the gcs_data_source. If set to true: - Managed
* folders in the source bucket are transferred to the destination bucket. -
* Managed folders in the destination bucket are overwritten. Other OVERWRITE
* options are not supported. See [Transfer Cloud Storage managed
* folders](/storage-transfer/docs/managed-folders).
*
* @param bool $managedFolderTransferEnabled
*/
public function setManagedFolderTransferEnabled($managedFolderTransferEnabled)
{
$this->managedFolderTransferEnabled = $managedFolderTransferEnabled;
}
/**
* @return bool
*/
public function getManagedFolderTransferEnabled()
{
return $this->managedFolderTransferEnabled;
}
/**
* Root path to transfer objects. Must be an empty string or full path name
* that ends with a '/'. This field is treated as an object prefix. As such,
* it should generally not begin with a '/'. The root path value must meet
* [Object Name Requirements](/storage/docs/naming#objectnames).
*
* @param string $path
*/
public function setPath($path)
{
$this->path = $path;
}
/**
* @return string
*/
public function getPath()
{
return $this->path;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GcsData::class, 'Google_Service_Storagetransfer_GcsData');
@@ -0,0 +1,70 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class GoogleServiceAccount extends \Google\Model
{
/**
* Email address of the service account.
*
* @var string
*/
public $accountEmail;
/**
* Unique identifier for the service account.
*
* @var string
*/
public $subjectId;
/**
* Email address of the service account.
*
* @param string $accountEmail
*/
public function setAccountEmail($accountEmail)
{
$this->accountEmail = $accountEmail;
}
/**
* @return string
*/
public function getAccountEmail()
{
return $this->accountEmail;
}
/**
* Unique identifier for the service account.
*
* @param string $subjectId
*/
public function setSubjectId($subjectId)
{
$this->subjectId = $subjectId;
}
/**
* @return string
*/
public function getSubjectId()
{
return $this->subjectId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleServiceAccount::class, 'Google_Service_Storagetransfer_GoogleServiceAccount');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class HdfsData extends \Google\Model
{
/**
* Root path to transfer files.
*
* @var string
*/
public $path;
/**
* Root path to transfer files.
*
* @param string $path
*/
public function setPath($path)
{
$this->path = $path;
}
/**
* @return string
*/
public function getPath()
{
return $this->path;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(HdfsData::class, 'Google_Service_Storagetransfer_HdfsData');
@@ -0,0 +1,54 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class HttpData extends \Google\Model
{
/**
* Required. The URL that points to the file that stores the object list
* entries. This file must allow public access. The URL is either an
* HTTP/HTTPS address (e.g. `https://example.com/urllist.tsv`) or a Cloud
* Storage path (e.g. `gs://my-bucket/urllist.tsv`).
*
* @var string
*/
public $listUrl;
/**
* Required. The URL that points to the file that stores the object list
* entries. This file must allow public access. The URL is either an
* HTTP/HTTPS address (e.g. `https://example.com/urllist.tsv`) or a Cloud
* Storage path (e.g. `gs://my-bucket/urllist.tsv`).
*
* @param string $listUrl
*/
public function setListUrl($listUrl)
{
$this->listUrl = $listUrl;
}
/**
* @return string
*/
public function getListUrl()
{
return $this->listUrl;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(HttpData::class, 'Google_Service_Storagetransfer_HttpData');
@@ -0,0 +1,67 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class ListAgentPoolsResponse extends \Google\Collection
{
protected $collection_key = 'agentPools';
protected $agentPoolsType = AgentPool::class;
protected $agentPoolsDataType = 'array';
/**
* The list next page token.
*
* @var string
*/
public $nextPageToken;
/**
* A list of agent pools.
*
* @param AgentPool[] $agentPools
*/
public function setAgentPools($agentPools)
{
$this->agentPools = $agentPools;
}
/**
* @return AgentPool[]
*/
public function getAgentPools()
{
return $this->agentPools;
}
/**
* The list next page token.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListAgentPoolsResponse::class, 'Google_Service_Storagetransfer_ListAgentPoolsResponse');
@@ -0,0 +1,95 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class ListOperationsResponse extends \Google\Collection
{
protected $collection_key = 'unreachable';
/**
* The standard List next-page token.
*
* @var string
*/
public $nextPageToken;
protected $operationsType = Operation::class;
protected $operationsDataType = 'array';
/**
* Unordered list. Unreachable resources. Populated when the request sets
* `ListOperationsRequest.return_partial_success` and reads across
* collections. For example, when attempting to list all resources across all
* supported locations.
*
* @var string[]
*/
public $unreachable;
/**
* The standard List next-page token.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* A list of operations that matches the specified filter in the request.
*
* @param Operation[] $operations
*/
public function setOperations($operations)
{
$this->operations = $operations;
}
/**
* @return Operation[]
*/
public function getOperations()
{
return $this->operations;
}
/**
* Unordered list. Unreachable resources. Populated when the request sets
* `ListOperationsRequest.return_partial_success` and reads across
* collections. For example, when attempting to list all resources across all
* supported locations.
*
* @param string[] $unreachable
*/
public function setUnreachable($unreachable)
{
$this->unreachable = $unreachable;
}
/**
* @return string[]
*/
public function getUnreachable()
{
return $this->unreachable;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListOperationsResponse::class, 'Google_Service_Storagetransfer_ListOperationsResponse');
@@ -0,0 +1,58 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class ListTaskSpec extends \Google\Model
{
protected $manifestType = Manifest::class;
protected $manifestDataType = '';
protected $objectPrefixesType = ObjectPrefixes::class;
protected $objectPrefixesDataType = '';
/**
* @param Manifest
*/
public function setManifest(Manifest $manifest)
{
$this->manifest = $manifest;
}
/**
* @return Manifest
*/
public function getManifest()
{
return $this->manifest;
}
/**
* @param ObjectPrefixes
*/
public function setObjectPrefixes(ObjectPrefixes $objectPrefixes)
{
$this->objectPrefixes = $objectPrefixes;
}
/**
* @return ObjectPrefixes
*/
public function getObjectPrefixes()
{
return $this->objectPrefixes;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListTaskSpec::class, 'Google_Service_Storagetransfer_ListTaskSpec');
@@ -0,0 +1,67 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class ListTransferJobsResponse extends \Google\Collection
{
protected $collection_key = 'transferJobs';
/**
* The list next page token.
*
* @var string
*/
public $nextPageToken;
protected $transferJobsType = TransferJob::class;
protected $transferJobsDataType = 'array';
/**
* The list next page token.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* A list of transfer jobs.
*
* @param TransferJob[] $transferJobs
*/
public function setTransferJobs($transferJobs)
{
$this->transferJobs = $transferJobs;
}
/**
* @return TransferJob[]
*/
public function getTransferJobs()
{
return $this->transferJobs;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListTransferJobsResponse::class, 'Google_Service_Storagetransfer_ListTransferJobsResponse');
@@ -0,0 +1,101 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class LoggingConfig extends \Google\Collection
{
protected $collection_key = 'logActions';
/**
* For PosixFilesystem transfers, enables [file system transfer
* logs](https://cloud.google.com/storage-transfer/docs/on-prem-transfer-log-
* format) instead of, or in addition to, Cloud Logging. This option ignores
* [LoggableAction] and [LoggableActionState]. If these are set, Cloud Logging
* will also be enabled for this transfer.
*
* @var bool
*/
public $enableOnpremGcsTransferLogs;
/**
* States in which `log_actions` are logged. If empty, no logs are generated.
*
* @var string[]
*/
public $logActionStates;
/**
* Specifies the actions to be logged. If empty, no logs are generated.
*
* @var string[]
*/
public $logActions;
/**
* For PosixFilesystem transfers, enables [file system transfer
* logs](https://cloud.google.com/storage-transfer/docs/on-prem-transfer-log-
* format) instead of, or in addition to, Cloud Logging. This option ignores
* [LoggableAction] and [LoggableActionState]. If these are set, Cloud Logging
* will also be enabled for this transfer.
*
* @param bool $enableOnpremGcsTransferLogs
*/
public function setEnableOnpremGcsTransferLogs($enableOnpremGcsTransferLogs)
{
$this->enableOnpremGcsTransferLogs = $enableOnpremGcsTransferLogs;
}
/**
* @return bool
*/
public function getEnableOnpremGcsTransferLogs()
{
return $this->enableOnpremGcsTransferLogs;
}
/**
* States in which `log_actions` are logged. If empty, no logs are generated.
*
* @param string[] $logActionStates
*/
public function setLogActionStates($logActionStates)
{
$this->logActionStates = $logActionStates;
}
/**
* @return string[]
*/
public function getLogActionStates()
{
return $this->logActionStates;
}
/**
* Specifies the actions to be logged. If empty, no logs are generated.
*
* @param string[] $logActions
*/
public function setLogActions($logActions)
{
$this->logActions = $logActions;
}
/**
* @return string[]
*/
public function getLogActions()
{
return $this->logActions;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(LoggingConfig::class, 'Google_Service_Storagetransfer_LoggingConfig');
@@ -0,0 +1,62 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class Manifest extends \Google\Model
{
/**
* @var string
*/
public $manifestLocation;
/**
* @var string
*/
public $root;
/**
* @param string
*/
public function setManifestLocation($manifestLocation)
{
$this->manifestLocation = $manifestLocation;
}
/**
* @return string
*/
public function getManifestLocation()
{
return $this->manifestLocation;
}
/**
* @param string
*/
public function setRoot($root)
{
$this->root = $root;
}
/**
* @return string
*/
public function getRoot()
{
return $this->root;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Manifest::class, 'Google_Service_Storagetransfer_Manifest');
@@ -0,0 +1,427 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class MetadataOptions extends \Google\Model
{
/**
* ACL behavior is unspecified.
*/
public const ACL_ACL_UNSPECIFIED = 'ACL_UNSPECIFIED';
/**
* Use the destination bucket's default object ACLS, if applicable.
*/
public const ACL_ACL_DESTINATION_BUCKET_DEFAULT = 'ACL_DESTINATION_BUCKET_DEFAULT';
/**
* Preserve the object's original ACLs. This requires the service account to
* have `storage.objects.getIamPolicy` permission for the source object.
* [Uniform bucket-level
* access](https://cloud.google.com/storage/docs/uniform-bucket-level-access)
* must not be enabled on either the source or destination buckets.
*/
public const ACL_ACL_PRESERVE = 'ACL_PRESERVE';
/**
* GID behavior is unspecified.
*/
public const GID_GID_UNSPECIFIED = 'GID_UNSPECIFIED';
/**
* Do not preserve GID during a transfer job.
*/
public const GID_GID_SKIP = 'GID_SKIP';
/**
* Preserve GID during a transfer job.
*/
public const GID_GID_NUMBER = 'GID_NUMBER';
/**
* KmsKey behavior is unspecified.
*/
public const KMS_KEY_KMS_KEY_UNSPECIFIED = 'KMS_KEY_UNSPECIFIED';
/**
* Use the destination bucket's default encryption settings.
*/
public const KMS_KEY_KMS_KEY_DESTINATION_BUCKET_DEFAULT = 'KMS_KEY_DESTINATION_BUCKET_DEFAULT';
/**
* Preserve the object's original Cloud KMS customer-managed encryption key
* (CMEK) if present. Objects that do not use a Cloud KMS encryption key will
* be encrypted using the destination bucket's encryption settings.
*/
public const KMS_KEY_KMS_KEY_PRESERVE = 'KMS_KEY_PRESERVE';
/**
* Mode behavior is unspecified.
*/
public const MODE_MODE_UNSPECIFIED = 'MODE_UNSPECIFIED';
/**
* Do not preserve mode during a transfer job.
*/
public const MODE_MODE_SKIP = 'MODE_SKIP';
/**
* Preserve mode during a transfer job.
*/
public const MODE_MODE_PRESERVE = 'MODE_PRESERVE';
/**
* Storage class behavior is unspecified.
*/
public const STORAGE_CLASS_STORAGE_CLASS_UNSPECIFIED = 'STORAGE_CLASS_UNSPECIFIED';
/**
* Use the destination bucket's default storage class.
*/
public const STORAGE_CLASS_STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT = 'STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT';
/**
* Preserve the object's original storage class. This is only supported for
* transfers from Google Cloud Storage buckets. REGIONAL and MULTI_REGIONAL
* storage classes will be mapped to STANDARD to ensure they can be written to
* the destination bucket.
*/
public const STORAGE_CLASS_STORAGE_CLASS_PRESERVE = 'STORAGE_CLASS_PRESERVE';
/**
* Set the storage class to STANDARD.
*/
public const STORAGE_CLASS_STORAGE_CLASS_STANDARD = 'STORAGE_CLASS_STANDARD';
/**
* Set the storage class to NEARLINE.
*/
public const STORAGE_CLASS_STORAGE_CLASS_NEARLINE = 'STORAGE_CLASS_NEARLINE';
/**
* Set the storage class to COLDLINE.
*/
public const STORAGE_CLASS_STORAGE_CLASS_COLDLINE = 'STORAGE_CLASS_COLDLINE';
/**
* Set the storage class to ARCHIVE.
*/
public const STORAGE_CLASS_STORAGE_CLASS_ARCHIVE = 'STORAGE_CLASS_ARCHIVE';
/**
* Symlink behavior is unspecified.
*/
public const SYMLINK_SYMLINK_UNSPECIFIED = 'SYMLINK_UNSPECIFIED';
/**
* Do not preserve symlinks during a transfer job.
*/
public const SYMLINK_SYMLINK_SKIP = 'SYMLINK_SKIP';
/**
* Preserve symlinks during a transfer job.
*/
public const SYMLINK_SYMLINK_PRESERVE = 'SYMLINK_PRESERVE';
/**
* Temporary hold behavior is unspecified.
*/
public const TEMPORARY_HOLD_TEMPORARY_HOLD_UNSPECIFIED = 'TEMPORARY_HOLD_UNSPECIFIED';
/**
* Do not set a temporary hold on the destination object.
*/
public const TEMPORARY_HOLD_TEMPORARY_HOLD_SKIP = 'TEMPORARY_HOLD_SKIP';
/**
* Preserve the object's original temporary hold status.
*/
public const TEMPORARY_HOLD_TEMPORARY_HOLD_PRESERVE = 'TEMPORARY_HOLD_PRESERVE';
/**
* TimeCreated behavior is unspecified.
*/
public const TIME_CREATED_TIME_CREATED_UNSPECIFIED = 'TIME_CREATED_UNSPECIFIED';
/**
* Do not preserve the `timeCreated` metadata from the source object.
*/
public const TIME_CREATED_TIME_CREATED_SKIP = 'TIME_CREATED_SKIP';
/**
* Preserves the source object's `timeCreated` or `lastModified` metadata in
* the `customTime` field in the destination object. Note that any value
* stored in the source object's `customTime` field will not be propagated to
* the destination object.
*/
public const TIME_CREATED_TIME_CREATED_PRESERVE_AS_CUSTOM_TIME = 'TIME_CREATED_PRESERVE_AS_CUSTOM_TIME';
/**
* UID behavior is unspecified.
*/
public const UID_UID_UNSPECIFIED = 'UID_UNSPECIFIED';
/**
* Do not preserve UID during a transfer job.
*/
public const UID_UID_SKIP = 'UID_SKIP';
/**
* Preserve UID during a transfer job.
*/
public const UID_UID_NUMBER = 'UID_NUMBER';
/**
* Specifies how each object's ACLs should be preserved for transfers between
* Google Cloud Storage buckets. If unspecified, the default behavior is the
* same as ACL_DESTINATION_BUCKET_DEFAULT.
*
* @var string
*/
public $acl;
/**
* Specifies how each file's POSIX group ID (GID) attribute should be handled
* by the transfer. By default, GID is not preserved. Only applicable to
* transfers involving POSIX file systems, and ignored for other transfers.
*
* @var string
*/
public $gid;
/**
* Specifies how each object's Cloud KMS customer-managed encryption key
* (CMEK) is preserved for transfers between Google Cloud Storage buckets. If
* unspecified, the default behavior is the same as
* KMS_KEY_DESTINATION_BUCKET_DEFAULT.
*
* @var string
*/
public $kmsKey;
/**
* Specifies how each file's mode attribute should be handled by the transfer.
* By default, mode is not preserved. Only applicable to transfers involving
* POSIX file systems, and ignored for other transfers.
*
* @var string
*/
public $mode;
/**
* Specifies the storage class to set on objects being transferred to Google
* Cloud Storage buckets. If unspecified, the default behavior is the same as
* STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT.
*
* @var string
*/
public $storageClass;
/**
* Specifies how symlinks should be handled by the transfer. By default,
* symlinks are not preserved. Only applicable to transfers involving POSIX
* file systems, and ignored for other transfers.
*
* @var string
*/
public $symlink;
/**
* Specifies how each object's temporary hold status should be preserved for
* transfers between Google Cloud Storage buckets. If unspecified, the default
* behavior is the same as TEMPORARY_HOLD_PRESERVE.
*
* @var string
*/
public $temporaryHold;
/**
* Specifies how each object's `timeCreated` metadata is preserved for
* transfers. If unspecified, the default behavior is the same as
* TIME_CREATED_SKIP. This behavior is supported for transfers to Cloud
* Storage buckets from Cloud Storage, Amazon S3, S3-compatible storage, and
* Azure sources.
*
* @var string
*/
public $timeCreated;
/**
* Specifies how each file's POSIX user ID (UID) attribute should be handled
* by the transfer. By default, UID is not preserved. Only applicable to
* transfers involving POSIX file systems, and ignored for other transfers.
*
* @var string
*/
public $uid;
/**
* Specifies how each object's ACLs should be preserved for transfers between
* Google Cloud Storage buckets. If unspecified, the default behavior is the
* same as ACL_DESTINATION_BUCKET_DEFAULT.
*
* Accepted values: ACL_UNSPECIFIED, ACL_DESTINATION_BUCKET_DEFAULT,
* ACL_PRESERVE
*
* @param self::ACL_* $acl
*/
public function setAcl($acl)
{
$this->acl = $acl;
}
/**
* @return self::ACL_*
*/
public function getAcl()
{
return $this->acl;
}
/**
* Specifies how each file's POSIX group ID (GID) attribute should be handled
* by the transfer. By default, GID is not preserved. Only applicable to
* transfers involving POSIX file systems, and ignored for other transfers.
*
* Accepted values: GID_UNSPECIFIED, GID_SKIP, GID_NUMBER
*
* @param self::GID_* $gid
*/
public function setGid($gid)
{
$this->gid = $gid;
}
/**
* @return self::GID_*
*/
public function getGid()
{
return $this->gid;
}
/**
* Specifies how each object's Cloud KMS customer-managed encryption key
* (CMEK) is preserved for transfers between Google Cloud Storage buckets. If
* unspecified, the default behavior is the same as
* KMS_KEY_DESTINATION_BUCKET_DEFAULT.
*
* Accepted values: KMS_KEY_UNSPECIFIED, KMS_KEY_DESTINATION_BUCKET_DEFAULT,
* KMS_KEY_PRESERVE
*
* @param self::KMS_KEY_* $kmsKey
*/
public function setKmsKey($kmsKey)
{
$this->kmsKey = $kmsKey;
}
/**
* @return self::KMS_KEY_*
*/
public function getKmsKey()
{
return $this->kmsKey;
}
/**
* Specifies how each file's mode attribute should be handled by the transfer.
* By default, mode is not preserved. Only applicable to transfers involving
* POSIX file systems, and ignored for other transfers.
*
* Accepted values: MODE_UNSPECIFIED, MODE_SKIP, MODE_PRESERVE
*
* @param self::MODE_* $mode
*/
public function setMode($mode)
{
$this->mode = $mode;
}
/**
* @return self::MODE_*
*/
public function getMode()
{
return $this->mode;
}
/**
* Specifies the storage class to set on objects being transferred to Google
* Cloud Storage buckets. If unspecified, the default behavior is the same as
* STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT.
*
* Accepted values: STORAGE_CLASS_UNSPECIFIED,
* STORAGE_CLASS_DESTINATION_BUCKET_DEFAULT, STORAGE_CLASS_PRESERVE,
* STORAGE_CLASS_STANDARD, STORAGE_CLASS_NEARLINE, STORAGE_CLASS_COLDLINE,
* STORAGE_CLASS_ARCHIVE
*
* @param self::STORAGE_CLASS_* $storageClass
*/
public function setStorageClass($storageClass)
{
$this->storageClass = $storageClass;
}
/**
* @return self::STORAGE_CLASS_*
*/
public function getStorageClass()
{
return $this->storageClass;
}
/**
* Specifies how symlinks should be handled by the transfer. By default,
* symlinks are not preserved. Only applicable to transfers involving POSIX
* file systems, and ignored for other transfers.
*
* Accepted values: SYMLINK_UNSPECIFIED, SYMLINK_SKIP, SYMLINK_PRESERVE
*
* @param self::SYMLINK_* $symlink
*/
public function setSymlink($symlink)
{
$this->symlink = $symlink;
}
/**
* @return self::SYMLINK_*
*/
public function getSymlink()
{
return $this->symlink;
}
/**
* Specifies how each object's temporary hold status should be preserved for
* transfers between Google Cloud Storage buckets. If unspecified, the default
* behavior is the same as TEMPORARY_HOLD_PRESERVE.
*
* Accepted values: TEMPORARY_HOLD_UNSPECIFIED, TEMPORARY_HOLD_SKIP,
* TEMPORARY_HOLD_PRESERVE
*
* @param self::TEMPORARY_HOLD_* $temporaryHold
*/
public function setTemporaryHold($temporaryHold)
{
$this->temporaryHold = $temporaryHold;
}
/**
* @return self::TEMPORARY_HOLD_*
*/
public function getTemporaryHold()
{
return $this->temporaryHold;
}
/**
* Specifies how each object's `timeCreated` metadata is preserved for
* transfers. If unspecified, the default behavior is the same as
* TIME_CREATED_SKIP. This behavior is supported for transfers to Cloud
* Storage buckets from Cloud Storage, Amazon S3, S3-compatible storage, and
* Azure sources.
*
* Accepted values: TIME_CREATED_UNSPECIFIED, TIME_CREATED_SKIP,
* TIME_CREATED_PRESERVE_AS_CUSTOM_TIME
*
* @param self::TIME_CREATED_* $timeCreated
*/
public function setTimeCreated($timeCreated)
{
$this->timeCreated = $timeCreated;
}
/**
* @return self::TIME_CREATED_*
*/
public function getTimeCreated()
{
return $this->timeCreated;
}
/**
* Specifies how each file's POSIX user ID (UID) attribute should be handled
* by the transfer. By default, UID is not preserved. Only applicable to
* transfers involving POSIX file systems, and ignored for other transfers.
*
* Accepted values: UID_UNSPECIFIED, UID_SKIP, UID_NUMBER
*
* @param self::UID_* $uid
*/
public function setUid($uid)
{
$this->uid = $uid;
}
/**
* @return self::UID_*
*/
public function getUid()
{
return $this->uid;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MetadataOptions::class, 'Google_Service_Storagetransfer_MetadataOptions');
@@ -0,0 +1,98 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class MetadataTaskSpec extends \Google\Model
{
/**
* @var string
*/
public $bucketName;
/**
* @var string
*/
public $generation;
/**
* @var string
*/
public $key;
/**
* @var string
*/
public $size;
/**
* @param string
*/
public function setBucketName($bucketName)
{
$this->bucketName = $bucketName;
}
/**
* @return string
*/
public function getBucketName()
{
return $this->bucketName;
}
/**
* @param string
*/
public function setGeneration($generation)
{
$this->generation = $generation;
}
/**
* @return string
*/
public function getGeneration()
{
return $this->generation;
}
/**
* @param string
*/
public function setKey($key)
{
$this->key = $key;
}
/**
* @return string
*/
public function getKey()
{
return $this->key;
}
/**
* @param string
*/
public function setSize($size)
{
$this->size = $size;
}
/**
* @return string
*/
public function getSize()
{
return $this->size;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MetadataTaskSpec::class, 'Google_Service_Storagetransfer_MetadataTaskSpec');
@@ -0,0 +1,115 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class NotificationConfig extends \Google\Collection
{
/**
* Illegal value, to avoid allowing a default.
*/
public const PAYLOAD_FORMAT_PAYLOAD_FORMAT_UNSPECIFIED = 'PAYLOAD_FORMAT_UNSPECIFIED';
/**
* No payload is included with the notification.
*/
public const PAYLOAD_FORMAT_NONE = 'NONE';
/**
* `TransferOperation` is [formatted as a JSON
* response](https://developers.google.com/protocol-buffers/docs/proto3#json),
* in application/json.
*/
public const PAYLOAD_FORMAT_JSON = 'JSON';
protected $collection_key = 'eventTypes';
/**
* Event types for which a notification is desired. If empty, send
* notifications for all event types.
*
* @var string[]
*/
public $eventTypes;
/**
* Required. The desired format of the notification message payloads.
*
* @var string
*/
public $payloadFormat;
/**
* Required. The `Topic.name` of the Pub/Sub topic to which to publish
* notifications. Must be of the format: `projects/{project}/topics/{topic}`.
* Not matching this format results in an INVALID_ARGUMENT error.
*
* @var string
*/
public $pubsubTopic;
/**
* Event types for which a notification is desired. If empty, send
* notifications for all event types.
*
* @param string[] $eventTypes
*/
public function setEventTypes($eventTypes)
{
$this->eventTypes = $eventTypes;
}
/**
* @return string[]
*/
public function getEventTypes()
{
return $this->eventTypes;
}
/**
* Required. The desired format of the notification message payloads.
*
* Accepted values: PAYLOAD_FORMAT_UNSPECIFIED, NONE, JSON
*
* @param self::PAYLOAD_FORMAT_* $payloadFormat
*/
public function setPayloadFormat($payloadFormat)
{
$this->payloadFormat = $payloadFormat;
}
/**
* @return self::PAYLOAD_FORMAT_*
*/
public function getPayloadFormat()
{
return $this->payloadFormat;
}
/**
* Required. The `Topic.name` of the Pub/Sub topic to which to publish
* notifications. Must be of the format: `projects/{project}/topics/{topic}`.
* Not matching this format results in an INVALID_ARGUMENT error.
*
* @param string $pubsubTopic
*/
public function setPubsubTopic($pubsubTopic)
{
$this->pubsubTopic = $pubsubTopic;
}
/**
* @return string
*/
public function getPubsubTopic()
{
return $this->pubsubTopic;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NotificationConfig::class, 'Google_Service_Storagetransfer_NotificationConfig');
@@ -0,0 +1,289 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class ObjectConditions extends \Google\Collection
{
protected $collection_key = 'includePrefixes';
/**
* If you specify `exclude_prefixes`, Storage Transfer Service uses the items
* in the `exclude_prefixes` array to determine which objects to exclude from
* a transfer. Objects must not start with one of the matching
* `exclude_prefixes` for inclusion in a transfer. The following are
* requirements of `exclude_prefixes`: * Each exclude-prefix can contain any
* sequence of Unicode characters, to a max length of 1024 bytes when
* UTF8-encoded, and must not contain Carriage Return or Line Feed characters.
* Wildcard matching and regular expression matching are not supported. * Each
* exclude-prefix must omit the leading slash. For example, to exclude the
* object `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the exclude-
* prefix as `logs/y=2015/requests.gz`. * None of the exclude-prefix values
* can be empty, if specified. * Each exclude-prefix must exclude a distinct
* portion of the object namespace. No exclude-prefix may be a prefix of
* another exclude-prefix. * If include_prefixes is specified, then each
* exclude-prefix must start with the value of a path explicitly included by
* `include_prefixes`. The max size of `exclude_prefixes` is 1000. For more
* information, see [Filtering objects from transfers](/storage-
* transfer/docs/filtering-objects-from-transfers).
*
* @var string[]
*/
public $excludePrefixes;
/**
* If you specify `include_prefixes`, Storage Transfer Service uses the items
* in the `include_prefixes` array to determine which objects to include in a
* transfer. Objects must start with one of the matching `include_prefixes`
* for inclusion in the transfer. If exclude_prefixes is specified, objects
* must not start with any of the `exclude_prefixes` specified for inclusion
* in the transfer. The following are requirements of `include_prefixes`: *
* Each include-prefix can contain any sequence of Unicode characters, to a
* max length of 1024 bytes when UTF8-encoded, and must not contain Carriage
* Return or Line Feed characters. Wildcard matching and regular expression
* matching are not supported. * Each include-prefix must omit the leading
* slash. For example, to include the object `s3://my-aws-
* bucket/logs/y=2015/requests.gz`, specify the include-prefix as
* `logs/y=2015/requests.gz`. * None of the include-prefix values can be
* empty, if specified. * Each include-prefix must include a distinct portion
* of the object namespace. No include-prefix may be a prefix of another
* include-prefix. The max size of `include_prefixes` is 1000. For more
* information, see [Filtering objects from transfers](/storage-
* transfer/docs/filtering-objects-from-transfers).
*
* @var string[]
*/
public $includePrefixes;
/**
* If specified, only objects with a "last modification time" before this
* timestamp and objects that don't have a "last modification time" are
* transferred.
*
* @var string
*/
public $lastModifiedBefore;
/**
* If specified, only objects with a "last modification time" on or after this
* timestamp and objects that don't have a "last modification time" are
* transferred. The `last_modified_since` and `last_modified_before` fields
* can be used together for chunked data processing. For example, consider a
* script that processes each day's worth of data at a time. For that you'd
* set each of the fields as follows: * `last_modified_since` to the start of
* the day * `last_modified_before` to the end of the day
*
* @var string
*/
public $lastModifiedSince;
/**
* Optional. If specified, only objects matching this glob are transferred.
*
* @var string
*/
public $matchGlob;
/**
* Ensures that objects are not transferred if a specific maximum time has
* elapsed since the "last modification time". When a TransferOperation
* begins, objects with a "last modification time" are transferred only if the
* elapsed time between the start_time of the `TransferOperation`and the "last
* modification time" of the object is less than the value of
* max_time_elapsed_since_last_modification`. Objects that do not have a "last
* modification time" are also transferred.
*
* @var string
*/
public $maxTimeElapsedSinceLastModification;
/**
* Ensures that objects are not transferred until a specific minimum time has
* elapsed after the "last modification time". When a TransferOperation
* begins, objects with a "last modification time" are transferred only if the
* elapsed time between the start_time of the `TransferOperation` and the
* "last modification time" of the object is equal to or greater than the
* value of min_time_elapsed_since_last_modification`. Objects that do not
* have a "last modification time" are also transferred.
*
* @var string
*/
public $minTimeElapsedSinceLastModification;
/**
* If you specify `exclude_prefixes`, Storage Transfer Service uses the items
* in the `exclude_prefixes` array to determine which objects to exclude from
* a transfer. Objects must not start with one of the matching
* `exclude_prefixes` for inclusion in a transfer. The following are
* requirements of `exclude_prefixes`: * Each exclude-prefix can contain any
* sequence of Unicode characters, to a max length of 1024 bytes when
* UTF8-encoded, and must not contain Carriage Return or Line Feed characters.
* Wildcard matching and regular expression matching are not supported. * Each
* exclude-prefix must omit the leading slash. For example, to exclude the
* object `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the exclude-
* prefix as `logs/y=2015/requests.gz`. * None of the exclude-prefix values
* can be empty, if specified. * Each exclude-prefix must exclude a distinct
* portion of the object namespace. No exclude-prefix may be a prefix of
* another exclude-prefix. * If include_prefixes is specified, then each
* exclude-prefix must start with the value of a path explicitly included by
* `include_prefixes`. The max size of `exclude_prefixes` is 1000. For more
* information, see [Filtering objects from transfers](/storage-
* transfer/docs/filtering-objects-from-transfers).
*
* @param string[] $excludePrefixes
*/
public function setExcludePrefixes($excludePrefixes)
{
$this->excludePrefixes = $excludePrefixes;
}
/**
* @return string[]
*/
public function getExcludePrefixes()
{
return $this->excludePrefixes;
}
/**
* If you specify `include_prefixes`, Storage Transfer Service uses the items
* in the `include_prefixes` array to determine which objects to include in a
* transfer. Objects must start with one of the matching `include_prefixes`
* for inclusion in the transfer. If exclude_prefixes is specified, objects
* must not start with any of the `exclude_prefixes` specified for inclusion
* in the transfer. The following are requirements of `include_prefixes`: *
* Each include-prefix can contain any sequence of Unicode characters, to a
* max length of 1024 bytes when UTF8-encoded, and must not contain Carriage
* Return or Line Feed characters. Wildcard matching and regular expression
* matching are not supported. * Each include-prefix must omit the leading
* slash. For example, to include the object `s3://my-aws-
* bucket/logs/y=2015/requests.gz`, specify the include-prefix as
* `logs/y=2015/requests.gz`. * None of the include-prefix values can be
* empty, if specified. * Each include-prefix must include a distinct portion
* of the object namespace. No include-prefix may be a prefix of another
* include-prefix. The max size of `include_prefixes` is 1000. For more
* information, see [Filtering objects from transfers](/storage-
* transfer/docs/filtering-objects-from-transfers).
*
* @param string[] $includePrefixes
*/
public function setIncludePrefixes($includePrefixes)
{
$this->includePrefixes = $includePrefixes;
}
/**
* @return string[]
*/
public function getIncludePrefixes()
{
return $this->includePrefixes;
}
/**
* If specified, only objects with a "last modification time" before this
* timestamp and objects that don't have a "last modification time" are
* transferred.
*
* @param string $lastModifiedBefore
*/
public function setLastModifiedBefore($lastModifiedBefore)
{
$this->lastModifiedBefore = $lastModifiedBefore;
}
/**
* @return string
*/
public function getLastModifiedBefore()
{
return $this->lastModifiedBefore;
}
/**
* If specified, only objects with a "last modification time" on or after this
* timestamp and objects that don't have a "last modification time" are
* transferred. The `last_modified_since` and `last_modified_before` fields
* can be used together for chunked data processing. For example, consider a
* script that processes each day's worth of data at a time. For that you'd
* set each of the fields as follows: * `last_modified_since` to the start of
* the day * `last_modified_before` to the end of the day
*
* @param string $lastModifiedSince
*/
public function setLastModifiedSince($lastModifiedSince)
{
$this->lastModifiedSince = $lastModifiedSince;
}
/**
* @return string
*/
public function getLastModifiedSince()
{
return $this->lastModifiedSince;
}
/**
* Optional. If specified, only objects matching this glob are transferred.
*
* @param string $matchGlob
*/
public function setMatchGlob($matchGlob)
{
$this->matchGlob = $matchGlob;
}
/**
* @return string
*/
public function getMatchGlob()
{
return $this->matchGlob;
}
/**
* Ensures that objects are not transferred if a specific maximum time has
* elapsed since the "last modification time". When a TransferOperation
* begins, objects with a "last modification time" are transferred only if the
* elapsed time between the start_time of the `TransferOperation`and the "last
* modification time" of the object is less than the value of
* max_time_elapsed_since_last_modification`. Objects that do not have a "last
* modification time" are also transferred.
*
* @param string $maxTimeElapsedSinceLastModification
*/
public function setMaxTimeElapsedSinceLastModification($maxTimeElapsedSinceLastModification)
{
$this->maxTimeElapsedSinceLastModification = $maxTimeElapsedSinceLastModification;
}
/**
* @return string
*/
public function getMaxTimeElapsedSinceLastModification()
{
return $this->maxTimeElapsedSinceLastModification;
}
/**
* Ensures that objects are not transferred until a specific minimum time has
* elapsed after the "last modification time". When a TransferOperation
* begins, objects with a "last modification time" are transferred only if the
* elapsed time between the start_time of the `TransferOperation` and the
* "last modification time" of the object is equal to or greater than the
* value of min_time_elapsed_since_last_modification`. Objects that do not
* have a "last modification time" are also transferred.
*
* @param string $minTimeElapsedSinceLastModification
*/
public function setMinTimeElapsedSinceLastModification($minTimeElapsedSinceLastModification)
{
$this->minTimeElapsedSinceLastModification = $minTimeElapsedSinceLastModification;
}
/**
* @return string
*/
public function getMinTimeElapsedSinceLastModification()
{
return $this->minTimeElapsedSinceLastModification;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ObjectConditions::class, 'Google_Service_Storagetransfer_ObjectConditions');
@@ -0,0 +1,62 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class ObjectPrefix extends \Google\Model
{
/**
* @var string
*/
public $bucketName;
/**
* @var string
*/
public $objectPrefix;
/**
* @param string
*/
public function setBucketName($bucketName)
{
$this->bucketName = $bucketName;
}
/**
* @return string
*/
public function getBucketName()
{
return $this->bucketName;
}
/**
* @param string
*/
public function setObjectPrefix($objectPrefix)
{
$this->objectPrefix = $objectPrefix;
}
/**
* @return string
*/
public function getObjectPrefix()
{
return $this->objectPrefix;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ObjectPrefix::class, 'Google_Service_Storagetransfer_ObjectPrefix');
@@ -0,0 +1,43 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class ObjectPrefixes extends \Google\Collection
{
protected $collection_key = 'objectPrefixes';
protected $objectPrefixesType = ObjectPrefix::class;
protected $objectPrefixesDataType = 'array';
/**
* @param ObjectPrefix[]
*/
public function setObjectPrefixes($objectPrefixes)
{
$this->objectPrefixes = $objectPrefixes;
}
/**
* @return ObjectPrefix[]
*/
public function getObjectPrefixes()
{
return $this->objectPrefixes;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ObjectPrefixes::class, 'Google_Service_Storagetransfer_ObjectPrefixes');
@@ -0,0 +1,152 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class Operation extends \Google\Model
{
/**
* If the value is `false`, it means the operation is still in progress. If
* `true`, the operation is completed, and either `error` or `response` is
* available.
*
* @var bool
*/
public $done;
protected $errorType = Status::class;
protected $errorDataType = '';
/**
* Represents the transfer operation object. To request a TransferOperation
* object, use transferOperations.get.
*
* @var array[]
*/
public $metadata;
/**
* The server-assigned unique name. The format of `name` is
* `transferOperations/some/unique/name`.
*
* @var string
*/
public $name;
/**
* The normal, successful response of the operation. If the original method
* returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx` is
* the original method name. For example, if the original method name is
* `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*
* @var array[]
*/
public $response;
/**
* If the value is `false`, it means the operation is still in progress. If
* `true`, the operation is completed, and either `error` or `response` is
* available.
*
* @param bool $done
*/
public function setDone($done)
{
$this->done = $done;
}
/**
* @return bool
*/
public function getDone()
{
return $this->done;
}
/**
* The error result of the operation in case of failure or cancellation.
*
* @param Status $error
*/
public function setError(Status $error)
{
$this->error = $error;
}
/**
* @return Status
*/
public function getError()
{
return $this->error;
}
/**
* Represents the transfer operation object. To request a TransferOperation
* object, use transferOperations.get.
*
* @param array[] $metadata
*/
public function setMetadata($metadata)
{
$this->metadata = $metadata;
}
/**
* @return array[]
*/
public function getMetadata()
{
return $this->metadata;
}
/**
* The server-assigned unique name. The format of `name` is
* `transferOperations/some/unique/name`.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* The normal, successful response of the operation. If the original method
* returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx` is
* the original method name. For example, if the original method name is
* `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*
* @param array[] $response
*/
public function setResponse($response)
{
$this->response = $response;
}
/**
* @return array[]
*/
public function getResponse()
{
return $this->response;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Operation::class, 'Google_Service_Storagetransfer_Operation');
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class PauseTransferOperationRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PauseTransferOperationRequest::class, 'Google_Service_Storagetransfer_PauseTransferOperationRequest');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class PosixFilesystem extends \Google\Model
{
/**
* Root directory path to the filesystem.
*
* @var string
*/
public $rootDirectory;
/**
* Root directory path to the filesystem.
*
* @param string $rootDirectory
*/
public function setRootDirectory($rootDirectory)
{
$this->rootDirectory = $rootDirectory;
}
/**
* @return string
*/
public function getRootDirectory()
{
return $this->rootDirectory;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PosixFilesystem::class, 'Google_Service_Storagetransfer_PosixFilesystem');
@@ -0,0 +1,102 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class ReplicationSpec extends \Google\Model
{
protected $gcsDataSinkType = GcsData::class;
protected $gcsDataSinkDataType = '';
protected $gcsDataSourceType = GcsData::class;
protected $gcsDataSourceDataType = '';
protected $objectConditionsType = ObjectConditions::class;
protected $objectConditionsDataType = '';
protected $transferOptionsType = TransferOptions::class;
protected $transferOptionsDataType = '';
/**
* The Cloud Storage bucket to which to replicate objects.
*
* @param GcsData $gcsDataSink
*/
public function setGcsDataSink(GcsData $gcsDataSink)
{
$this->gcsDataSink = $gcsDataSink;
}
/**
* @return GcsData
*/
public function getGcsDataSink()
{
return $this->gcsDataSink;
}
/**
* The Cloud Storage bucket from which to replicate objects.
*
* @param GcsData $gcsDataSource
*/
public function setGcsDataSource(GcsData $gcsDataSource)
{
$this->gcsDataSource = $gcsDataSource;
}
/**
* @return GcsData
*/
public function getGcsDataSource()
{
return $this->gcsDataSource;
}
/**
* Object conditions that determine which objects are transferred. For
* replication jobs, only `include_prefixes` and `exclude_prefixes` are
* supported.
*
* @param ObjectConditions $objectConditions
*/
public function setObjectConditions(ObjectConditions $objectConditions)
{
$this->objectConditions = $objectConditions;
}
/**
* @return ObjectConditions
*/
public function getObjectConditions()
{
return $this->objectConditions;
}
/**
* Specifies the metadata options to be applied during replication. Delete
* options are not supported. If a delete option is specified, the request
* fails with an INVALID_ARGUMENT error.
*
* @param TransferOptions $transferOptions
*/
public function setTransferOptions(TransferOptions $transferOptions)
{
$this->transferOptions = $transferOptions;
}
/**
* @return TransferOptions
*/
public function getTransferOptions()
{
return $this->transferOptions;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ReplicationSpec::class, 'Google_Service_Storagetransfer_ReplicationSpec');
@@ -0,0 +1,56 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer\Resource;
use Google\Service\Storagetransfer\GoogleServiceAccount;
/**
* The "googleServiceAccounts" collection of methods.
* Typical usage is:
* <code>
* $storagetransferService = new Google\Service\Storagetransfer(...);
* $googleServiceAccounts = $storagetransferService->googleServiceAccounts;
* </code>
*/
class GoogleServiceAccounts extends \Google\Service\Resource
{
/**
* 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 Cloud 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 Required. The ID of the Google Cloud project that
* the Google service account is associated with.
* @param array $optParams Optional parameters.
* @return GoogleServiceAccount
* @throws \Google\Service\Exception
*/
public function get($projectId, $optParams = [])
{
$params = ['projectId' => $projectId];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], GoogleServiceAccount::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleServiceAccounts::class, 'Google_Service_Storagetransfer_Resource_GoogleServiceAccounts');
@@ -0,0 +1,33 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer\Resource;
/**
* The "projects" collection of methods.
* Typical usage is:
* <code>
* $storagetransferService = new Google\Service\Storagetransfer(...);
* $projects = $storagetransferService->projects;
* </code>
*/
class Projects extends \Google\Service\Resource
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Projects::class, 'Google_Service_Storagetransfer_Resource_Projects');
@@ -0,0 +1,136 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer\Resource;
use Google\Service\Storagetransfer\AgentPool;
use Google\Service\Storagetransfer\ListAgentPoolsResponse;
use Google\Service\Storagetransfer\StoragetransferEmpty;
/**
* The "agentPools" collection of methods.
* Typical usage is:
* <code>
* $storagetransferService = new Google\Service\Storagetransfer(...);
* $agentPools = $storagetransferService->projects_agentPools;
* </code>
*/
class ProjectsAgentPools extends \Google\Service\Resource
{
/**
* Creates an agent pool resource. (agentPools.create)
*
* @param string $projectId Required. The ID of the Google Cloud project that
* owns the agent pool.
* @param AgentPool $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string agentPoolId Required. The ID of the agent pool to create.
* The `agent_pool_id` must meet the following requirements: * Length of 128
* characters or less. * Not start with the string `goog`. * Start with a
* lowercase ASCII character, followed by: * Zero or more: lowercase Latin
* alphabet characters, numerals, hyphens (`-`), periods (`.`), underscores
* (`_`), or tildes (`~`). * One or more numerals or lowercase ASCII characters.
* As expressed by the regular expression:
* `^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$`.
* @return AgentPool
* @throws \Google\Service\Exception
*/
public function create($projectId, AgentPool $postBody, $optParams = [])
{
$params = ['projectId' => $projectId, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], AgentPool::class);
}
/**
* Deletes an agent pool. (agentPools.delete)
*
* @param string $name Required. The name of the agent pool to delete.
* @param array $optParams Optional parameters.
* @return StoragetransferEmpty
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], StoragetransferEmpty::class);
}
/**
* Gets an agent pool. (agentPools.get)
*
* @param string $name Required. The name of the agent pool to get.
* @param array $optParams Optional parameters.
* @return AgentPool
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], AgentPool::class);
}
/**
* Lists agent pools. (agentPools.listProjectsAgentPools)
*
* @param string $projectId Required. The ID of the Google Cloud project that
* owns the job.
* @param array $optParams Optional parameters.
*
* @opt_param string filter An optional list of query parameters specified as
* JSON text in the form of:
* `{"agentPoolNames":["agentpool1","agentpool2",...]}` Since `agentPoolNames`
* support multiple values, its values must be specified with array notation.
* When the filter is either empty or not provided, the list returns all agent
* pools for the project.
* @opt_param int pageSize The list page size. The max allowed value is `256`.
* @opt_param string pageToken The list page token.
* @return ListAgentPoolsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsAgentPools($projectId, $optParams = [])
{
$params = ['projectId' => $projectId];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListAgentPoolsResponse::class);
}
/**
* Updates an existing agent pool resource. (agentPools.patch)
*
* @param string $name Required. Specifies a unique string that identifies the
* agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}`
* @param AgentPool $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask The [field mask]
* (https://developers.google.com/protocol-
* buffers/docs/reference/google.protobuf) of the fields in `agentPool` to
* update in this request. The following `agentPool` fields can be updated: *
* display_name * bandwidth_limit
* @return AgentPool
* @throws \Google\Service\Exception
*/
public function patch($name, AgentPool $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], AgentPool::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsAgentPools::class, 'Google_Service_Storagetransfer_Resource_ProjectsAgentPools');
@@ -0,0 +1,151 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer\Resource;
use Google\Service\Storagetransfer\ListTransferJobsResponse;
use Google\Service\Storagetransfer\Operation;
use Google\Service\Storagetransfer\RunTransferJobRequest;
use Google\Service\Storagetransfer\StoragetransferEmpty;
use Google\Service\Storagetransfer\TransferJob;
use Google\Service\Storagetransfer\UpdateTransferJobRequest;
/**
* The "transferJobs" collection of methods.
* Typical usage is:
* <code>
* $storagetransferService = new Google\Service\Storagetransfer(...);
* $transferJobs = $storagetransferService->transferJobs;
* </code>
*/
class TransferJobs extends \Google\Service\Resource
{
/**
* Creates a transfer job that runs periodically. (transferJobs.create)
*
* @param TransferJob $postBody
* @param array $optParams Optional parameters.
* @return TransferJob
* @throws \Google\Service\Exception
*/
public function create(TransferJob $postBody, $optParams = [])
{
$params = ['postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], TransferJob::class);
}
/**
* Deletes a transfer job. Deleting a transfer job sets its status to DELETED.
* (transferJobs.delete)
*
* @param string $jobName Required. The job to delete.
* @param string $projectId Required. The ID of the Google Cloud project that
* owns the job.
* @param array $optParams Optional parameters.
* @return StoragetransferEmpty
* @throws \Google\Service\Exception
*/
public function delete($jobName, $projectId, $optParams = [])
{
$params = ['jobName' => $jobName, 'projectId' => $projectId];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], StoragetransferEmpty::class);
}
/**
* Gets a transfer job. (transferJobs.get)
*
* @param string $jobName Required. The job to get.
* @param string $projectId Required. The ID of the Google Cloud project that
* owns the job.
* @param array $optParams Optional parameters.
* @return TransferJob
* @throws \Google\Service\Exception
*/
public function get($jobName, $projectId, $optParams = [])
{
$params = ['jobName' => $jobName, 'projectId' => $projectId];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], TransferJob::class);
}
/**
* Lists transfer jobs. (transferJobs.listTransferJobs)
*
* @param string $filter Required. A list of query parameters specified as JSON
* text in the form of: ``` { "projectId":"my_project_id",
* "jobNames":["jobid1","jobid2",...], "jobStatuses":["status1","status2",...],
* "dataBackend":"QUERY_REPLICATION_CONFIGS", "sourceBucket":"source-bucket-
* name", "sinkBucket":"sink-bucket-name", } ``` The JSON formatting in the
* example is for display only; provide the query parameters without spaces or
* line breaks. * `projectId` is required. * Since `jobNames` and `jobStatuses`
* support multiple values, their values must be specified with array notation.
* `jobNames` and `jobStatuses` are optional. Valid values are case-insensitive:
* * ENABLED * DISABLED * DELETED * Specify
* `"dataBackend":"QUERY_REPLICATION_CONFIGS"` to return a list of cross-bucket
* replication jobs. * Limit the results to jobs from a particular bucket with
* `sourceBucket` and/or to a particular bucket with `sinkBucket`.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The list page size. The max allowed value is 256.
* @opt_param string pageToken The list page token.
* @return ListTransferJobsResponse
* @throws \Google\Service\Exception
*/
public function listTransferJobs($filter, $optParams = [])
{
$params = ['filter' => $filter];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListTransferJobsResponse::class);
}
/**
* Updates a transfer job. Updating a job's transfer spec does not affect
* transfer operations that are running already. **Note:** The job's status
* field can be modified using this RPC (for example, to set a job's status to
* DELETED, DISABLED, or ENABLED). (transferJobs.patch)
*
* @param string $jobName Required. The name of job to update.
* @param UpdateTransferJobRequest $postBody
* @param array $optParams Optional parameters.
* @return TransferJob
* @throws \Google\Service\Exception
*/
public function patch($jobName, UpdateTransferJobRequest $postBody, $optParams = [])
{
$params = ['jobName' => $jobName, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], TransferJob::class);
}
/**
* Starts a new operation for the specified transfer job. A `TransferJob` has a
* maximum of one active `TransferOperation`. If this method is called while a
* `TransferOperation` is active, an error is returned. (transferJobs.run)
*
* @param string $jobName Required. The name of the transfer job.
* @param RunTransferJobRequest $postBody
* @param array $optParams Optional parameters.
* @return Operation
* @throws \Google\Service\Exception
*/
public function run($jobName, RunTransferJobRequest $postBody, $optParams = [])
{
$params = ['jobName' => $jobName, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('run', [$params], Operation::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TransferJobs::class, 'Google_Service_Storagetransfer_Resource_TransferJobs');
@@ -0,0 +1,159 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer\Resource;
use Google\Service\Storagetransfer\CancelOperationRequest;
use Google\Service\Storagetransfer\ListOperationsResponse;
use Google\Service\Storagetransfer\Operation;
use Google\Service\Storagetransfer\PauseTransferOperationRequest;
use Google\Service\Storagetransfer\ResumeTransferOperationRequest;
use Google\Service\Storagetransfer\StoragetransferEmpty;
/**
* The "transferOperations" collection of methods.
* Typical usage is:
* <code>
* $storagetransferService = new Google\Service\Storagetransfer(...);
* $transferOperations = $storagetransferService->transferOperations;
* </code>
*/
class TransferOperations extends \Google\Service\Resource
{
/**
* Cancels a transfer. Use the transferOperations.get method to check if the
* cancellation succeeded or if the operation completed despite the `cancel`
* request. When you cancel an operation, the currently running transfer is
* interrupted. For recurring transfer jobs, the next instance of the transfer
* job will still run. For example, if your job is configured to run every day
* at 1pm and you cancel Monday's operation at 1:05pm, Monday's transfer will
* stop. However, a transfer job will still be attempted on Tuesday. This
* applies only to currently running operations. If an operation is not
* currently running, `cancel` does nothing. *Caution:* Canceling a transfer job
* can leave your data in an unknown state. We recommend that you restore the
* state at both the destination and the source after the `cancel` request
* completes so that your data is in a consistent state. When you cancel a job,
* the next job computes a delta of files and may repair any inconsistent state.
* For instance, if you run a job every day, and today's job found 10 new files
* and transferred five files before you canceled the job, tomorrow's transfer
* operation will compute a new delta with the five files that were not copied
* today plus any new files discovered tomorrow. (transferOperations.cancel)
*
* @param string $name The name of the operation resource to be cancelled.
* @param CancelOperationRequest $postBody
* @param array $optParams Optional parameters.
* @return StoragetransferEmpty
* @throws \Google\Service\Exception
*/
public function cancel($name, CancelOperationRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('cancel', [$params], StoragetransferEmpty::class);
}
/**
* 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 Operation
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Operation::class);
}
/**
* Lists transfer operations. Operations are ordered by their creation time in
* reverse chronological order. (transferOperations.listTransferOperations)
*
* @param string $name Required. The name of the type being listed; must be
* `transferOperations`.
* @param string $filter Required. A list of query parameters specified as JSON
* text in the form of: `{"projectId":"my_project_id",
* "jobNames":["jobid1","jobid2",...], "jobNamePattern": "job_name_pattern",
* "operationNames":["opid1","opid2",...], "operationNamePattern":
* "operation_name_pattern", "minCreationTime": "min_creation_time",
* "maxCreationTime": "max_creation_time",
* "transferStatuses":["status1","status2",...]}` Since `jobNames`,
* `operationNames`, and `transferStatuses` support multiple values, they must
* be specified with array notation. `projectId` is the only argument that is
* required. If specified, `jobNamePattern` and `operationNamePattern` must
* match the full job or operation name respectively. '*' is a wildcard matching
* 0 or more characters. `minCreationTime` and `maxCreationTime` should be
* timestamps encoded as a string in the [RFC
* 3339](https://www.ietf.org/rfc/rfc3339.txt) format. The valid values for
* `transferStatuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS,
* FAILED, and ABORTED.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The list page size. The max allowed value is 256.
* @opt_param string pageToken The list page token.
* @opt_param bool returnPartialSuccess When set to `true`, operations that are
* reachable are returned as normal, and those that are unreachable are returned
* in the ListOperationsResponse.unreachable field. This can only be `true` when
* reading across collections. For example, when `parent` is set to
* `"projects/example/locations/-"`. This field is not supported by default and
* will result in an `UNIMPLEMENTED` error if set unless explicitly documented
* otherwise in service or product specific documentation.
* @return ListOperationsResponse
* @throws \Google\Service\Exception
*/
public function listTransferOperations($name, $filter, $optParams = [])
{
$params = ['name' => $name, 'filter' => $filter];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListOperationsResponse::class);
}
/**
* Pauses a transfer operation. (transferOperations.pause)
*
* @param string $name Required. The name of the transfer operation.
* @param PauseTransferOperationRequest $postBody
* @param array $optParams Optional parameters.
* @return StoragetransferEmpty
* @throws \Google\Service\Exception
*/
public function pause($name, PauseTransferOperationRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('pause', [$params], StoragetransferEmpty::class);
}
/**
* Resumes a transfer operation that is paused. (transferOperations.resume)
*
* @param string $name Required. The name of the transfer operation.
* @param ResumeTransferOperationRequest $postBody
* @param array $optParams Optional parameters.
* @return StoragetransferEmpty
* @throws \Google\Service\Exception
*/
public function resume($name, ResumeTransferOperationRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('resume', [$params], StoragetransferEmpty::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TransferOperations::class, 'Google_Service_Storagetransfer_Resource_TransferOperations');
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class ResumeTransferOperationRequest extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ResumeTransferOperationRequest::class, 'Google_Service_Storagetransfer_ResumeTransferOperationRequest');
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class RunTransferJobRequest extends \Google\Model
{
/**
* Required. The ID of the Google Cloud project that owns the transfer job.
*
* @var string
*/
public $projectId;
/**
* Required. The ID of the Google Cloud project that owns the transfer job.
*
* @param string $projectId
*/
public function setProjectId($projectId)
{
$this->projectId = $projectId;
}
/**
* @return string
*/
public function getProjectId()
{
return $this->projectId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RunTransferJobRequest::class, 'Google_Service_Storagetransfer_RunTransferJobRequest');
@@ -0,0 +1,189 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class S3CompatibleMetadata extends \Google\Model
{
/**
* AuthMethod is not specified.
*/
public const AUTH_METHOD_AUTH_METHOD_UNSPECIFIED = 'AUTH_METHOD_UNSPECIFIED';
/**
* Auth requests with AWS SigV4.
*/
public const AUTH_METHOD_AUTH_METHOD_AWS_SIGNATURE_V4 = 'AUTH_METHOD_AWS_SIGNATURE_V4';
/**
* Auth requests with AWS SigV2.
*/
public const AUTH_METHOD_AUTH_METHOD_AWS_SIGNATURE_V2 = 'AUTH_METHOD_AWS_SIGNATURE_V2';
/**
* ListApi is not specified.
*/
public const LIST_API_LIST_API_UNSPECIFIED = 'LIST_API_UNSPECIFIED';
/**
* Perform listing using ListObjectsV2 API.
*/
public const LIST_API_LIST_OBJECTS_V2 = 'LIST_OBJECTS_V2';
/**
* Legacy ListObjects API.
*/
public const LIST_API_LIST_OBJECTS = 'LIST_OBJECTS';
/**
* NetworkProtocol is not specified.
*/
public const PROTOCOL_NETWORK_PROTOCOL_UNSPECIFIED = 'NETWORK_PROTOCOL_UNSPECIFIED';
/**
* Perform requests using HTTPS.
*/
public const PROTOCOL_NETWORK_PROTOCOL_HTTPS = 'NETWORK_PROTOCOL_HTTPS';
/**
* Not recommended: This sends data in clear-text. This is only appropriate
* within a closed network or for publicly available data. Perform requests
* using HTTP.
*/
public const PROTOCOL_NETWORK_PROTOCOL_HTTP = 'NETWORK_PROTOCOL_HTTP';
/**
* RequestModel is not specified.
*/
public const REQUEST_MODEL_REQUEST_MODEL_UNSPECIFIED = 'REQUEST_MODEL_UNSPECIFIED';
/**
* Perform requests using Virtual Hosted Style. Example: https://bucket-
* name.s3.region.amazonaws.com/key-name
*/
public const REQUEST_MODEL_REQUEST_MODEL_VIRTUAL_HOSTED_STYLE = 'REQUEST_MODEL_VIRTUAL_HOSTED_STYLE';
/**
* Perform requests using Path Style. Example:
* https://s3.region.amazonaws.com/bucket-name/key-name
*/
public const REQUEST_MODEL_REQUEST_MODEL_PATH_STYLE = 'REQUEST_MODEL_PATH_STYLE';
/**
* Specifies the authentication and authorization method used by the storage
* service. When not specified, Transfer Service will attempt to determine
* right auth method to use.
*
* @var string
*/
public $authMethod;
/**
* The Listing API to use for discovering objects. When not specified,
* Transfer Service will attempt to determine the right API to use.
*
* @var string
*/
public $listApi;
/**
* Specifies the network protocol of the agent. When not specified, the
* default value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.
*
* @var string
*/
public $protocol;
/**
* Specifies the API request model used to call the storage service. When not
* specified, the default value of RequestModel
* REQUEST_MODEL_VIRTUAL_HOSTED_STYLE is used.
*
* @var string
*/
public $requestModel;
/**
* Specifies the authentication and authorization method used by the storage
* service. When not specified, Transfer Service will attempt to determine
* right auth method to use.
*
* Accepted values: AUTH_METHOD_UNSPECIFIED, AUTH_METHOD_AWS_SIGNATURE_V4,
* AUTH_METHOD_AWS_SIGNATURE_V2
*
* @param self::AUTH_METHOD_* $authMethod
*/
public function setAuthMethod($authMethod)
{
$this->authMethod = $authMethod;
}
/**
* @return self::AUTH_METHOD_*
*/
public function getAuthMethod()
{
return $this->authMethod;
}
/**
* The Listing API to use for discovering objects. When not specified,
* Transfer Service will attempt to determine the right API to use.
*
* Accepted values: LIST_API_UNSPECIFIED, LIST_OBJECTS_V2, LIST_OBJECTS
*
* @param self::LIST_API_* $listApi
*/
public function setListApi($listApi)
{
$this->listApi = $listApi;
}
/**
* @return self::LIST_API_*
*/
public function getListApi()
{
return $this->listApi;
}
/**
* Specifies the network protocol of the agent. When not specified, the
* default value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.
*
* Accepted values: NETWORK_PROTOCOL_UNSPECIFIED, NETWORK_PROTOCOL_HTTPS,
* NETWORK_PROTOCOL_HTTP
*
* @param self::PROTOCOL_* $protocol
*/
public function setProtocol($protocol)
{
$this->protocol = $protocol;
}
/**
* @return self::PROTOCOL_*
*/
public function getProtocol()
{
return $this->protocol;
}
/**
* Specifies the API request model used to call the storage service. When not
* specified, the default value of RequestModel
* REQUEST_MODEL_VIRTUAL_HOSTED_STYLE is used.
*
* Accepted values: REQUEST_MODEL_UNSPECIFIED,
* REQUEST_MODEL_VIRTUAL_HOSTED_STYLE, REQUEST_MODEL_PATH_STYLE
*
* @param self::REQUEST_MODEL_* $requestModel
*/
public function setRequestModel($requestModel)
{
$this->requestModel = $requestModel;
}
/**
* @return self::REQUEST_MODEL_*
*/
public function getRequestModel()
{
return $this->requestModel;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(S3CompatibleMetadata::class, 'Google_Service_Storagetransfer_S3CompatibleMetadata');
@@ -0,0 +1,152 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class Schedule extends \Google\Model
{
protected $endTimeOfDayType = TimeOfDay::class;
protected $endTimeOfDayDataType = '';
/**
* Interval between the start of each scheduled TransferOperation. If
* unspecified, the default value is 24 hours. This value may not be less than
* 1 hour.
*
* @var string
*/
public $repeatInterval;
protected $scheduleEndDateType = Date::class;
protected $scheduleEndDateDataType = '';
protected $scheduleStartDateType = Date::class;
protected $scheduleStartDateDataType = '';
protected $startTimeOfDayType = TimeOfDay::class;
protected $startTimeOfDayDataType = '';
/**
* The time in UTC that no further transfer operations are scheduled. Combined
* with schedule_end_date, `end_time_of_day` specifies the end date and time
* for starting new transfer operations. This field must be greater than or
* equal to the timestamp corresponding to the combination of
* schedule_start_date and start_time_of_day, and is subject to the following:
* * If `end_time_of_day` is not set and `schedule_end_date` is set, then a
* default value of `23:59:59` is used for `end_time_of_day`. * If
* `end_time_of_day` is set and `schedule_end_date` is not set, then
* INVALID_ARGUMENT is returned.
*
* @param TimeOfDay $endTimeOfDay
*/
public function setEndTimeOfDay(TimeOfDay $endTimeOfDay)
{
$this->endTimeOfDay = $endTimeOfDay;
}
/**
* @return TimeOfDay
*/
public function getEndTimeOfDay()
{
return $this->endTimeOfDay;
}
/**
* Interval between the start of each scheduled TransferOperation. If
* unspecified, the default value is 24 hours. This value may not be less than
* 1 hour.
*
* @param string $repeatInterval
*/
public function setRepeatInterval($repeatInterval)
{
$this->repeatInterval = $repeatInterval;
}
/**
* @return string
*/
public function getRepeatInterval()
{
return $this->repeatInterval;
}
/**
* The last day a transfer runs. Date boundaries are determined relative to
* UTC time. A job runs once per 24 hours within the following guidelines: *
* If `schedule_end_date` and schedule_start_date are the same and in the
* future relative to UTC, the transfer is executed only one time. * If
* `schedule_end_date` is later than `schedule_start_date` and
* `schedule_end_date` is in the future relative to UTC, the job runs each day
* at start_time_of_day through `schedule_end_date`.
*
* @param Date $scheduleEndDate
*/
public function setScheduleEndDate(Date $scheduleEndDate)
{
$this->scheduleEndDate = $scheduleEndDate;
}
/**
* @return Date
*/
public function getScheduleEndDate()
{
return $this->scheduleEndDate;
}
/**
* Required. The start date of a transfer. Date boundaries are determined
* relative to UTC time. If `schedule_start_date` and start_time_of_day are in
* the past relative to the job's creation time, the transfer starts the day
* after you schedule the transfer request. **Note:** When starting jobs at or
* near midnight UTC it is possible that a job starts later than expected. For
* example, if you send an outbound request on June 1 one millisecond prior to
* midnight UTC and the Storage Transfer Service server receives the request
* on June 2, then it creates a TransferJob with `schedule_start_date` set to
* June 2 and a `start_time_of_day` set to midnight UTC. The first scheduled
* TransferOperation takes place on June 3 at midnight UTC.
*
* @param Date $scheduleStartDate
*/
public function setScheduleStartDate(Date $scheduleStartDate)
{
$this->scheduleStartDate = $scheduleStartDate;
}
/**
* @return Date
*/
public function getScheduleStartDate()
{
return $this->scheduleStartDate;
}
/**
* The time in UTC that a transfer job is scheduled to run. Transfers may
* start later than this time. If `start_time_of_day` is not specified: * One-
* time transfers run immediately. * Recurring transfers run immediately, and
* each day at midnight UTC, through schedule_end_date. If `start_time_of_day`
* is specified: * One-time transfers run at the specified time. * Recurring
* transfers run at the specified time each day, through `schedule_end_date`.
*
* @param TimeOfDay $startTimeOfDay
*/
public function setStartTimeOfDay(TimeOfDay $startTimeOfDay)
{
$this->startTimeOfDay = $startTimeOfDay;
}
/**
* @return TimeOfDay
*/
public function getStartTimeOfDay()
{
return $this->startTimeOfDay;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Schedule::class, 'Google_Service_Storagetransfer_Schedule');
@@ -0,0 +1,99 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class Status extends \Google\Collection
{
protected $collection_key = 'details';
/**
* The status code, which should be an enum value of google.rpc.Code.
*
* @var int
*/
public $code;
/**
* A list of messages that carry the error details. There is a common set of
* message types for APIs to use.
*
* @var array[]
*/
public $details;
/**
* A developer-facing error message, which should be in English. Any user-
* facing error message should be localized and sent in the
* google.rpc.Status.details field, or localized by the client.
*
* @var string
*/
public $message;
/**
* The status code, which should be an enum value of google.rpc.Code.
*
* @param int $code
*/
public function setCode($code)
{
$this->code = $code;
}
/**
* @return int
*/
public function getCode()
{
return $this->code;
}
/**
* A list of messages that carry the error details. There is a common set of
* message types for APIs to use.
*
* @param array[] $details
*/
public function setDetails($details)
{
$this->details = $details;
}
/**
* @return array[]
*/
public function getDetails()
{
return $this->details;
}
/**
* A developer-facing error message, which should be in English. Any user-
* facing error message should be localized and sent in the
* google.rpc.Status.details field, or localized by the client.
*
* @param string $message
*/
public function setMessage($message)
{
$this->message = $message;
}
/**
* @return string
*/
public function getMessage()
{
return $this->message;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Status::class, 'Google_Service_Storagetransfer_Status');
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class StoragetransferEmpty extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(StoragetransferEmpty::class, 'Google_Service_Storagetransfer_StoragetransferEmpty');
@@ -0,0 +1,126 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class TimeOfDay extends \Google\Model
{
/**
* Hours of a day in 24 hour format. Must be greater than or equal to 0 and
* typically must be less than or equal to 23. An API may choose to allow the
* value "24:00:00" for scenarios like business closing time.
*
* @var int
*/
public $hours;
/**
* Minutes of an hour. Must be greater than or equal to 0 and less than or
* equal to 59.
*
* @var int
*/
public $minutes;
/**
* Fractions of seconds, in nanoseconds. Must be greater than or equal to 0
* and less than or equal to 999,999,999.
*
* @var int
*/
public $nanos;
/**
* Seconds of a minute. Must be greater than or equal to 0 and typically must
* be less than or equal to 59. An API may allow the value 60 if it allows
* leap-seconds.
*
* @var int
*/
public $seconds;
/**
* Hours of a day in 24 hour format. Must be greater than or equal to 0 and
* typically must be less than or equal to 23. An API may choose to allow the
* value "24:00:00" for scenarios like business closing time.
*
* @param int $hours
*/
public function setHours($hours)
{
$this->hours = $hours;
}
/**
* @return int
*/
public function getHours()
{
return $this->hours;
}
/**
* Minutes of an hour. Must be greater than or equal to 0 and less than or
* equal to 59.
*
* @param int $minutes
*/
public function setMinutes($minutes)
{
$this->minutes = $minutes;
}
/**
* @return int
*/
public function getMinutes()
{
return $this->minutes;
}
/**
* Fractions of seconds, in nanoseconds. Must be greater than or equal to 0
* and less than or equal to 999,999,999.
*
* @param int $nanos
*/
public function setNanos($nanos)
{
$this->nanos = $nanos;
}
/**
* @return int
*/
public function getNanos()
{
return $this->nanos;
}
/**
* Seconds of a minute. Must be greater than or equal to 0 and typically must
* be less than or equal to 59. An API may allow the value 60 if it allows
* leap-seconds.
*
* @param int $seconds
*/
public function setSeconds($seconds)
{
$this->seconds = $seconds;
}
/**
* @return int
*/
public function getSeconds()
{
return $this->seconds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TimeOfDay::class, 'Google_Service_Storagetransfer_TimeOfDay');
@@ -0,0 +1,566 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class TransferCounters extends \Google\Model
{
/**
* Bytes that are copied to the data sink.
*
* @var string
*/
public $bytesCopiedToSink;
/**
* Bytes that are deleted from the data sink.
*
* @var string
*/
public $bytesDeletedFromSink;
/**
* Bytes that are deleted from the data source.
*
* @var string
*/
public $bytesDeletedFromSource;
/**
* Bytes that failed to be deleted from the data sink.
*
* @var string
*/
public $bytesFailedToDeleteFromSink;
/**
* Bytes found in the data source that are scheduled to be transferred,
* excluding any that are filtered based on object conditions or skipped due
* to sync.
*
* @var string
*/
public $bytesFoundFromSource;
/**
* Bytes found only in the data sink that are scheduled to be deleted.
*
* @var string
*/
public $bytesFoundOnlyFromSink;
/**
* Bytes in the data source that failed to be transferred or that failed to be
* deleted after being transferred.
*
* @var string
*/
public $bytesFromSourceFailed;
/**
* Bytes in the data source that are not transferred because they already
* exist in the data sink.
*
* @var string
*/
public $bytesFromSourceSkippedBySync;
/**
* For transfers involving PosixFilesystem only. Number of listing failures
* for each directory found at the source. Potential failures when listing a
* directory include permission failure or block failure. If listing a
* directory fails, no files in the directory are transferred.
*
* @var string
*/
public $directoriesFailedToListFromSource;
/**
* For transfers involving PosixFilesystem only. Number of directories found
* while listing. For example, if the root directory of the transfer is
* `base/` and there are two other directories, `a/` and `b/` under this
* directory, the count after listing `base/`, `base/a/` and `base/b/` is 3.
*
* @var string
*/
public $directoriesFoundFromSource;
/**
* For transfers involving PosixFilesystem only. Number of successful listings
* for each directory found at the source.
*
* @var string
*/
public $directoriesSuccessfullyListedFromSource;
/**
* Number of successfully cleaned up intermediate objects.
*
* @var string
*/
public $intermediateObjectsCleanedUp;
/**
* Number of intermediate objects failed cleaned up.
*
* @var string
*/
public $intermediateObjectsFailedCleanedUp;
/**
* Objects that are copied to the data sink.
*
* @var string
*/
public $objectsCopiedToSink;
/**
* Objects that are deleted from the data sink.
*
* @var string
*/
public $objectsDeletedFromSink;
/**
* Objects that are deleted from the data source.
*
* @var string
*/
public $objectsDeletedFromSource;
/**
* Objects that failed to be deleted from the data sink.
*
* @var string
*/
public $objectsFailedToDeleteFromSink;
/**
* Objects found in the data source that are scheduled to be transferred,
* excluding any that are filtered based on object conditions or skipped due
* to sync.
*
* @var string
*/
public $objectsFoundFromSource;
/**
* Objects found only in the data sink that are scheduled to be deleted.
*
* @var string
*/
public $objectsFoundOnlyFromSink;
/**
* Objects in the data source that failed to be transferred or that failed to
* be deleted after being transferred.
*
* @var string
*/
public $objectsFromSourceFailed;
/**
* Objects in the data source that are not transferred because they already
* exist in the data sink.
*
* @var string
*/
public $objectsFromSourceSkippedBySync;
/**
* Number of unrestored deep archive objects skipped.
*
* @var string
*/
public $unrestoredDeepArchiveObjectsSkippedCount;
/**
* Number of glacier objects skipped, glacier objects are unsupported by
* default regardless of the restore status. Allowlist the project to copy
* glacier objects if needed.
*
* @var string
*/
public $unsupportedS3GlacierObjectsSkippedCount;
/**
* Bytes that are copied to the data sink.
*
* @param string $bytesCopiedToSink
*/
public function setBytesCopiedToSink($bytesCopiedToSink)
{
$this->bytesCopiedToSink = $bytesCopiedToSink;
}
/**
* @return string
*/
public function getBytesCopiedToSink()
{
return $this->bytesCopiedToSink;
}
/**
* Bytes that are deleted from the data sink.
*
* @param string $bytesDeletedFromSink
*/
public function setBytesDeletedFromSink($bytesDeletedFromSink)
{
$this->bytesDeletedFromSink = $bytesDeletedFromSink;
}
/**
* @return string
*/
public function getBytesDeletedFromSink()
{
return $this->bytesDeletedFromSink;
}
/**
* Bytes that are deleted from the data source.
*
* @param string $bytesDeletedFromSource
*/
public function setBytesDeletedFromSource($bytesDeletedFromSource)
{
$this->bytesDeletedFromSource = $bytesDeletedFromSource;
}
/**
* @return string
*/
public function getBytesDeletedFromSource()
{
return $this->bytesDeletedFromSource;
}
/**
* Bytes that failed to be deleted from the data sink.
*
* @param string $bytesFailedToDeleteFromSink
*/
public function setBytesFailedToDeleteFromSink($bytesFailedToDeleteFromSink)
{
$this->bytesFailedToDeleteFromSink = $bytesFailedToDeleteFromSink;
}
/**
* @return string
*/
public function getBytesFailedToDeleteFromSink()
{
return $this->bytesFailedToDeleteFromSink;
}
/**
* Bytes found in the data source that are scheduled to be transferred,
* excluding any that are filtered based on object conditions or skipped due
* to sync.
*
* @param string $bytesFoundFromSource
*/
public function setBytesFoundFromSource($bytesFoundFromSource)
{
$this->bytesFoundFromSource = $bytesFoundFromSource;
}
/**
* @return string
*/
public function getBytesFoundFromSource()
{
return $this->bytesFoundFromSource;
}
/**
* Bytes found only in the data sink that are scheduled to be deleted.
*
* @param string $bytesFoundOnlyFromSink
*/
public function setBytesFoundOnlyFromSink($bytesFoundOnlyFromSink)
{
$this->bytesFoundOnlyFromSink = $bytesFoundOnlyFromSink;
}
/**
* @return string
*/
public function getBytesFoundOnlyFromSink()
{
return $this->bytesFoundOnlyFromSink;
}
/**
* Bytes in the data source that failed to be transferred or that failed to be
* deleted after being transferred.
*
* @param string $bytesFromSourceFailed
*/
public function setBytesFromSourceFailed($bytesFromSourceFailed)
{
$this->bytesFromSourceFailed = $bytesFromSourceFailed;
}
/**
* @return string
*/
public function getBytesFromSourceFailed()
{
return $this->bytesFromSourceFailed;
}
/**
* Bytes in the data source that are not transferred because they already
* exist in the data sink.
*
* @param string $bytesFromSourceSkippedBySync
*/
public function setBytesFromSourceSkippedBySync($bytesFromSourceSkippedBySync)
{
$this->bytesFromSourceSkippedBySync = $bytesFromSourceSkippedBySync;
}
/**
* @return string
*/
public function getBytesFromSourceSkippedBySync()
{
return $this->bytesFromSourceSkippedBySync;
}
/**
* For transfers involving PosixFilesystem only. Number of listing failures
* for each directory found at the source. Potential failures when listing a
* directory include permission failure or block failure. If listing a
* directory fails, no files in the directory are transferred.
*
* @param string $directoriesFailedToListFromSource
*/
public function setDirectoriesFailedToListFromSource($directoriesFailedToListFromSource)
{
$this->directoriesFailedToListFromSource = $directoriesFailedToListFromSource;
}
/**
* @return string
*/
public function getDirectoriesFailedToListFromSource()
{
return $this->directoriesFailedToListFromSource;
}
/**
* For transfers involving PosixFilesystem only. Number of directories found
* while listing. For example, if the root directory of the transfer is
* `base/` and there are two other directories, `a/` and `b/` under this
* directory, the count after listing `base/`, `base/a/` and `base/b/` is 3.
*
* @param string $directoriesFoundFromSource
*/
public function setDirectoriesFoundFromSource($directoriesFoundFromSource)
{
$this->directoriesFoundFromSource = $directoriesFoundFromSource;
}
/**
* @return string
*/
public function getDirectoriesFoundFromSource()
{
return $this->directoriesFoundFromSource;
}
/**
* For transfers involving PosixFilesystem only. Number of successful listings
* for each directory found at the source.
*
* @param string $directoriesSuccessfullyListedFromSource
*/
public function setDirectoriesSuccessfullyListedFromSource($directoriesSuccessfullyListedFromSource)
{
$this->directoriesSuccessfullyListedFromSource = $directoriesSuccessfullyListedFromSource;
}
/**
* @return string
*/
public function getDirectoriesSuccessfullyListedFromSource()
{
return $this->directoriesSuccessfullyListedFromSource;
}
/**
* Number of successfully cleaned up intermediate objects.
*
* @param string $intermediateObjectsCleanedUp
*/
public function setIntermediateObjectsCleanedUp($intermediateObjectsCleanedUp)
{
$this->intermediateObjectsCleanedUp = $intermediateObjectsCleanedUp;
}
/**
* @return string
*/
public function getIntermediateObjectsCleanedUp()
{
return $this->intermediateObjectsCleanedUp;
}
/**
* Number of intermediate objects failed cleaned up.
*
* @param string $intermediateObjectsFailedCleanedUp
*/
public function setIntermediateObjectsFailedCleanedUp($intermediateObjectsFailedCleanedUp)
{
$this->intermediateObjectsFailedCleanedUp = $intermediateObjectsFailedCleanedUp;
}
/**
* @return string
*/
public function getIntermediateObjectsFailedCleanedUp()
{
return $this->intermediateObjectsFailedCleanedUp;
}
/**
* Objects that are copied to the data sink.
*
* @param string $objectsCopiedToSink
*/
public function setObjectsCopiedToSink($objectsCopiedToSink)
{
$this->objectsCopiedToSink = $objectsCopiedToSink;
}
/**
* @return string
*/
public function getObjectsCopiedToSink()
{
return $this->objectsCopiedToSink;
}
/**
* Objects that are deleted from the data sink.
*
* @param string $objectsDeletedFromSink
*/
public function setObjectsDeletedFromSink($objectsDeletedFromSink)
{
$this->objectsDeletedFromSink = $objectsDeletedFromSink;
}
/**
* @return string
*/
public function getObjectsDeletedFromSink()
{
return $this->objectsDeletedFromSink;
}
/**
* Objects that are deleted from the data source.
*
* @param string $objectsDeletedFromSource
*/
public function setObjectsDeletedFromSource($objectsDeletedFromSource)
{
$this->objectsDeletedFromSource = $objectsDeletedFromSource;
}
/**
* @return string
*/
public function getObjectsDeletedFromSource()
{
return $this->objectsDeletedFromSource;
}
/**
* Objects that failed to be deleted from the data sink.
*
* @param string $objectsFailedToDeleteFromSink
*/
public function setObjectsFailedToDeleteFromSink($objectsFailedToDeleteFromSink)
{
$this->objectsFailedToDeleteFromSink = $objectsFailedToDeleteFromSink;
}
/**
* @return string
*/
public function getObjectsFailedToDeleteFromSink()
{
return $this->objectsFailedToDeleteFromSink;
}
/**
* Objects found in the data source that are scheduled to be transferred,
* excluding any that are filtered based on object conditions or skipped due
* to sync.
*
* @param string $objectsFoundFromSource
*/
public function setObjectsFoundFromSource($objectsFoundFromSource)
{
$this->objectsFoundFromSource = $objectsFoundFromSource;
}
/**
* @return string
*/
public function getObjectsFoundFromSource()
{
return $this->objectsFoundFromSource;
}
/**
* Objects found only in the data sink that are scheduled to be deleted.
*
* @param string $objectsFoundOnlyFromSink
*/
public function setObjectsFoundOnlyFromSink($objectsFoundOnlyFromSink)
{
$this->objectsFoundOnlyFromSink = $objectsFoundOnlyFromSink;
}
/**
* @return string
*/
public function getObjectsFoundOnlyFromSink()
{
return $this->objectsFoundOnlyFromSink;
}
/**
* Objects in the data source that failed to be transferred or that failed to
* be deleted after being transferred.
*
* @param string $objectsFromSourceFailed
*/
public function setObjectsFromSourceFailed($objectsFromSourceFailed)
{
$this->objectsFromSourceFailed = $objectsFromSourceFailed;
}
/**
* @return string
*/
public function getObjectsFromSourceFailed()
{
return $this->objectsFromSourceFailed;
}
/**
* Objects in the data source that are not transferred because they already
* exist in the data sink.
*
* @param string $objectsFromSourceSkippedBySync
*/
public function setObjectsFromSourceSkippedBySync($objectsFromSourceSkippedBySync)
{
$this->objectsFromSourceSkippedBySync = $objectsFromSourceSkippedBySync;
}
/**
* @return string
*/
public function getObjectsFromSourceSkippedBySync()
{
return $this->objectsFromSourceSkippedBySync;
}
/**
* Number of unrestored deep archive objects skipped.
*
* @param string $unrestoredDeepArchiveObjectsSkippedCount
*/
public function setUnrestoredDeepArchiveObjectsSkippedCount($unrestoredDeepArchiveObjectsSkippedCount)
{
$this->unrestoredDeepArchiveObjectsSkippedCount = $unrestoredDeepArchiveObjectsSkippedCount;
}
/**
* @return string
*/
public function getUnrestoredDeepArchiveObjectsSkippedCount()
{
return $this->unrestoredDeepArchiveObjectsSkippedCount;
}
/**
* Number of glacier objects skipped, glacier objects are unsupported by
* default regardless of the restore status. Allowlist the project to copy
* glacier objects if needed.
*
* @param string $unsupportedS3GlacierObjectsSkippedCount
*/
public function setUnsupportedS3GlacierObjectsSkippedCount($unsupportedS3GlacierObjectsSkippedCount)
{
$this->unsupportedS3GlacierObjectsSkippedCount = $unsupportedS3GlacierObjectsSkippedCount;
}
/**
* @return string
*/
public function getUnsupportedS3GlacierObjectsSkippedCount()
{
return $this->unsupportedS3GlacierObjectsSkippedCount;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TransferCounters::class, 'Google_Service_Storagetransfer_TransferCounters');
@@ -0,0 +1,408 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class TransferJob extends \Google\Model
{
/**
* Zero is an illegal value.
*/
public const STATUS_STATUS_UNSPECIFIED = 'STATUS_UNSPECIFIED';
/**
* New transfers are performed based on the schedule.
*/
public const STATUS_ENABLED = 'ENABLED';
/**
* New transfers are not scheduled.
*/
public const STATUS_DISABLED = 'DISABLED';
/**
* This is a soft delete state. After a transfer job is set to this state, the
* job and all the transfer executions are subject to garbage collection.
* Transfer jobs become eligible for garbage collection 30 days after their
* status is set to `DELETED`.
*/
public const STATUS_DELETED = 'DELETED';
/**
* Output only. The time that the transfer job was created.
*
* @var string
*/
public $creationTime;
/**
* Output only. The time that the transfer job was deleted.
*
* @var string
*/
public $deletionTime;
/**
* A description provided by the user for the job. Its max length is 1024
* bytes when Unicode-encoded.
*
* @var string
*/
public $description;
protected $eventStreamType = EventStream::class;
protected $eventStreamDataType = '';
/**
* Output only. The time that the transfer job was last modified.
*
* @var string
*/
public $lastModificationTime;
/**
* The name of the most recently started TransferOperation of this JobConfig.
* Present if a TransferOperation has been created for this JobConfig.
*
* @var string
*/
public $latestOperationName;
protected $loggingConfigType = LoggingConfig::class;
protected $loggingConfigDataType = '';
/**
* A unique name (within the transfer project) assigned when the job is
* created. If this field is empty in a CreateTransferJobRequest, Storage
* Transfer Service assigns a unique name. Otherwise, the specified name is
* used as the unique name for this job. If the specified name is in use by a
* job, the creation request fails with an ALREADY_EXISTS error. This name
* must start with `"transferJobs/"` prefix and end with a letter or a number,
* and should be no more than 128 characters. For transfers involving
* PosixFilesystem, this name must start with `transferJobs/OPI` specifically.
* For all other transfer types, this name must not start with
* `transferJobs/OPI`. Non-PosixFilesystem example:
* `"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"` PosixFilesystem
* example: `"transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Applications
* must not rely on the enforcement of naming requirements involving OPI.
* Invalid job names fail with an INVALID_ARGUMENT error.
*
* @var string
*/
public $name;
protected $notificationConfigType = NotificationConfig::class;
protected $notificationConfigDataType = '';
/**
* The ID of the Google Cloud project that owns the job.
*
* @var string
*/
public $projectId;
protected $replicationSpecType = ReplicationSpec::class;
protected $replicationSpecDataType = '';
protected $scheduleType = Schedule::class;
protected $scheduleDataType = '';
/**
* Optional. The user-managed service account to which to delegate service
* agent permissions. You can grant Cloud Storage bucket permissions to this
* service account instead of to the Transfer Service service agent. Either
* the service account email
* (`SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com`) or the unique
* ID (`123456789012345678901`) are accepted. See
* https://docs.cloud.google.com/storage-transfer/docs/delegate-service-agent-
* permissions for required permissions.
*
* @var string
*/
public $serviceAccount;
/**
* Status of the job. This value MUST be specified for
* `CreateTransferJobRequests`. **Note:** The effect of the new job status
* takes place during a subsequent job run. For example, if you change the job
* status from ENABLED to DISABLED, and an operation spawned by the transfer
* is running, the status change would not affect the current operation.
*
* @var string
*/
public $status;
protected $transferSpecType = TransferSpec::class;
protected $transferSpecDataType = '';
/**
* Output only. The time that the transfer job was created.
*
* @param string $creationTime
*/
public function setCreationTime($creationTime)
{
$this->creationTime = $creationTime;
}
/**
* @return string
*/
public function getCreationTime()
{
return $this->creationTime;
}
/**
* Output only. The time that the transfer job was deleted.
*
* @param string $deletionTime
*/
public function setDeletionTime($deletionTime)
{
$this->deletionTime = $deletionTime;
}
/**
* @return string
*/
public function getDeletionTime()
{
return $this->deletionTime;
}
/**
* A description provided by the user for the job. Its max length is 1024
* bytes when Unicode-encoded.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* Specifies the event stream for the transfer job for event-driven transfers.
* When EventStream is specified, the Schedule fields are ignored.
*
* @param EventStream $eventStream
*/
public function setEventStream(EventStream $eventStream)
{
$this->eventStream = $eventStream;
}
/**
* @return EventStream
*/
public function getEventStream()
{
return $this->eventStream;
}
/**
* Output only. The time that the transfer job was last modified.
*
* @param string $lastModificationTime
*/
public function setLastModificationTime($lastModificationTime)
{
$this->lastModificationTime = $lastModificationTime;
}
/**
* @return string
*/
public function getLastModificationTime()
{
return $this->lastModificationTime;
}
/**
* The name of the most recently started TransferOperation of this JobConfig.
* Present if a TransferOperation has been created for this JobConfig.
*
* @param string $latestOperationName
*/
public function setLatestOperationName($latestOperationName)
{
$this->latestOperationName = $latestOperationName;
}
/**
* @return string
*/
public function getLatestOperationName()
{
return $this->latestOperationName;
}
/**
* Logging configuration.
*
* @param LoggingConfig $loggingConfig
*/
public function setLoggingConfig(LoggingConfig $loggingConfig)
{
$this->loggingConfig = $loggingConfig;
}
/**
* @return LoggingConfig
*/
public function getLoggingConfig()
{
return $this->loggingConfig;
}
/**
* A unique name (within the transfer project) assigned when the job is
* created. If this field is empty in a CreateTransferJobRequest, Storage
* Transfer Service assigns a unique name. Otherwise, the specified name is
* used as the unique name for this job. If the specified name is in use by a
* job, the creation request fails with an ALREADY_EXISTS error. This name
* must start with `"transferJobs/"` prefix and end with a letter or a number,
* and should be no more than 128 characters. For transfers involving
* PosixFilesystem, this name must start with `transferJobs/OPI` specifically.
* For all other transfer types, this name must not start with
* `transferJobs/OPI`. Non-PosixFilesystem example:
* `"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"` PosixFilesystem
* example: `"transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Applications
* must not rely on the enforcement of naming requirements involving OPI.
* Invalid job names fail with an INVALID_ARGUMENT error.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Notification configuration.
*
* @param NotificationConfig $notificationConfig
*/
public function setNotificationConfig(NotificationConfig $notificationConfig)
{
$this->notificationConfig = $notificationConfig;
}
/**
* @return NotificationConfig
*/
public function getNotificationConfig()
{
return $this->notificationConfig;
}
/**
* The ID of the Google Cloud project that owns the job.
*
* @param string $projectId
*/
public function setProjectId($projectId)
{
$this->projectId = $projectId;
}
/**
* @return string
*/
public function getProjectId()
{
return $this->projectId;
}
/**
* Replication specification.
*
* @param ReplicationSpec $replicationSpec
*/
public function setReplicationSpec(ReplicationSpec $replicationSpec)
{
$this->replicationSpec = $replicationSpec;
}
/**
* @return ReplicationSpec
*/
public function getReplicationSpec()
{
return $this->replicationSpec;
}
/**
* Specifies schedule for the transfer job. This is an optional field. When
* the field is not set, the job never executes a transfer, unless you invoke
* RunTransferJob or update the job to have a non-empty schedule.
*
* @param Schedule $schedule
*/
public function setSchedule(Schedule $schedule)
{
$this->schedule = $schedule;
}
/**
* @return Schedule
*/
public function getSchedule()
{
return $this->schedule;
}
/**
* Optional. The user-managed service account to which to delegate service
* agent permissions. You can grant Cloud Storage bucket permissions to this
* service account instead of to the Transfer Service service agent. Either
* the service account email
* (`SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com`) or the unique
* ID (`123456789012345678901`) are accepted. See
* https://docs.cloud.google.com/storage-transfer/docs/delegate-service-agent-
* permissions for required permissions.
*
* @param string $serviceAccount
*/
public function setServiceAccount($serviceAccount)
{
$this->serviceAccount = $serviceAccount;
}
/**
* @return string
*/
public function getServiceAccount()
{
return $this->serviceAccount;
}
/**
* Status of the job. This value MUST be specified for
* `CreateTransferJobRequests`. **Note:** The effect of the new job status
* takes place during a subsequent job run. For example, if you change the job
* status from ENABLED to DISABLED, and an operation spawned by the transfer
* is running, the status change would not affect the current operation.
*
* Accepted values: STATUS_UNSPECIFIED, ENABLED, DISABLED, DELETED
*
* @param self::STATUS_* $status
*/
public function setStatus($status)
{
$this->status = $status;
}
/**
* @return self::STATUS_*
*/
public function getStatus()
{
return $this->status;
}
/**
* Transfer specification.
*
* @param TransferSpec $transferSpec
*/
public function setTransferSpec(TransferSpec $transferSpec)
{
$this->transferSpec = $transferSpec;
}
/**
* @return TransferSpec
*/
public function getTransferSpec()
{
return $this->transferSpec;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TransferJob::class, 'Google_Service_Storagetransfer_TransferJob');
@@ -0,0 +1,52 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class TransferManifest extends \Google\Model
{
/**
* Specifies the path to the manifest in Cloud Storage. The Google-managed
* service account for the transfer must have `storage.objects.get` permission
* for this object. An example path is `gs://bucket_name/path/manifest.csv`.
*
* @var string
*/
public $location;
/**
* Specifies the path to the manifest in Cloud Storage. The Google-managed
* service account for the transfer must have `storage.objects.get` permission
* for this object. An example path is `gs://bucket_name/path/manifest.csv`.
*
* @param string $location
*/
public function setLocation($location)
{
$this->location = $location;
}
/**
* @return string
*/
public function getLocation()
{
return $this->location;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TransferManifest::class, 'Google_Service_Storagetransfer_TransferManifest');
@@ -0,0 +1,284 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class TransferOperation extends \Google\Collection
{
/**
* Zero is an illegal value.
*/
public const STATUS_STATUS_UNSPECIFIED = 'STATUS_UNSPECIFIED';
/**
* In progress.
*/
public const STATUS_IN_PROGRESS = 'IN_PROGRESS';
/**
* Paused.
*/
public const STATUS_PAUSED = 'PAUSED';
/**
* Completed successfully.
*/
public const STATUS_SUCCESS = 'SUCCESS';
/**
* Terminated due to an unrecoverable failure.
*/
public const STATUS_FAILED = 'FAILED';
/**
* Aborted by the user.
*/
public const STATUS_ABORTED = 'ABORTED';
/**
* Temporarily delayed by the system. No user action is required.
*/
public const STATUS_QUEUED = 'QUEUED';
/**
* The operation is suspending and draining the ongoing work to completion.
*/
public const STATUS_SUSPENDING = 'SUSPENDING';
protected $collection_key = 'errorBreakdowns';
protected $countersType = TransferCounters::class;
protected $countersDataType = '';
/**
* End time of this transfer execution.
*
* @var string
*/
public $endTime;
protected $errorBreakdownsType = ErrorSummary::class;
protected $errorBreakdownsDataType = 'array';
protected $loggingConfigType = LoggingConfig::class;
protected $loggingConfigDataType = '';
/**
* A globally unique ID assigned by the system.
*
* @var string
*/
public $name;
protected $notificationConfigType = NotificationConfig::class;
protected $notificationConfigDataType = '';
/**
* The ID of the Google Cloud project that owns the operation.
*
* @var string
*/
public $projectId;
/**
* Start time of this transfer execution.
*
* @var string
*/
public $startTime;
/**
* Status of the transfer operation.
*
* @var string
*/
public $status;
/**
* The name of the transfer job that triggers this transfer operation.
*
* @var string
*/
public $transferJobName;
protected $transferSpecType = TransferSpec::class;
protected $transferSpecDataType = '';
/**
* Information about the progress of the transfer operation.
*
* @param TransferCounters $counters
*/
public function setCounters(TransferCounters $counters)
{
$this->counters = $counters;
}
/**
* @return TransferCounters
*/
public function getCounters()
{
return $this->counters;
}
/**
* End time of this transfer execution.
*
* @param string $endTime
*/
public function setEndTime($endTime)
{
$this->endTime = $endTime;
}
/**
* @return string
*/
public function getEndTime()
{
return $this->endTime;
}
/**
* Summarizes errors encountered with sample error log entries.
*
* @param ErrorSummary[] $errorBreakdowns
*/
public function setErrorBreakdowns($errorBreakdowns)
{
$this->errorBreakdowns = $errorBreakdowns;
}
/**
* @return ErrorSummary[]
*/
public function getErrorBreakdowns()
{
return $this->errorBreakdowns;
}
/**
* Cloud Logging configuration.
*
* @param LoggingConfig $loggingConfig
*/
public function setLoggingConfig(LoggingConfig $loggingConfig)
{
$this->loggingConfig = $loggingConfig;
}
/**
* @return LoggingConfig
*/
public function getLoggingConfig()
{
return $this->loggingConfig;
}
/**
* A globally unique ID assigned by the system.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Notification configuration.
*
* @param NotificationConfig $notificationConfig
*/
public function setNotificationConfig(NotificationConfig $notificationConfig)
{
$this->notificationConfig = $notificationConfig;
}
/**
* @return NotificationConfig
*/
public function getNotificationConfig()
{
return $this->notificationConfig;
}
/**
* The ID of the Google Cloud project that owns the operation.
*
* @param string $projectId
*/
public function setProjectId($projectId)
{
$this->projectId = $projectId;
}
/**
* @return string
*/
public function getProjectId()
{
return $this->projectId;
}
/**
* Start time of this transfer execution.
*
* @param string $startTime
*/
public function setStartTime($startTime)
{
$this->startTime = $startTime;
}
/**
* @return string
*/
public function getStartTime()
{
return $this->startTime;
}
/**
* Status of the transfer operation.
*
* Accepted values: STATUS_UNSPECIFIED, IN_PROGRESS, PAUSED, SUCCESS, FAILED,
* ABORTED, QUEUED, SUSPENDING
*
* @param self::STATUS_* $status
*/
public function setStatus($status)
{
$this->status = $status;
}
/**
* @return self::STATUS_*
*/
public function getStatus()
{
return $this->status;
}
/**
* The name of the transfer job that triggers this transfer operation.
*
* @param string $transferJobName
*/
public function setTransferJobName($transferJobName)
{
$this->transferJobName = $transferJobName;
}
/**
* @return string
*/
public function getTransferJobName()
{
return $this->transferJobName;
}
/**
* Transfer specification.
*
* @param TransferSpec $transferSpec
*/
public function setTransferSpec(TransferSpec $transferSpec)
{
$this->transferSpec = $transferSpec;
}
/**
* @return TransferSpec
*/
public function getTransferSpec()
{
return $this->transferSpec;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TransferOperation::class, 'Google_Service_Storagetransfer_TransferOperation');
@@ -0,0 +1,171 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class TransferOptions extends \Google\Model
{
/**
* Overwrite behavior is unspecified.
*/
public const OVERWRITE_WHEN_OVERWRITE_WHEN_UNSPECIFIED = 'OVERWRITE_WHEN_UNSPECIFIED';
/**
* Overwrites destination objects with the source objects, only if the objects
* have the same name but different HTTP ETags or checksum values.
*/
public const OVERWRITE_WHEN_DIFFERENT = 'DIFFERENT';
/**
* Never overwrites a destination object if a source object has the same name.
* In this case, the source object is not transferred.
*/
public const OVERWRITE_WHEN_NEVER = 'NEVER';
/**
* Always overwrite the destination object with the source object, even if the
* HTTP Etags or checksum values are the same.
*/
public const OVERWRITE_WHEN_ALWAYS = 'ALWAYS';
/**
* Whether objects should be deleted from the source after they are
* transferred to the sink. **Note:** This option and
* delete_objects_unique_in_sink are mutually exclusive.
*
* @var bool
*/
public $deleteObjectsFromSourceAfterTransfer;
/**
* Whether objects that exist only in the sink should be deleted. **Note:**
* This option and delete_objects_from_source_after_transfer are mutually
* exclusive.
*
* @var bool
*/
public $deleteObjectsUniqueInSink;
protected $metadataOptionsType = MetadataOptions::class;
protected $metadataOptionsDataType = '';
/**
* When to overwrite objects that already exist in the sink. The default is
* that only objects that are different from the source are overwritten. If
* true, all objects in the sink whose name matches an object in the source
* are overwritten with the source object.
*
* @var bool
*/
public $overwriteObjectsAlreadyExistingInSink;
/**
* When to overwrite objects that already exist in the sink. If not set,
* overwrite behavior is determined by
* overwrite_objects_already_existing_in_sink.
*
* @var string
*/
public $overwriteWhen;
/**
* Whether objects should be deleted from the source after they are
* transferred to the sink. **Note:** This option and
* delete_objects_unique_in_sink are mutually exclusive.
*
* @param bool $deleteObjectsFromSourceAfterTransfer
*/
public function setDeleteObjectsFromSourceAfterTransfer($deleteObjectsFromSourceAfterTransfer)
{
$this->deleteObjectsFromSourceAfterTransfer = $deleteObjectsFromSourceAfterTransfer;
}
/**
* @return bool
*/
public function getDeleteObjectsFromSourceAfterTransfer()
{
return $this->deleteObjectsFromSourceAfterTransfer;
}
/**
* Whether objects that exist only in the sink should be deleted. **Note:**
* This option and delete_objects_from_source_after_transfer are mutually
* exclusive.
*
* @param bool $deleteObjectsUniqueInSink
*/
public function setDeleteObjectsUniqueInSink($deleteObjectsUniqueInSink)
{
$this->deleteObjectsUniqueInSink = $deleteObjectsUniqueInSink;
}
/**
* @return bool
*/
public function getDeleteObjectsUniqueInSink()
{
return $this->deleteObjectsUniqueInSink;
}
/**
* Represents the selected metadata options for a transfer job.
*
* @param MetadataOptions $metadataOptions
*/
public function setMetadataOptions(MetadataOptions $metadataOptions)
{
$this->metadataOptions = $metadataOptions;
}
/**
* @return MetadataOptions
*/
public function getMetadataOptions()
{
return $this->metadataOptions;
}
/**
* When to overwrite objects that already exist in the sink. The default is
* that only objects that are different from the source are overwritten. If
* true, all objects in the sink whose name matches an object in the source
* are overwritten with the source object.
*
* @param bool $overwriteObjectsAlreadyExistingInSink
*/
public function setOverwriteObjectsAlreadyExistingInSink($overwriteObjectsAlreadyExistingInSink)
{
$this->overwriteObjectsAlreadyExistingInSink = $overwriteObjectsAlreadyExistingInSink;
}
/**
* @return bool
*/
public function getOverwriteObjectsAlreadyExistingInSink()
{
return $this->overwriteObjectsAlreadyExistingInSink;
}
/**
* When to overwrite objects that already exist in the sink. If not set,
* overwrite behavior is determined by
* overwrite_objects_already_existing_in_sink.
*
* Accepted values: OVERWRITE_WHEN_UNSPECIFIED, DIFFERENT, NEVER, ALWAYS
*
* @param self::OVERWRITE_WHEN_* $overwriteWhen
*/
public function setOverwriteWhen($overwriteWhen)
{
$this->overwriteWhen = $overwriteWhen;
}
/**
* @return self::OVERWRITE_WHEN_*
*/
public function getOverwriteWhen()
{
return $this->overwriteWhen;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TransferOptions::class, 'Google_Service_Storagetransfer_TransferOptions');
@@ -0,0 +1,317 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class TransferSpec extends \Google\Model
{
protected $awsS3CompatibleDataSourceType = AwsS3CompatibleData::class;
protected $awsS3CompatibleDataSourceDataType = '';
protected $awsS3DataSourceType = AwsS3Data::class;
protected $awsS3DataSourceDataType = '';
protected $azureBlobStorageDataSourceType = AzureBlobStorageData::class;
protected $azureBlobStorageDataSourceDataType = '';
protected $gcsDataSinkType = GcsData::class;
protected $gcsDataSinkDataType = '';
protected $gcsDataSourceType = GcsData::class;
protected $gcsDataSourceDataType = '';
protected $gcsIntermediateDataLocationType = GcsData::class;
protected $gcsIntermediateDataLocationDataType = '';
protected $hdfsDataSourceType = HdfsData::class;
protected $hdfsDataSourceDataType = '';
protected $httpDataSourceType = HttpData::class;
protected $httpDataSourceDataType = '';
protected $objectConditionsType = ObjectConditions::class;
protected $objectConditionsDataType = '';
protected $posixDataSinkType = PosixFilesystem::class;
protected $posixDataSinkDataType = '';
protected $posixDataSourceType = PosixFilesystem::class;
protected $posixDataSourceDataType = '';
/**
* Specifies the agent pool name associated with the posix data sink. When
* unspecified, the default name is used.
*
* @var string
*/
public $sinkAgentPoolName;
/**
* Specifies the agent pool name associated with the posix data source. When
* unspecified, the default name is used.
*
* @var string
*/
public $sourceAgentPoolName;
protected $transferManifestType = TransferManifest::class;
protected $transferManifestDataType = '';
protected $transferOptionsType = TransferOptions::class;
protected $transferOptionsDataType = '';
/**
* Optional. An AWS S3 compatible data source.
*
* @param AwsS3CompatibleData $awsS3CompatibleDataSource
*/
public function setAwsS3CompatibleDataSource(AwsS3CompatibleData $awsS3CompatibleDataSource)
{
$this->awsS3CompatibleDataSource = $awsS3CompatibleDataSource;
}
/**
* @return AwsS3CompatibleData
*/
public function getAwsS3CompatibleDataSource()
{
return $this->awsS3CompatibleDataSource;
}
/**
* Optional. An AWS S3 data source.
*
* @param AwsS3Data $awsS3DataSource
*/
public function setAwsS3DataSource(AwsS3Data $awsS3DataSource)
{
$this->awsS3DataSource = $awsS3DataSource;
}
/**
* @return AwsS3Data
*/
public function getAwsS3DataSource()
{
return $this->awsS3DataSource;
}
/**
* Optional. An Azure Blob Storage data source.
*
* @param AzureBlobStorageData $azureBlobStorageDataSource
*/
public function setAzureBlobStorageDataSource(AzureBlobStorageData $azureBlobStorageDataSource)
{
$this->azureBlobStorageDataSource = $azureBlobStorageDataSource;
}
/**
* @return AzureBlobStorageData
*/
public function getAzureBlobStorageDataSource()
{
return $this->azureBlobStorageDataSource;
}
/**
* Optional. A Cloud Storage data sink.
*
* @param GcsData $gcsDataSink
*/
public function setGcsDataSink(GcsData $gcsDataSink)
{
$this->gcsDataSink = $gcsDataSink;
}
/**
* @return GcsData
*/
public function getGcsDataSink()
{
return $this->gcsDataSink;
}
/**
* Optional. A Cloud Storage data source.
*
* @param GcsData $gcsDataSource
*/
public function setGcsDataSource(GcsData $gcsDataSource)
{
$this->gcsDataSource = $gcsDataSource;
}
/**
* @return GcsData
*/
public function getGcsDataSource()
{
return $this->gcsDataSource;
}
/**
* For transfers between file systems, specifies a Cloud Storage bucket to be
* used as an intermediate location through which to transfer data. See
* [Transfer data between file systems](https://cloud.google.com/storage-
* transfer/docs/file-to-file) for more information.
*
* @param GcsData $gcsIntermediateDataLocation
*/
public function setGcsIntermediateDataLocation(GcsData $gcsIntermediateDataLocation)
{
$this->gcsIntermediateDataLocation = $gcsIntermediateDataLocation;
}
/**
* @return GcsData
*/
public function getGcsIntermediateDataLocation()
{
return $this->gcsIntermediateDataLocation;
}
/**
* Optional. An HDFS cluster data source.
*
* @param HdfsData $hdfsDataSource
*/
public function setHdfsDataSource(HdfsData $hdfsDataSource)
{
$this->hdfsDataSource = $hdfsDataSource;
}
/**
* @return HdfsData
*/
public function getHdfsDataSource()
{
return $this->hdfsDataSource;
}
/**
* Optional. An HTTP URL data source.
*
* @param HttpData $httpDataSource
*/
public function setHttpDataSource(HttpData $httpDataSource)
{
$this->httpDataSource = $httpDataSource;
}
/**
* @return HttpData
*/
public function getHttpDataSource()
{
return $this->httpDataSource;
}
/**
* Only objects that satisfy these object conditions are included in the set
* of data source and data sink objects. Object conditions based on objects'
* "last modification time" do not exclude objects in a data sink.
*
* @param ObjectConditions $objectConditions
*/
public function setObjectConditions(ObjectConditions $objectConditions)
{
$this->objectConditions = $objectConditions;
}
/**
* @return ObjectConditions
*/
public function getObjectConditions()
{
return $this->objectConditions;
}
/**
* Optional. A POSIX Filesystem data sink.
*
* @param PosixFilesystem $posixDataSink
*/
public function setPosixDataSink(PosixFilesystem $posixDataSink)
{
$this->posixDataSink = $posixDataSink;
}
/**
* @return PosixFilesystem
*/
public function getPosixDataSink()
{
return $this->posixDataSink;
}
/**
* Optional. A POSIX Filesystem data source.
*
* @param PosixFilesystem $posixDataSource
*/
public function setPosixDataSource(PosixFilesystem $posixDataSource)
{
$this->posixDataSource = $posixDataSource;
}
/**
* @return PosixFilesystem
*/
public function getPosixDataSource()
{
return $this->posixDataSource;
}
/**
* Specifies the agent pool name associated with the posix data sink. When
* unspecified, the default name is used.
*
* @param string $sinkAgentPoolName
*/
public function setSinkAgentPoolName($sinkAgentPoolName)
{
$this->sinkAgentPoolName = $sinkAgentPoolName;
}
/**
* @return string
*/
public function getSinkAgentPoolName()
{
return $this->sinkAgentPoolName;
}
/**
* Specifies the agent pool name associated with the posix data source. When
* unspecified, the default name is used.
*
* @param string $sourceAgentPoolName
*/
public function setSourceAgentPoolName($sourceAgentPoolName)
{
$this->sourceAgentPoolName = $sourceAgentPoolName;
}
/**
* @return string
*/
public function getSourceAgentPoolName()
{
return $this->sourceAgentPoolName;
}
/**
* A manifest file provides a list of objects to be transferred from the data
* source. This field points to the location of the manifest file. Otherwise,
* the entire source bucket is used. ObjectConditions still apply.
*
* @param TransferManifest $transferManifest
*/
public function setTransferManifest(TransferManifest $transferManifest)
{
$this->transferManifest = $transferManifest;
}
/**
* @return TransferManifest
*/
public function getTransferManifest()
{
return $this->transferManifest;
}
/**
* If the option delete_objects_unique_in_sink is `true` and time-based object
* conditions such as 'last modification time' are specified, the request
* fails with an INVALID_ARGUMENT error.
*
* @param TransferOptions $transferOptions
*/
public function setTransferOptions(TransferOptions $transferOptions)
{
$this->transferOptions = $transferOptions;
}
/**
* @return TransferOptions
*/
public function getTransferOptions()
{
return $this->transferOptions;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TransferSpec::class, 'Google_Service_Storagetransfer_TransferSpec');
@@ -0,0 +1,102 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Storagetransfer;
class UpdateTransferJobRequest extends \Google\Model
{
/**
* Required. The ID of the Google Cloud project that owns the job.
*
* @var string
*/
public $projectId;
protected $transferJobType = TransferJob::class;
protected $transferJobDataType = '';
/**
* The field mask of the fields in `transferJob` that are to be updated in
* this request. Fields in `transferJob` that can be updated are: description,
* transfer_spec, notification_config, logging_config, and status. To update
* the `transfer_spec` of the job, a complete transfer specification must be
* provided. An incomplete specification missing any required fields is
* rejected with the error INVALID_ARGUMENT.
*
* @var string
*/
public $updateTransferJobFieldMask;
/**
* Required. The ID of the Google Cloud project that owns the job.
*
* @param string $projectId
*/
public function setProjectId($projectId)
{
$this->projectId = $projectId;
}
/**
* @return string
*/
public function getProjectId()
{
return $this->projectId;
}
/**
* Required. The job to update. `transferJob` is expected to specify one or
* more of five fields: description, transfer_spec, notification_config,
* logging_config, and status. An `UpdateTransferJobRequest` that specifies
* other fields are rejected with the error INVALID_ARGUMENT. Updating a job
* status to DELETED requires `storagetransfer.jobs.delete` permission.
*
* @param TransferJob $transferJob
*/
public function setTransferJob(TransferJob $transferJob)
{
$this->transferJob = $transferJob;
}
/**
* @return TransferJob
*/
public function getTransferJob()
{
return $this->transferJob;
}
/**
* The field mask of the fields in `transferJob` that are to be updated in
* this request. Fields in `transferJob` that can be updated are: description,
* transfer_spec, notification_config, logging_config, and status. To update
* the `transfer_spec` of the job, a complete transfer specification must be
* provided. An incomplete specification missing any required fields is
* rejected with the error INVALID_ARGUMENT.
*
* @param string $updateTransferJobFieldMask
*/
public function setUpdateTransferJobFieldMask($updateTransferJobFieldMask)
{
$this->updateTransferJobFieldMask = $updateTransferJobFieldMask;
}
/**
* @return string
*/
public function getUpdateTransferJobFieldMask()
{
return $this->updateTransferJobFieldMask;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UpdateTransferJobRequest::class, 'Google_Service_Storagetransfer_UpdateTransferJobRequest');