# Google Cloud Storage Transfer V1 Client - Class S3CompatibleMetadata (2.4.0)

2.4.0 (latest) 2.3.2 2.2.1 2.1.1 2.0.2 1.5.0 1.4.5 1.3.1 1.2.0 1.1.1 1.0.6 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 message `google.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` | Enum of type [AuthMethod](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.S3CompatibleMetadata.AuthMethod). |

### 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` Enum of type [AuthMethod](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.S3CompatibleMetadata.AuthMethod). |

| **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` | Enum of type [RequestModel](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.S3CompatibleMetadata.RequestModel). |

### 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` Enum of type [RequestModel](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.S3CompatibleMetadata.RequestModel). |

| **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` | Enum of type [NetworkProtocol](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.S3CompatibleMetadata.NetworkProtocol). |

### 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` Enum of type [NetworkProtocol](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.S3CompatibleMetadata.NetworkProtocol). |

| **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` | Enum of type [ListApi](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.S3CompatibleMetadata.ListApi). |

### setListApi

The Listing API to use for discovering objects. When not specified,
Transfer Service will attempt to determine the right API to use.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [ListApi](https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.S3CompatibleMetadata.ListApi). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |