Class TransferTypes.LoggingConfig (1.18.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

Static Fields

ENABLE_ONPREM_GCS_TRANSFER_LOGS_FIELD_NUMBER

public static final int ENABLE_ONPREM_GCS_TRANSFER_LOGS_FIELD_NUMBER
Field Value
TypeDescription
int

LOG_ACTIONS_FIELD_NUMBER

public static final int LOG_ACTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

LOG_ACTION_STATES_FIELD_NUMBER

public static final int LOG_ACTION_STATES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TransferTypes.LoggingConfig getDefaultInstance()
Returns
TypeDescription
TransferTypes.LoggingConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TransferTypes.LoggingConfig.Builder newBuilder()
Returns
TypeDescription
TransferTypes.LoggingConfig.Builder

newBuilder(TransferTypes.LoggingConfig prototype)

public static TransferTypes.LoggingConfig.Builder newBuilder(TransferTypes.LoggingConfig prototype)
Parameter
NameDescription
prototypeTransferTypes.LoggingConfig
Returns
TypeDescription
TransferTypes.LoggingConfig.Builder

parseDelimitedFrom(InputStream input)

public static TransferTypes.LoggingConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransferTypes.LoggingConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.LoggingConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.LoggingConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TransferTypes.LoggingConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TransferTypes.LoggingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.LoggingConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.LoggingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransferTypes.LoggingConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TransferTypes.LoggingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.LoggingConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.LoggingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransferTypes.LoggingConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TransferTypes.LoggingConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.LoggingConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.LoggingConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TransferTypes.LoggingConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransferTypes.LoggingConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.LoggingConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.LoggingConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TransferTypes.LoggingConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TransferTypes.LoggingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.LoggingConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransferTypes.LoggingConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public TransferTypes.LoggingConfig getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
List<Integer>

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

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TransferTypes.LoggingConfig.Builder newBuilderForType()
Returns
TypeDescription
TransferTypes.LoggingConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferTypes.LoggingConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TransferTypes.LoggingConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TransferTypes.LoggingConfig.Builder toBuilder()
Returns
TypeDescription
TransferTypes.LoggingConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException