Class TransferTypes.LoggingConfig (1.22.0) 

public static final class TransferTypes.LoggingConfig extends GeneratedMessageV3 implements TransferTypes.LoggingConfigOrBuilder

Specifies the logging behavior for transfer operations.

For cloud-to-cloud transfers, logs are sent to Cloud Logging. See Read transfer logs for details.

For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See Managing Transfer for on-premises jobs for details.

Protobuf type google.storagetransfer.v1.LoggingConfig

Inheritance

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

Static Fields

ENABLE_ONPREM_GCS_TRANSFER_LOGS_FIELD_NUMBER

public static final int ENABLE_ONPREM_GCS_TRANSFER_LOGS_FIELD_NUMBER
Field Value
Type Description
int

LOG_ACTIONS_FIELD_NUMBER

public static final int LOG_ACTIONS_FIELD_NUMBER
Field Value
Type Description
int

LOG_ACTION_STATES_FIELD_NUMBER

public static final int LOG_ACTION_STATES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(TransferTypes.LoggingConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

getEnableOnpremGcsTransferLogs()

public boolean getEnableOnpremGcsTransferLogs()

For transfers with a PosixFilesystem source, this option enables the Cloud Storage transfer logs for this transfer.

bool enable_onprem_gcs_transfer_logs = 3;

Returns
Type Description
boolean

The enableOnpremGcsTransferLogs.

getLogActionStates(int index)

public TransferTypes.LoggingConfig.LoggableActionState getLogActionStates(int index)

States in which log_actions are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.

repeated .google.storagetransfer.v1.LoggingConfig.LoggableActionState log_action_states = 2;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
TransferTypes.LoggingConfig.LoggableActionState

The logActionStates at the given index.

getLogActionStatesCount()

public int getLogActionStatesCount()

States in which log_actions are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.

repeated .google.storagetransfer.v1.LoggingConfig.LoggableActionState log_action_states = 2;

Returns
Type Description
int

The count of logActionStates.

getLogActionStatesList()

public List<TransferTypes.LoggingConfig.LoggableActionState> getLogActionStatesList()

States in which log_actions are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.

repeated .google.storagetransfer.v1.LoggingConfig.LoggableActionState log_action_states = 2;

Returns
Type Description
List<LoggableActionState>

A list containing the logActionStates.

getLogActionStatesValue(int index)

public int getLogActionStatesValue(int index)

States in which log_actions are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.

repeated .google.storagetransfer.v1.LoggingConfig.LoggableActionState log_action_states = 2;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of logActionStates at the given index.

getLogActionStatesValueList()

public List<Integer> getLogActionStatesValueList()

States in which log_actions are logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.

repeated .google.storagetransfer.v1.LoggingConfig.LoggableActionState log_action_states = 2;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for logActionStates.

getLogActions(int index)

public TransferTypes.LoggingConfig.LoggableAction getLogActions(int index)

Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.

repeated .google.storagetransfer.v1.LoggingConfig.LoggableAction log_actions = 1;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
TransferTypes.LoggingConfig.LoggableAction

The logActions at the given index.

getLogActionsCount()

public int getLogActionsCount()

Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.

repeated .google.storagetransfer.v1.LoggingConfig.LoggableAction log_actions = 1;

Returns
Type Description
int

The count of logActions.

getLogActionsList()

public List<TransferTypes.LoggingConfig.LoggableAction> getLogActionsList()

Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.

repeated .google.storagetransfer.v1.LoggingConfig.LoggableAction log_actions = 1;

Returns
Type Description
List<LoggableAction>

A list containing the logActions.

getLogActionsValue(int index)

public int getLogActionsValue(int index)

Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.

repeated .google.storagetransfer.v1.LoggingConfig.LoggableAction log_actions = 1;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
int

The enum numeric value on the wire of logActions at the given index.

getLogActionsValueList()

public List<Integer> getLogActionsValueList()

Specifies the actions to be logged. If empty, no logs are generated. Not supported for transfers with PosixFilesystem data sources; use enable_onprem_gcs_transfer_logs instead.

repeated .google.storagetransfer.v1.LoggingConfig.LoggableAction log_actions = 1;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for logActions.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.LoggingConfig.Builder newBuilderForType()
Returns
Type Description
TransferTypes.LoggingConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

writeTo(CodedOutputStream output)

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