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

Implements

TransferTypes.LoggingConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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.