Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class S3CompatibleMetadata.
S3CompatibleMetadata contains the metadata fields that apply to the basic
types of S3-compatible data providers.
Generated from protobuf messagegoogle.storagetransfer.v1.S3CompatibleMetadata
Namespace
Google \ Cloud \ StorageTransfer \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ auth_method
int
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.
↳ request_model
int
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.
↳ protocol
int
Specifies the network protocol of the agent. When not specified, the default value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.
↳ list_api
int
The Listing API to use for discovering objects. When not specified, Transfer Service will attempt to determine the right API to use.
getAuthMethod
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.
Returns
Type
Description
int
setAuthMethod
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getRequestModel
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.
Returns
Type
Description
int
setRequestModel
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getProtocol
Specifies the network protocol of the agent. When not specified, the
default value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.
Returns
Type
Description
int
setProtocol
Specifies the network protocol of the agent. When not specified, the
default value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getListApi
The Listing API to use for discovering objects. When not specified,
Transfer Service will attempt to determine the right API to use.
Returns
Type
Description
int
setListApi
The Listing API to use for discovering objects. When not specified,
Transfer Service will attempt to determine the right API to use.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Storage Transfer V1 Client - Class S3CompatibleMetadata (2.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.1 (latest)](/php/docs/reference/cloud-storage-transfer/latest/V1.S3CompatibleMetadata)\n- [2.2.0](/php/docs/reference/cloud-storage-transfer/2.2.0/V1.S3CompatibleMetadata)\n- [2.1.1](/php/docs/reference/cloud-storage-transfer/2.1.1/V1.S3CompatibleMetadata)\n- [2.0.2](/php/docs/reference/cloud-storage-transfer/2.0.2/V1.S3CompatibleMetadata)\n- [1.5.0](/php/docs/reference/cloud-storage-transfer/1.5.0/V1.S3CompatibleMetadata)\n- [1.4.5](/php/docs/reference/cloud-storage-transfer/1.4.5/V1.S3CompatibleMetadata)\n- [1.3.1](/php/docs/reference/cloud-storage-transfer/1.3.1/V1.S3CompatibleMetadata)\n- [1.2.0](/php/docs/reference/cloud-storage-transfer/1.2.0/V1.S3CompatibleMetadata)\n- [1.1.1](/php/docs/reference/cloud-storage-transfer/1.1.1/V1.S3CompatibleMetadata)\n- [1.0.6](/php/docs/reference/cloud-storage-transfer/1.0.6/V1.S3CompatibleMetadata) \nReference documentation and code samples for the Google Cloud Storage Transfer V1 Client class S3CompatibleMetadata.\n\nS3CompatibleMetadata contains the metadata fields that apply to the basic\ntypes of S3-compatible data providers.\n\nGenerated from protobuf message `google.storagetransfer.v1.S3CompatibleMetadata`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ StorageTransfer \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAuthMethod\n\nSpecifies the authentication and authorization method used by the storage\nservice. When not specified, Transfer Service will attempt to determine\nright auth method to use.\n\n### setAuthMethod\n\nSpecifies the authentication and authorization method used by the storage\nservice. When not specified, Transfer Service will attempt to determine\nright auth method to use.\n\n### getRequestModel\n\nSpecifies the API request model used to call the storage service. When not\nspecified, the default value of RequestModel\nREQUEST_MODEL_VIRTUAL_HOSTED_STYLE is used.\n\n### setRequestModel\n\nSpecifies the API request model used to call the storage service. When not\nspecified, the default value of RequestModel\nREQUEST_MODEL_VIRTUAL_HOSTED_STYLE is used.\n\n### getProtocol\n\nSpecifies the network protocol of the agent. When not specified, the\ndefault value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.\n\n### setProtocol\n\nSpecifies the network protocol of the agent. When not specified, the\ndefault value of NetworkProtocol NETWORK_PROTOCOL_HTTPS is used.\n\n### getListApi\n\nThe Listing API to use for discovering objects. When not specified,\nTransfer Service will attempt to determine the right API to use.\n\n### setListApi\n\nThe Listing API to use for discovering objects. When not specified,\nTransfer Service will attempt to determine the right API to use."]]
