# Google Cloud Storage Transfer V1 Client - Class AwsS3CompatibleData (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 AwsS3CompatibleData.

An AwsS3CompatibleData resource.

Generated from protobuf message `google.storagetransfer.v1.AwsS3CompatibleData`

## Namespace

Google \\ Cloud \\ StorageTransfer \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ bucket_name` | `string` Required. Specifies the name of the bucket. |
| `↳ path` | `string` 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 '/'. |
| `↳ endpoint` | `string` Required. Specifies the endpoint of the storage service. |
| `↳ region` | `string` Specifies the region to sign requests with. This can be left blank if requests should be signed with an empty region. |
| `↳ s3_metadata` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.S3CompatibleMetadata` A S3 compatible metadata. |

### getBucketName

Required. Specifies the name of the bucket.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setBucketName

Required. Specifies the name of the bucket.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getPath

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 '/'.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setPath

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 '/'.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getEndpoint

Required. Specifies the endpoint of the storage service.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setEndpoint

Required. Specifies the endpoint of the storage service.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getRegion

Specifies the region to sign requests with. This can be left blank if
requests should be signed with an empty region.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setRegion

Specifies the region to sign requests with. This can be left blank if
requests should be signed with an empty region.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

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

### getS3Metadata

A S3 compatible metadata.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.S3CompatibleMetadata|null` |   |

### hasS3Metadata

### setS3Metadata

A S3 compatible metadata.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-storage-transfer/latest/V1.S3CompatibleMetadata` |

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

### getDataProvider

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |