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

Specifies the Event-driven transfer options. Event-driven transfers listen to
an event stream to transfer updated files.

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

## Namespace

Google \\ Cloud \\ StorageTransfer \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ name` | `string` 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}'. |
| `↳ event_stream_start_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` 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. |
| `↳ event_stream_expiration_time` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` 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. |

### getName

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

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

### setName

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

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

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

### getEventStreamStartTime

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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasEventStreamStartTime

### clearEventStreamStartTime

### setEventStreamStartTime

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

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

### getEventStreamExpirationTime

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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp|null` |   |

### hasEventStreamExpirationTime

### clearEventStreamExpirationTime

### setEventStreamExpirationTime

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

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