Class TransferTypes.TransferOperation (1.46.0)

public static final class TransferTypes.TransferOperation extends GeneratedMessageV3 implements TransferTypes.TransferOperationOrBuilder

A description of the execution of a transfer.

Protobuf type google.storagetransfer.v1.TransferOperation

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransferTypes.TransferOperation

Static Fields

COUNTERS_FIELD_NUMBER

public static final int COUNTERS_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

ERROR_BREAKDOWNS_FIELD_NUMBER

public static final int ERROR_BREAKDOWNS_FIELD_NUMBER
Field Value
Type Description
int

LOGGING_CONFIG_FIELD_NUMBER

public static final int LOGGING_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NOTIFICATION_CONFIG_FIELD_NUMBER

public static final int NOTIFICATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PROJECT_ID_FIELD_NUMBER

public static final int PROJECT_ID_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

TRANSFER_JOB_NAME_FIELD_NUMBER

public static final int TRANSFER_JOB_NAME_FIELD_NUMBER
Field Value
Type Description
int

TRANSFER_SPEC_FIELD_NUMBER

public static final int TRANSFER_SPEC_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(TransferTypes.TransferOperation prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCounters()

public TransferTypes.TransferCounters getCounters()

Information about the progress of the transfer operation.

.google.storagetransfer.v1.TransferCounters counters = 7;

Returns
Type Description
TransferTypes.TransferCounters

The counters.

getCountersOrBuilder()

public TransferTypes.TransferCountersOrBuilder getCountersOrBuilder()

Information about the progress of the transfer operation.

.google.storagetransfer.v1.TransferCounters counters = 7;

Returns
Type Description
TransferTypes.TransferCountersOrBuilder

getDefaultInstanceForType()

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

getEndTime()

public Timestamp getEndTime()

End time of this transfer execution.

.google.protobuf.Timestamp end_time = 5;

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

End time of this transfer execution.

.google.protobuf.Timestamp end_time = 5;

Returns
Type Description
TimestampOrBuilder

getErrorBreakdowns(int index)

public TransferTypes.ErrorSummary getErrorBreakdowns(int index)

Summarizes errors encountered with sample error log entries.

repeated .google.storagetransfer.v1.ErrorSummary error_breakdowns = 8;

Parameter
Name Description
index int
Returns
Type Description
TransferTypes.ErrorSummary

getErrorBreakdownsCount()

public int getErrorBreakdownsCount()

Summarizes errors encountered with sample error log entries.

repeated .google.storagetransfer.v1.ErrorSummary error_breakdowns = 8;

Returns
Type Description
int

getErrorBreakdownsList()

public List<TransferTypes.ErrorSummary> getErrorBreakdownsList()

Summarizes errors encountered with sample error log entries.

repeated .google.storagetransfer.v1.ErrorSummary error_breakdowns = 8;

Returns
Type Description
List<ErrorSummary>

getErrorBreakdownsOrBuilder(int index)

public TransferTypes.ErrorSummaryOrBuilder getErrorBreakdownsOrBuilder(int index)

Summarizes errors encountered with sample error log entries.

repeated .google.storagetransfer.v1.ErrorSummary error_breakdowns = 8;

Parameter
Name Description
index int
Returns
Type Description
TransferTypes.ErrorSummaryOrBuilder

getErrorBreakdownsOrBuilderList()

public List<? extends TransferTypes.ErrorSummaryOrBuilder> getErrorBreakdownsOrBuilderList()

Summarizes errors encountered with sample error log entries.

repeated .google.storagetransfer.v1.ErrorSummary error_breakdowns = 8;

Returns
Type Description
List<? extends com.google.storagetransfer.v1.proto.TransferTypes.ErrorSummaryOrBuilder>

getLoggingConfig()

public TransferTypes.LoggingConfig getLoggingConfig()

Cloud Logging configuration.

.google.storagetransfer.v1.LoggingConfig logging_config = 12;

Returns
Type Description
TransferTypes.LoggingConfig

The loggingConfig.

getLoggingConfigOrBuilder()

public TransferTypes.LoggingConfigOrBuilder getLoggingConfigOrBuilder()

Cloud Logging configuration.

.google.storagetransfer.v1.LoggingConfig logging_config = 12;

Returns
Type Description
TransferTypes.LoggingConfigOrBuilder

getName()

public String getName()

A globally unique ID assigned by the system.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

A globally unique ID assigned by the system.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getNotificationConfig()

public TransferTypes.NotificationConfig getNotificationConfig()

Notification configuration.

.google.storagetransfer.v1.NotificationConfig notification_config = 10;

Returns
Type Description
TransferTypes.NotificationConfig

The notificationConfig.

getNotificationConfigOrBuilder()

public TransferTypes.NotificationConfigOrBuilder getNotificationConfigOrBuilder()

Notification configuration.

.google.storagetransfer.v1.NotificationConfig notification_config = 10;

Returns
Type Description
TransferTypes.NotificationConfigOrBuilder

getParserForType()

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

getProjectId()

public String getProjectId()

The ID of the Google Cloud project that owns the operation.

string project_id = 2;

Returns
Type Description
String

The projectId.

getProjectIdBytes()

public ByteString getProjectIdBytes()

The ID of the Google Cloud project that owns the operation.

string project_id = 2;

Returns
Type Description
ByteString

The bytes for projectId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

Start time of this transfer execution.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Start time of this transfer execution.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
TimestampOrBuilder

getStatus()

public TransferTypes.TransferOperation.Status getStatus()

Status of the transfer operation.

.google.storagetransfer.v1.TransferOperation.Status status = 6;

Returns
Type Description
TransferTypes.TransferOperation.Status

The status.

getStatusValue()

public int getStatusValue()

Status of the transfer operation.

.google.storagetransfer.v1.TransferOperation.Status status = 6;

Returns
Type Description
int

The enum numeric value on the wire for status.

getTransferJobName()

public String getTransferJobName()

The name of the transfer job that triggers this transfer operation.

string transfer_job_name = 9;

Returns
Type Description
String

The transferJobName.

getTransferJobNameBytes()

public ByteString getTransferJobNameBytes()

The name of the transfer job that triggers this transfer operation.

string transfer_job_name = 9;

Returns
Type Description
ByteString

The bytes for transferJobName.

getTransferSpec()

public TransferTypes.TransferSpec getTransferSpec()

Transfer specification.

.google.storagetransfer.v1.TransferSpec transfer_spec = 3;

Returns
Type Description
TransferTypes.TransferSpec

The transferSpec.

getTransferSpecOrBuilder()

public TransferTypes.TransferSpecOrBuilder getTransferSpecOrBuilder()

Transfer specification.

.google.storagetransfer.v1.TransferSpec transfer_spec = 3;

Returns
Type Description
TransferTypes.TransferSpecOrBuilder

hasCounters()

public boolean hasCounters()

Information about the progress of the transfer operation.

.google.storagetransfer.v1.TransferCounters counters = 7;

Returns
Type Description
boolean

Whether the counters field is set.

hasEndTime()

public boolean hasEndTime()

End time of this transfer execution.

.google.protobuf.Timestamp end_time = 5;

Returns
Type Description
boolean

Whether the endTime field is set.

hasLoggingConfig()

public boolean hasLoggingConfig()

Cloud Logging configuration.

.google.storagetransfer.v1.LoggingConfig logging_config = 12;

Returns
Type Description
boolean

Whether the loggingConfig field is set.

hasNotificationConfig()

public boolean hasNotificationConfig()

Notification configuration.

.google.storagetransfer.v1.NotificationConfig notification_config = 10;

Returns
Type Description
boolean

Whether the notificationConfig field is set.

hasStartTime()

public boolean hasStartTime()

Start time of this transfer execution.

.google.protobuf.Timestamp start_time = 4;

Returns
Type Description
boolean

Whether the startTime field is set.

hasTransferSpec()

public boolean hasTransferSpec()

Transfer specification.

.google.storagetransfer.v1.TransferSpec transfer_spec = 3;

Returns
Type Description
boolean

Whether the transferSpec 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.TransferOperation.Builder newBuilderForType()
Returns
Type Description
TransferTypes.TransferOperation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferTypes.TransferOperation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TransferTypes.TransferOperation.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.TransferOperation.Builder toBuilder()
Returns
Type Description
TransferTypes.TransferOperation.Builder

writeTo(CodedOutputStream output)

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