FtpMonitorConfiguration¶

class oci.apm_synthetics.models.FtpMonitorConfiguration(**kwargs)¶

Bases: oci.apm_synthetics.models.monitor_configuration.MonitorConfiguration

Request configuration details for the FTP monitor type.

Attributes

`CONFIG_TYPE_BROWSER_CONFIG`	str(object=’’) -> str
`CONFIG_TYPE_DNSSEC_CONFIG`	str(object=’’) -> str
`CONFIG_TYPE_DNS_SERVER_CONFIG`	str(object=’’) -> str
`CONFIG_TYPE_DNS_TRACE_CONFIG`	str(object=’’) -> str
`CONFIG_TYPE_FTP_CONFIG`	str(object=’’) -> str
`CONFIG_TYPE_NETWORK_CONFIG`	str(object=’’) -> str
`CONFIG_TYPE_REST_CONFIG`	str(object=’’) -> str
`CONFIG_TYPE_SCRIPTED_BROWSER_CONFIG`	str(object=’’) -> str
`CONFIG_TYPE_SCRIPTED_REST_CONFIG`	str(object=’’) -> str
`CONFIG_TYPE_SQL_CONFIG`	str(object=’’) -> str
`FTP_PROTOCOL_FTP`	A constant which can be used with the ftp_protocol property of a FtpMonitorConfiguration.
`FTP_PROTOCOL_FTPS`	A constant which can be used with the ftp_protocol property of a FtpMonitorConfiguration.
`FTP_PROTOCOL_SFTP`	A constant which can be used with the ftp_protocol property of a FtpMonitorConfiguration.
`FTP_REQUEST_TYPE_DOWNLOAD`	A constant which can be used with the ftp_request_type property of a FtpMonitorConfiguration.
`FTP_REQUEST_TYPE_LIST`	A constant which can be used with the ftp_request_type property of a FtpMonitorConfiguration.
`FTP_REQUEST_TYPE_UPLOAD`	A constant which can be used with the ftp_request_type property of a FtpMonitorConfiguration.
`config_type`	Gets the config_type of this MonitorConfiguration.
`dns_configuration`	Gets the dns_configuration of this MonitorConfiguration.
`download_size_limit_in_bytes`	Gets the download_size_limit_in_bytes of this FtpMonitorConfiguration.
`ftp_basic_authentication_details`	Gets the ftp_basic_authentication_details of this FtpMonitorConfiguration.
`ftp_protocol`	Gets the ftp_protocol of this FtpMonitorConfiguration.
`ftp_request_type`	Gets the ftp_request_type of this FtpMonitorConfiguration.
`is_active_mode`	Gets the is_active_mode of this FtpMonitorConfiguration.
`is_failure_retried`	Gets the is_failure_retried of this MonitorConfiguration.
`network_configuration`	Gets the network_configuration of this FtpMonitorConfiguration.
`upload_file_size_in_bytes`	Gets the upload_file_size_in_bytes of this FtpMonitorConfiguration.
`verify_response_codes`	Gets the verify_response_codes of this FtpMonitorConfiguration.
`verify_response_content`	Gets the verify_response_content of this FtpMonitorConfiguration.

Methods

`__init__`(**kwargs)	Initializes a new FtpMonitorConfiguration object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

CONFIG_TYPE_BROWSER_CONFIG = 'BROWSER_CONFIG'¶

CONFIG_TYPE_DNSSEC_CONFIG = 'DNSSEC_CONFIG'¶

CONFIG_TYPE_DNS_SERVER_CONFIG = 'DNS_SERVER_CONFIG'¶

CONFIG_TYPE_DNS_TRACE_CONFIG = 'DNS_TRACE_CONFIG'¶

CONFIG_TYPE_FTP_CONFIG = 'FTP_CONFIG'¶

CONFIG_TYPE_NETWORK_CONFIG = 'NETWORK_CONFIG'¶

CONFIG_TYPE_REST_CONFIG = 'REST_CONFIG'¶

CONFIG_TYPE_SCRIPTED_BROWSER_CONFIG = 'SCRIPTED_BROWSER_CONFIG'¶

CONFIG_TYPE_SCRIPTED_REST_CONFIG = 'SCRIPTED_REST_CONFIG'¶

CONFIG_TYPE_SQL_CONFIG = 'SQL_CONFIG'¶

FTP_PROTOCOL_FTP = 'FTP'¶: A constant which can be used with the ftp_protocol property of a FtpMonitorConfiguration. This constant has a value of “FTP”

FTP_PROTOCOL_FTPS = 'FTPS'¶: A constant which can be used with the ftp_protocol property of a FtpMonitorConfiguration. This constant has a value of “FTPS”

FTP_PROTOCOL_SFTP = 'SFTP'¶: A constant which can be used with the ftp_protocol property of a FtpMonitorConfiguration. This constant has a value of “SFTP”

FTP_REQUEST_TYPE_DOWNLOAD = 'DOWNLOAD'¶: A constant which can be used with the ftp_request_type property of a FtpMonitorConfiguration. This constant has a value of “DOWNLOAD”

FTP_REQUEST_TYPE_LIST = 'LIST'¶: A constant which can be used with the ftp_request_type property of a FtpMonitorConfiguration. This constant has a value of “LIST”

FTP_REQUEST_TYPE_UPLOAD = 'UPLOAD'¶: A constant which can be used with the ftp_request_type property of a FtpMonitorConfiguration. This constant has a value of “UPLOAD”

__init__(**kwargs)¶

Initializes a new FtpMonitorConfiguration object with values from keyword arguments. The default value of the config_type attribute of this class is FTP_CONFIG and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

config_type (str) – The value to assign to the config_type property of this FtpMonitorConfiguration. Allowed values for this property are: “BROWSER_CONFIG”, “SCRIPTED_BROWSER_CONFIG”, “REST_CONFIG”, “SCRIPTED_REST_CONFIG”, “NETWORK_CONFIG”, “DNS_SERVER_CONFIG”, “DNS_TRACE_CONFIG”, “DNSSEC_CONFIG”, “FTP_CONFIG”, “SQL_CONFIG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_failure_retried (bool) – The value to assign to the is_failure_retried property of this FtpMonitorConfiguration.
dns_configuration (oci.apm_synthetics.models.DnsConfiguration) – The value to assign to the dns_configuration property of this FtpMonitorConfiguration.
ftp_protocol (str) – The value to assign to the ftp_protocol property of this FtpMonitorConfiguration. Allowed values for this property are: “FTP”, “FTPS”, “SFTP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
ftp_request_type (str) – The value to assign to the ftp_request_type property of this FtpMonitorConfiguration. Allowed values for this property are: “LIST”, “UPLOAD”, “DOWNLOAD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_active_mode (bool) – The value to assign to the is_active_mode property of this FtpMonitorConfiguration.
ftp_basic_authentication_details (oci.apm_synthetics.models.BasicAuthenticationDetails) – The value to assign to the ftp_basic_authentication_details property of this FtpMonitorConfiguration.
download_size_limit_in_bytes (int) – The value to assign to the download_size_limit_in_bytes property of this FtpMonitorConfiguration.
upload_file_size_in_bytes (int) – The value to assign to the upload_file_size_in_bytes property of this FtpMonitorConfiguration.
network_configuration (oci.apm_synthetics.models.NetworkConfiguration) – The value to assign to the network_configuration property of this FtpMonitorConfiguration.
verify_response_codes (list[str]) – The value to assign to the verify_response_codes property of this FtpMonitorConfiguration.
verify_response_content (str) – The value to assign to the verify_response_content property of this FtpMonitorConfiguration.

config_type¶

Gets the config_type of this MonitorConfiguration. Type of configuration.

Allowed values for this property are: “BROWSER_CONFIG”, “SCRIPTED_BROWSER_CONFIG”, “REST_CONFIG”, “SCRIPTED_REST_CONFIG”, “NETWORK_CONFIG”, “DNS_SERVER_CONFIG”, “DNS_TRACE_CONFIG”, “DNSSEC_CONFIG”, “FTP_CONFIG”, “SQL_CONFIG”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The config_type of this MonitorConfiguration.
Return type:	str

dns_configuration¶

Gets the dns_configuration of this MonitorConfiguration.

Returns:	The dns_configuration of this MonitorConfiguration.
Return type:	oci.apm_synthetics.models.DnsConfiguration

download_size_limit_in_bytes¶

Gets the download_size_limit_in_bytes of this FtpMonitorConfiguration. Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.

Returns:	The download_size_limit_in_bytes of this FtpMonitorConfiguration.
Return type:	int

ftp_basic_authentication_details¶

Gets the ftp_basic_authentication_details of this FtpMonitorConfiguration.

Returns:	The ftp_basic_authentication_details of this FtpMonitorConfiguration.
Return type:	oci.apm_synthetics.models.BasicAuthenticationDetails

ftp_protocol¶

Gets the ftp_protocol of this FtpMonitorConfiguration. FTP protocol type.

Allowed values for this property are: “FTP”, “FTPS”, “SFTP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The ftp_protocol of this FtpMonitorConfiguration.
Return type:	str

ftp_request_type¶

Gets the ftp_request_type of this FtpMonitorConfiguration. FTP monitor request type.

Allowed values for this property are: “LIST”, “UPLOAD”, “DOWNLOAD”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The ftp_request_type of this FtpMonitorConfiguration.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

is_active_mode¶

Gets the is_active_mode of this FtpMonitorConfiguration. If enabled, Active mode will be used for the FTP connection.

Returns:	The is_active_mode of this FtpMonitorConfiguration.
Return type:	bool

is_failure_retried¶

Gets the is_failure_retried of this MonitorConfiguration. If isFailureRetried is enabled, then a failed call will be retried.

Returns:	The is_failure_retried of this MonitorConfiguration.
Return type:	bool

network_configuration¶

Gets the network_configuration of this FtpMonitorConfiguration.

Returns:	The network_configuration of this FtpMonitorConfiguration.
Return type:	oci.apm_synthetics.models.NetworkConfiguration

upload_file_size_in_bytes¶

Gets the upload_file_size_in_bytes of this FtpMonitorConfiguration. File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.

Returns:	The upload_file_size_in_bytes of this FtpMonitorConfiguration.
Return type:	int

verify_response_codes¶

Gets the verify_response_codes of this FtpMonitorConfiguration. Expected FTP response codes. For status code range, set values such as 2xx, 3xx.

Returns:	The verify_response_codes of this FtpMonitorConfiguration.
Return type:	list[str]

verify_response_content¶

Gets the verify_response_content of this FtpMonitorConfiguration. Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.

Returns:	The verify_response_content of this FtpMonitorConfiguration.
Return type:	str