Class TransferTypes.LoggingConfig.Builder (1.21.0)

public static final class TransferTypes.LoggingConfig.Builder extends GeneratedMessageV3.Builder<TransferTypes.LoggingConfig.Builder> 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 Methods

getDescriptor()

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

Methods

addAllLogActionStates(Iterable<? extends TransferTypes.LoggingConfig.LoggableActionState> values)

public TransferTypes.LoggingConfig.Builder addAllLogActionStates(Iterable<? extends TransferTypes.LoggingConfig.LoggableActionState> values)

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
values Iterable<? extends com.google.storagetransfer.v1.proto.TransferTypes.LoggingConfig.LoggableActionState>

The logActionStates to add.

Returns
Type Description
TransferTypes.LoggingConfig.Builder

This builder for chaining.

addAllLogActionStatesValue(Iterable<Integer> values)

public TransferTypes.LoggingConfig.Builder addAllLogActionStatesValue(Iterable<Integer> values)

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
values Iterable<Integer>

The enum numeric values on the wire for logActionStates to add.

Returns
Type Description
TransferTypes.LoggingConfig.Builder

This builder for chaining.

addAllLogActions(Iterable<? extends TransferTypes.LoggingConfig.LoggableAction> values)

public TransferTypes.LoggingConfig.Builder addAllLogActions(Iterable<? extends TransferTypes.LoggingConfig.LoggableAction> values)

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
values Iterable<? extends com.google.storagetransfer.v1.proto.TransferTypes.LoggingConfig.LoggableAction>

The logActions to add.

Returns
Type Description
TransferTypes.LoggingConfig.Builder

This builder for chaining.

addAllLogActionsValue(Iterable<Integer> values)

public TransferTypes.LoggingConfig.Builder addAllLogActionsValue(Iterable<Integer> values)

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
values Iterable<Integer>

The enum numeric values on the wire for logActions to add.

Returns
Type Description
TransferTypes.LoggingConfig.Builder

This builder for chaining.

addLogActionStates(TransferTypes.LoggingConfig.LoggableActionState value)

public TransferTypes.LoggingConfig.Builder addLogActionStates(TransferTypes.LoggingConfig.LoggableActionState value)

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
value TransferTypes.LoggingConfig.LoggableActionState

The logActionStates to add.

Returns
Type Description
TransferTypes.LoggingConfig.Builder

This builder for chaining.

addLogActionStatesValue(int value)

public TransferTypes.LoggingConfig.Builder addLogActionStatesValue(int value)

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
value int

The enum numeric value on the wire for logActionStates to add.

Returns
Type Description
TransferTypes.LoggingConfig.Builder

This builder for chaining.

addLogActions(TransferTypes.LoggingConfig.LoggableAction value)

public TransferTypes.LoggingConfig.Builder addLogActions(TransferTypes.LoggingConfig.LoggableAction value)

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
value TransferTypes.LoggingConfig.LoggableAction

The logActions to add.

Returns
Type Description
TransferTypes.LoggingConfig.Builder

This builder for chaining.

addLogActionsValue(int value)

public TransferTypes.LoggingConfig.Builder addLogActionsValue(int value)

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
value int

The enum numeric value on the wire for logActions to add.

Returns
Type Description
TransferTypes.LoggingConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.LoggingConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransferTypes.LoggingConfig.Builder
Overrides

build()

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

buildPartial()

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

clear()

public TransferTypes.LoggingConfig.Builder clear()
Returns
Type Description
TransferTypes.LoggingConfig.Builder
Overrides

clearEnableOnpremGcsTransferLogs()

public TransferTypes.LoggingConfig.Builder clearEnableOnpremGcsTransferLogs()

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
TransferTypes.LoggingConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TransferTypes.LoggingConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TransferTypes.LoggingConfig.Builder
Overrides

clearLogActionStates()

public TransferTypes.LoggingConfig.Builder clearLogActionStates()

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
TransferTypes.LoggingConfig.Builder

This builder for chaining.

clearLogActions()

public TransferTypes.LoggingConfig.Builder clearLogActions()

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
TransferTypes.LoggingConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TransferTypes.LoggingConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TransferTypes.LoggingConfig.Builder
Overrides

clone()

public TransferTypes.LoggingConfig.Builder clone()
Returns
Type Description
TransferTypes.LoggingConfig.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TransferTypes.LoggingConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferTypes.LoggingConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TransferTypes.LoggingConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TransferTypes.LoggingConfig.Builder
Overrides

mergeFrom(TransferTypes.LoggingConfig other)

public TransferTypes.LoggingConfig.Builder mergeFrom(TransferTypes.LoggingConfig other)
Parameter
Name Description
other TransferTypes.LoggingConfig
Returns
Type Description
TransferTypes.LoggingConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.LoggingConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransferTypes.LoggingConfig.Builder
Overrides

setEnableOnpremGcsTransferLogs(boolean value)

public TransferTypes.LoggingConfig.Builder setEnableOnpremGcsTransferLogs(boolean value)

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

bool enable_onprem_gcs_transfer_logs = 3;

Parameter
Name Description
value boolean

The enableOnpremGcsTransferLogs to set.

Returns
Type Description
TransferTypes.LoggingConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TransferTypes.LoggingConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransferTypes.LoggingConfig.Builder
Overrides

setLogActionStates(int index, TransferTypes.LoggingConfig.LoggableActionState value)

public TransferTypes.LoggingConfig.Builder setLogActionStates(int index, TransferTypes.LoggingConfig.LoggableActionState value)

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;

Parameters
Name Description
index int

The index to set the value at.

value TransferTypes.LoggingConfig.LoggableActionState

The logActionStates to set.

Returns
Type Description
TransferTypes.LoggingConfig.Builder

This builder for chaining.

setLogActionStatesValue(int index, int value)

public TransferTypes.LoggingConfig.Builder setLogActionStatesValue(int index, int value)

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;

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for logActionStates to set.

Returns
Type Description
TransferTypes.LoggingConfig.Builder

This builder for chaining.

setLogActions(int index, TransferTypes.LoggingConfig.LoggableAction value)

public TransferTypes.LoggingConfig.Builder setLogActions(int index, TransferTypes.LoggingConfig.LoggableAction value)

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;

Parameters
Name Description
index int

The index to set the value at.

value TransferTypes.LoggingConfig.LoggableAction

The logActions to set.

Returns
Type Description
TransferTypes.LoggingConfig.Builder

This builder for chaining.

setLogActionsValue(int index, int value)

public TransferTypes.LoggingConfig.Builder setLogActionsValue(int index, int value)

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;

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for logActions to set.

Returns
Type Description
TransferTypes.LoggingConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TransferTypes.LoggingConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TransferTypes.LoggingConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final TransferTypes.LoggingConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransferTypes.LoggingConfig.Builder
Overrides