Class TransferTypes.EventStream (1.46.0)

public static final class TransferTypes.EventStream extends GeneratedMessageV3 implements TransferTypes.EventStreamOrBuilder

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

Protobuf type google.storagetransfer.v1.EventStream

Static Fields

EVENT_STREAM_EXPIRATION_TIME_FIELD_NUMBER

public static final int EVENT_STREAM_EXPIRATION_TIME_FIELD_NUMBER
Field Value
Type Description
int

EVENT_STREAM_START_TIME_FIELD_NUMBER

public static final int EVENT_STREAM_START_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TransferTypes.EventStream getDefaultInstance()
Returns
Type Description
TransferTypes.EventStream

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TransferTypes.EventStream.Builder newBuilder()
Returns
Type Description
TransferTypes.EventStream.Builder

newBuilder(TransferTypes.EventStream prototype)

public static TransferTypes.EventStream.Builder newBuilder(TransferTypes.EventStream prototype)
Parameter
Name Description
prototype TransferTypes.EventStream
Returns
Type Description
TransferTypes.EventStream.Builder

parseDelimitedFrom(InputStream input)

public static TransferTypes.EventStream parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferTypes.EventStream
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.EventStream parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.EventStream
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TransferTypes.EventStream parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TransferTypes.EventStream
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.EventStream parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.EventStream
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransferTypes.EventStream parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TransferTypes.EventStream
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.EventStream parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.EventStream
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransferTypes.EventStream parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TransferTypes.EventStream
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.EventStream parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.EventStream
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TransferTypes.EventStream parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferTypes.EventStream
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.EventStream parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.EventStream
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TransferTypes.EventStream parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TransferTypes.EventStream
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.EventStream parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.EventStream
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TransferTypes.EventStream> parser()
Returns
Type Description
Parser<EventStream>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public TransferTypes.EventStream getDefaultInstanceForType()
Returns
Type Description
TransferTypes.EventStream

getEventStreamExpirationTime()

public Timestamp 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.

.google.protobuf.Timestamp event_stream_expiration_time = 3;

Returns
Type Description
Timestamp

The eventStreamExpirationTime.

getEventStreamExpirationTimeOrBuilder()

public TimestampOrBuilder getEventStreamExpirationTimeOrBuilder()

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.

.google.protobuf.Timestamp event_stream_expiration_time = 3;

Returns
Type Description
TimestampOrBuilder

getEventStreamStartTime()

public Timestamp 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.

.google.protobuf.Timestamp event_stream_start_time = 2;

Returns
Type Description
Timestamp

The eventStreamStartTime.

getEventStreamStartTimeOrBuilder()

public TimestampOrBuilder getEventStreamStartTimeOrBuilder()

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.

.google.protobuf.Timestamp event_stream_start_time = 2;

Returns
Type Description
TimestampOrBuilder

getName()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<TransferTypes.EventStream> getParserForType()
Returns
Type Description
Parser<EventStream>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasEventStreamExpirationTime()

public boolean hasEventStreamExpirationTime()

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.

.google.protobuf.Timestamp event_stream_expiration_time = 3;

Returns
Type Description
boolean

Whether the eventStreamExpirationTime field is set.

hasEventStreamStartTime()

public boolean hasEventStreamStartTime()

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.

.google.protobuf.Timestamp event_stream_start_time = 2;

Returns
Type Description
boolean

Whether the eventStreamStartTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TransferTypes.EventStream.Builder newBuilderForType()
Returns
Type Description
TransferTypes.EventStream.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferTypes.EventStream.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TransferTypes.EventStream.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TransferTypes.EventStream.Builder toBuilder()
Returns
Type Description
TransferTypes.EventStream.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException