////
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at
  http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
////
:documentationPath: /pipeline/transforms/
:language: en_US
:description: The Check If Webservice Is Available transform checks if a webservice URL in the data stream is valid, can be connected to and can be read.

= image:transforms/icons/webserviceavailable.svg[Check if webservice is available transform Icon, role="image-doc-icon"] Check if webservice is available

[%noheader,cols="3a,1a", role="table-no-borders" ]
|===
|
== Description

The Check If Webservice Is Available transform checks if a webservice URL in the data stream is valid, can be connected to and can be read.
If it connects within the given time and data can be read, it returns 'true' as a boolean result value, otherwise 'false'.
Further information of the failing reason can be found in the log when debug logging is enabled.

|
== Supported Engines
[%noheader,cols="2,1a",frame=none, role="table-supported-engines"]
!===
!Hop Engine! image:check_mark.svg[Supported, 24]
!Spark! image:question_mark.svg[Maybe Supported, 24]
!Flink! image:question_mark.svg[Maybe Supported, 24]
!Dataflow! image:question_mark.svg[Maybe Supported, 24]
!===
|===

== Options

[options="header"]
|===
|Option|Description
|Transform name|Name of the transform.
|URL field|Specifies the URL fieldname in the data stream.
The URL is checked for every row that is coming into this transform.
|Connect timeout (ms)|The connect timeout in ms.
The value is depending on the quality of service of this URL and experiences.
|Read timeout (ms)|After connection, the transform tries to read data.
This value gives the read timeout in ms.
The value is depending on the quality of service of this URL and experiences.
|Result fieldname|If it connects within the given timeout and data can be read, it returns 'true' as a boolean result value, otherwise 'false'
|===

