# 使用可能な Ruby メソッド
Workato の SDK フレームワークでコネクターを構築する際、公開されているすべての Ruby インスタンスメソッドが使用可能なわけではありません。 以下に、コネクターを構築する際に任意のブロックで使用できるホワイトリスト指定された Ruby メソッドのリストを示します。
また、SDK の使用時に任意のブロックで使用するための個人用の再利用可能メソッドを宣言することができます。
# 事前定義の Ruby メソッド
メソッド | 説明 |
---|---|
at | 指定の引数を使用して新しい時間オブジェクトを作成します。 詳細については、こちらをご覧ください。 |
abs | 数の絶対値を返します。 |
aes_cbc_encrypt | CBC モードでの AES 暗号化。128、192、および256ビットのキーを受け付けます。
|
aes_cbc_decrypt | CBC モードでの AES 復号。128、192、および256ビットのキーを受け付けます。
|
aes_gcm_encrypt | GCM モードでの AES 暗号化。128、192、および256ビットのキーを受け付けます。
オプションで、認証データを指定することもできます。
|
aes_gcm_decrypt | GCM モードでの AES 復号。128、192、および256ビットのキーを受け付けます。
認証データを使用して暗号化した場合は、auth_token を指定する必要があります。
|
after_error_response | HTTP 要求につなげて、失敗した要求を救済できます。詳細については、こちらをご覧ください。 |
after_response | HTTP 要求につなげて、応答ヘッダーなどを利用できます。詳細については、こちらをご覧ください。 |
ago | 時間を戻します。タイムスタンプを返します。 詳細については、こちらをご覧ください。 |
all? | コレクションの各要素を指定したブロックに渡します。このメソッドは、ブロックが false または nil を返さない場合に true を返します。 https://apidock.com/ruby/Enumerable/all%3F |
as_string | バイトシーケンスを指定されたエンコーディングの文字列としてデコードします。
|
as_utf8 | バイトシーケンスを指定されたエンコーディングの文字列としてデコードします。
|
aws.generate_signature | AWS サービス向けの AWS V4 署名を生成し、要求を作成するための URL と署名を含むハッシュを返します。
AWS 認証の詳細については、こちらをご覧ください。
|
blank? | 値が null または空の文字列の場合は true を返し、それ以外の場合は false を返します。 |
binary? | 値がバイナリ配列の場合、true を返します。 |
beginning_of_hour | 指定されたタイムスタンプの正時のタイムスタンプを返します。
|
beginning_of_day | 指定されたタイムスタンプの午前0時のタイムスタンプを返します。
|
beginning_of_week | 指定されたタイムスタンプの週の最初 (月曜日) の午前0時のタイムスタンプを返します。
|
beginning_of_month | 指定されたタイムスタンプの月の最初の午前0時のタイムスタンプを返します。
|
beginning_of_year | 指定されたタイムスタンプの年の最初の午前0時のタイムスタンプを返します。
|
bytes | 指定された文字列のバイトの配列を返します。
|
bytesize | 指定された文字列の長さをバイト単位で返します。
|
capitalize | 文字列の最初の文字を大文字にします。 |
case_sensitive_headers | HTTP メソッドにつなげることができ、大文字と小文字を区別するヘッダーを導入します。デフォルトでは、Workato は RFC 仕様どおり、ヘッダーの大文字と小文字を区別しません。
|
chunk | ブロックの戻り値に基づき、項目をチャンクにまとめて列挙します。 詳細については、こちらをご覧ください。 |
chunk_while | 各チャンク要素の列挙子を作成します。チャンクの先頭はブロックで定義されます。 詳細については、こちらをご覧ください。 |
collect | 列挙内の要素ごとに一度のブロック実行の結果を含む新しい配列を返します。 詳細については、こちらをご覧ください。 |
collect_concat | 列挙内の要素ごとに一度のブロック実行の結合された結果を含む新しい配列を返します。 詳細については、こちらをご覧ください。 |
compact | Nil 以外の値のハッシュを返します。 詳細については、こちらをご覧ください。 |
cycle | 指定した回数だけ配列を繰り返し、要素ごとに1つのブロックを呼び出します。 詳細については、こちらをご覧ください。 |
decode_base64 | Base64 アルゴリズムを使用してデコードします。 |
decode_hex | 16進数をバイナリ文字列にデコードします。 |
decode_url | 文字列を URL デコードします。この方式では `CGI.unescape` を使用して URL デコードを行います。 |
decode_urlsafe_base64 | URL セーフの修正が盛り込まれた Base64 アルゴリズムを使用してデコードします。 |
decryt | AES-256-CBC アルゴリズムを使用して暗号化された文字列を復号します。入力は RNCryptor V3 フォーマットである必要があります。 |
deep_merge | ネストされた子ハッシュを含め、ハッシュを別のハッシュと結合します。 詳細については、こちらをご覧ください。 |
delete_at | 配列内の要素を削除します。 詳細については、こちらをご覧ください。 |
detect | 配列内の各要素をブロックに渡します。ブロックを満たす最初の要素を返します。 詳細については、こちらをご覧ください。 |
dig | 渡されるインデックスに対応する値オブジェクトを取得します。 dig メソッドは、多くの場合、ネストされた配列やハッシュ内のレイヤーを取り除くために使用されます。たとえば、XML データフォーマットを処理する際によく dig メソッドが使用されます。 詳細については、こちらをご覧ください。 |
drop | 列挙子から最初の N 個の要素を削除し、配列内の残りの要素を返します。 詳細については、こちらをご覧ください。 |
drop_while | ブロックが nil または false を返す配列の最初の要素まで (この最初の要素は含まない) の要素を削除します。 詳細については、こちらをご覧ください。 |
dst? | 時刻が指定されたタイムゾーンの夏時間の範囲内である場合、true を返します。 |
each | 基本的なイテレータ。[1, 2, 3].each { |i| puts i } |
each_byte | 指定された文字列の各バイトを指定されたブロックに渡します。ブロックが指定されていない場合は列挙子を返します。詳細については、こちらをご覧ください。 |
each_char | 指定された文字列の各文字を指定されたブロックに渡します。ブロックが指定されていない場合は列挙子を返します。詳細については、こちらをご覧ください。 |
each_cons | 連続する N 個の要素の各配列について、指定されたブロックを反復処理します。ブロックが指定されていない場合は、列挙子を返します。詳細については、こちらをご覧ください。 |
each_entry | 配列を反復処理し、ブロック内の各要素を返します。詳細については、こちらをご覧ください。 |
each_slice | N 個の要素の各スライスについて、指定されたブロックを反復処理します。ブロックが指定されていない場合は、列挙子を返します。詳細については、こちらをご覧ください。 |
each_with_index | このイテレータは、インデックスを使用して値を返します。[1, 2, 3].each_with_index { |item, index| puts "#{index}:#{item}" } 詳細については、こちらをご覧ください。 |
each_with_object | このイテレータは、ユーザーが定義できるオブジェクトを使用して値を返します。 詳細については、こちらをご覧ください。 |
encode_hex | バイナリ文字列を16進表現に変換します。
|
encode_sha256 | SHA256 アルゴリズムを使用してエンコードします。 |
encode_base64 | Base64 アルゴリズムを使用してエンコードします。 |
encode_url | 文字列を URL エンコードします。
|
encode_urlsafe_base64 | URL セーフの修正が盛り込まれた Base64 アルゴリズムを使用してエンコードします。 |
encode_www_form | ハッシュを URL エンコードされたパラメータの文字列に連結します。
|
ends_of_month | 月の終了を表す新しい日時を返します。
|
ends_with? | 文字列が特定のパターンで終了する場合、true を返します。それ以外の場合は false を返します。
|
entries | 列挙内の各項目を含む配列を返します。 詳細については、こちらをご覧ください。 |
error | ユーザー定義のエラー本体を使用して、ジョブエラーを生成します。error("Unable to find Account with ID: 123") |
even? | 整数が偶数の場合に true を返します。 詳細については、こちらをご覧ください。 |
except | 指定されたキーを除くすべてを含むハッシュを返します。 詳細については、こちらをご覧ください。 |
exclude | フィールドに値が含まれていない場合に true を返します。大文字と小文字が区別されます。 詳細については、こちらをご覧ください。 |
fetch | 指定されたキーに対して、ハッシュからの値を返します。 詳細については、こちらをご覧ください。 |
find_all | ブロック内で示した条件を満足するハッシュまたは配列のすべての要素を含む配列を返します。 詳細については、こちらをご覧ください。 |
find_index | 配列内の各要素を指定したブロックと比較し、最初に一致したもののインデックスを返します。 詳細については、こちらをご覧ください。 |
first | リスト内の最初の項目を返します。これを使用して、リスト内の最初の n 個の項目を返すこともできます。 詳細については、こちらをご覧ください。 |
flatten | 多次元配列をシンプルな配列に平坦化します。 詳細については、こちらをご覧ください。 |
flat_map | 列挙内の要素ごとに一度のブロック実行の結合された結果を含む新しい配列を返します。 詳細については、こちらをご覧ください。 |
follow_redirection |
Workato では、デフォルトで、ほとんどの 3XX のリダイレクト HTTP コードに従っています。場合によっては、すべての応答コードのリダイレクトに従うためにこれを適用する必要があります。
|
format_json | 要求を JSON フォーマットに変換し、JSON フォーマットの応答本体を期待します。 |
format_map | 指定された配列の各行をフォーマットすることにより、文字列の配列を作成します。 詳細については、こちらをご覧ください。 |
format_xml | 要求を XML フォーマットに変換し、XML フォーマットの応答本体を期待します。 |
from_now | 時間を進めます。太平洋時間 (UTC-8/UTC-7) で指定された期間を加算して、formula が実行された時間のタイムスタンプを返します。
|
from_xml | XML 文字列をハッシュに変換します。
|
grep | 列挙子を検索して、条件を満たすすべての要素を見つけます。 詳細については、こちらをご覧ください。 |
grep_v | 列挙子を検索して、条件を満たさないすべての要素を見つけます。 詳細については、こちらをご覧ください。 |
group_by | 配列をセットにグループ化します。 詳細については、こちらをご覧ください。 |
gsub | パターンを値に置き換えます。大文字と小文字が区別されます。 詳細については、こちらをご覧ください。 |
has_key? | 指定されたキーがハッシュに存在する場合、true を返します。 詳細については、こちらをご覧ください。 |
header | ヘッダーを要求に追加します。.headers(Authorization: "Bearer HTB674HJK1") |
hmac_md5 | HMAC_MD5 署名を作成します。
|
hmac_sha1 | HMAC_SHA1 署名を作成します。
|
hmac_sha256 | HMAC_SHA256 署名を作成します。
|
hmac_sha512 | HMAC_SHA512 署名を作成します。
|
ignore_redirection | 要求が直ちにリダイレクトされるのを停止できます。一般には、ファイルをダウンロードするため、要求が AWS S3 などのセカンダリサイトにリダイレクトされる場合に使用されます。「Current_url」を使用する apply: キーで使用される認証をすべて取り除く必要があります。
|
ignored | フィールドのコンマ区切りのリストを無視します。object_definition["user"].ignored("id", "created_at") |
include? | フィールドに値が含まれる場合に true を返します。それ以外の場合は false を返します。 詳細については、こちらをご覧ください。 |
inject | 演算を使用して、配列内の要素を組み合わせます。 詳細については、こちらをご覧ください。 |
insert | 要素を配列に挿入します。 詳細については、こちらをご覧ください。 |
in_time_zone | 時刻を指定されたタイムゾーンに変換します。
|
is_a? | クラスがオブジェクトのクラス、オブジェクトのスーパークラスのいずれか、またはオブジェクトに含まれるモジュールのいずれかの場合、true を返します。 Workato では、現在、Array、Hash、Time、String、Integer、Float のクラスをサポートしています。 詳細については、こちらをご覧ください。 |
is_true? | 値を boolean に変換し、値が真値の場合 true を返します。 |
is_not_true? | 値を boolean に変換し、値が真値でない場合 true を返します。 |
iso8601 | date/date-time 変数を ISO8601 フォーマットに変換します。 |
join | 配列要素を文字列に連結します。 詳細については、こちらをご覧ください。 |
jwt_encode | RS256、RS384、RS512、HS256 のいずれかのアルゴリズムを使用して、JWT を作成します。追加で指定されるパラメータが、ヘッダー (次の例の kid) に追加されます。
|
last | リスト内の最後の項目を返します。これを使用して、リスト内の最後の n 個の項目を返すこともできます。 詳細については、こちらをご覧ください。 |
ljust | 文字列を左揃えにし、指定した長さになるまで空白またはパターンを挿入します。 詳細については、こちらをご覧ください。 |
lookup | Workato で定義した Lookup table からレコードを検索します。 詳細については、こちらをご覧ください。 |
lstrip | 文字列の先頭から空白を削除します。 詳細については、こちらをご覧ください。 |
map | 各要素でブロックを呼び出した後で、新しい配列を返します。 |
md5_hexdigest | MD5 メッセージダイジェストアルゴリズムを使用して、メッセージダイジェストを作成します。
|
match? | 文字列にパターンが含まれる場合に true を返します。大文字と小文字が区別されます。
|
max_by | 指定されたブロックの最大値が生じる列挙内のオブジェクトを返します。
|
member? | include? のエイリアス。 詳細については、こちらをご覧ください。 |
merge | 結合されたコンテンツを含む新しいハッシュを返します。 詳細については、こちらをご覧ください。 |
minmax | 列挙内の最小値と最大値を含む2要素の配列を返します。 詳細については、こちらをご覧ください。 |
minmax_by | 指定したブロックの最小値と最大値のそれぞれに対応する列挙内のオブジェクトを含む2要素の配列を返します。 詳細については、こちらをご覧ください。 |
min_by | 指定されたブロックの最小値が生じる列挙内のオブジェクトを返します。 詳細については、こちらをご覧ください。 |
next |
列挙子内の次のオブジェクトを返し、内部位置を進めます。 これは、多くの場合 config_fields で使用されます。ここでは、lambda 関数が実行される前に入力をチェックするガード節を追加する手段として next を使用できます。
詳細については、こちらをご覧ください。 |
none? | コレクションの各要素を指定したブロックに渡します。このメソッドは、ブロックがどの要素に対しても true を返さない場合に true を返します。 詳細については、こちらをご覧ください。 |
now | 太平洋時間 (UTC-8/UTC-7) で、formula が実行された時間のタイムスタンプを返します。
|
odd? | 整数が奇数の場合に true を返します。 詳細については、こちらをご覧ください。 |
one? | コレクションの各要素を指定したブロックに渡します。このメソッドは、ブロックが一度だけ true を返す場合に true を返します。 詳細については、こちらをご覧ください。 |
only | コンマ区切りのフィールドのホワイトリスト。object_definition["user"].only("id", "name") |
ordinalize | 数値を、1st、2nd、3rd、4th など、順序列内の位置を表すために使用される序数文字列に変換します。
|
pack | 配列のコンテンツをバイナリシーケンスに変換します。 詳細については、こちらをご覧ください。 |
parallel | 要求の配列を受け付け、複数のスレッドでこれらを実行できます。
詳細については、こちらをご覧ください。 |
parameterize | 文字列内の特殊文字を置き換えます。
|
params | パラメータを要求に追加します。.params(api_key: "HTB674HJK1") |
parse_json | json.parse と同様に機能します。 詳細については、こちらをご覧ください。 |
parse_yaml | YAML 文字列を解析します。true、false、nil、数値、文字列、配列、ハッシュをサポートしています。
|
payload | ペイロードを要求に追加します。.payload(id: "345") |
pbkdf2_hmac_sha1 | パスワードとソルトを使用して、さまざまなビット長のキーを作成します。HMAC Sha1 を使用します。
|
pluck | オブジェクトの配列から1つ以上の属性を選択します。 上記の例は、[1, 2] を返します。 |
pluralize | 文字列内の単語の複数形を返します。 詳細については、こちらをご覧ください。 |
pop | それ自体から最後の要素を削除し、その要素を返します。配列が空の場合は nil を返します。 数値 n が指定されている場合は、最後の n 個 (またはそれ未満) の要素の配列を返し、配列からその要素を削除します。 詳細については、こちらをご覧ください。 |
presence | 存在する場合、その値を返します。存在しない場合は、nil を返します。
詳細については、こちらをご覧ください。 |
present? | そのフィールドに値がある場合に true を返します。それ以外の場合は false を返します。
詳細については、こちらをご覧ください。 |
puts | console.log または stdout の ruby バージョンです。put メソッドとは異なります。 puts メソッドを使用した出力は、コードエディターでのテストの際、コンソールログに表示されます。これをデバッグに役立てることができます。 |
rand | 0 ~ 1の範囲のランダムな数。 |
random_bytes | 指定した数のランダムなバイトを生成します。workato.random_bytes(8) |
reduce | メソッドまたは演算子を示すブロックまたは記号により指定された二項演算を適用することで、列挙内のすべての要素を組み合わせます。 詳細については、こちらをご覧ください。 |
reject | ブロックが false を返す要素を選択的に返します。select に似ていますが、反対になります。 詳細については、こちらをご覧ください。 |
render_yaml | オブジェクトを YAML 文字列に表します。
|
response_format_json | JSON フォーマットでの応答を期待します。 |
response_format_raw | RAW フォーマットでの応答を期待します。これは、応答としてバイナリデータ (PDF や画像など) を期待する HTTP アクションの後につなげることができます。例 |
response_format_xml | XML フォーマットでの応答を期待します。 |
request_format_json | 要求を JSON フォーマットに変換します。 |
request_format_multipart_form | 要求を multipart_form フォーマットに変換します。 |
request_format_www_form_urlencoded | 要求を URL エンコードフォーマットに変換します。 |
request_format_xml | 要求を XML フォーマットに変換します。 |
required | 必要なフィールドのコンマ区切りのリストを作成します。object_definition["user"].required("id", "created_at") |
reverse | 文字列または配列の順序を反転させます。 |
reverse_each | 一時的な配列を作成し、その配列を逆順に走査します。詳細については、こちらをご覧ください。 |
rjust | 文字列を右揃えにし、指定した長さになるまで空白またはパターンを挿入します。
詳細については、こちらをご覧ください。 |
round | 標準の端数処理規則で数値を端数処理します。
詳細については、こちらをご覧ください。 |
rsa_sha256 | RS256 署名 (RSA キーで署名された SHA256 ハッシュ) を作成します。
|
rstrip | 文字列の末尾から空白を削除します。 詳細については、こちらをご覧ください。 |
scan | 文字列内をスキャンして一致するパターンを探します。 詳細については、こちらをご覧ください。 |
select | ブロックが true を返す要素を選択的に返します。 詳細については、こちらをご覧ください。 |
SHA1 | SHA1 暗号化アルゴリズムを使用して、指定された文字列を暗号化します。 詳細については、こちらをご覧ください。 |
singularize | pluralize の逆。文字列内の単語の単数形を返します。 詳細については、こちらをご覧ください。 |
slice | 開始インデックスと長さで定義されているとおりに、指定された文字列の部分文字列を返します。 詳細については、こちらをご覧ください。 |
slice_after | 特定の値の後で配列を切り取ります。 詳細については、こちらをご覧ください。 |
slice_before | 特定の値の前で配列を切り取ります。 詳細については、こちらをご覧ください。 |
slice_when | 各チャンク要素の列挙子を作成します。 詳細については、こちらをご覧ください。 |
smart_join | 配列を文字列に連結します。空の値および nil 値は削除します。空白は連結する前に削除します。 詳細については、こちらをご覧ください。 |
sort | ソートされた新しい配列を返す sort 関数。 詳細については、こちらをご覧ください。 |
sort_by | それ自体を返す sort 関数。 詳細については、こちらをご覧ください。 |
split | 定義されたパターンを区切り文字として使用して、文字列を配列に分割します。 詳細については、こちらをご覧ください。 |
strip | 文字列の先頭と末尾から空白を取り除きます。 詳細については、こちらをご覧ください。 |
strip_tags | 文字列から html タグを取り除きます。
|
strftime | % プレースホルダを使用して、日付または時刻をフォーマットします。 |
sub | 最初に出現するパターンを値に置き換えます。
|
take | 配列の最初の N 個の要素を返します。 詳細については、こちらをご覧ください。 |
take_while | ブロックが nil または false を返すまで、そのブロックに要素を渡した後、反復を停止してそれまでのすべての要素の配列を返します。 詳細については、こちらをご覧ください。 |
tap | ブロックに x を生成し、x を返します。 tap メソッドは、多くの場合、変換に使用されます。たとえば、以下の tap メソッドを使用して、webhook のペイロードを変換します。webhook のペイロードが次のフォーマットで提供されているとします。
tap を使用することで、これをよりユーザーフレンドリな JSON に変換できます。
最終的な JSON は次のようになります。{"id"=>1, "name"=>2} 詳細については、こちらをご覧ください。 |
tls_client_cert | Workato が要求で使用する TLS キー、TLS クライアント、および中間証明書を指定できます。これを単一の要求につなげるか、一般的に apply ブロックで使用することができます。
|
tls_server_certs | SSL ハンドシェイクプロセスで、Workato が受け付ける TLS サーバー証明書を指定できます。これは、自己署名または信頼できないルート CA 証明書の場合に便利です。これを単一の要求につなげるか、一般的に apply ブロックで使用することができます。
|
to_currency | 通貨文字列に変換します。
|
to_currency_code | alpha-2/3の国名コードまたは国名を ISO4217 の通貨コードに変換します。
|
to_currency_name | alpha-2/3の国名コードまたは国名を ISO4217 の通貨名に変換します。
|
to_currency_symbol | alpha-2/3の国名コードまたは国名を ISO4217 の通貨記号に変換します。
|
to_country_alpha2 | alpha-3 の国名コードまたは国名を alpha2 国名コードに変換します。
|
to_country_alpha3 | alpha-2 の国名コードまたは国名を alpha3 国名コードに変換します。
|
to_country_name | alpha-2/3の国名コードまたは国名を ISO3166 の国名に変換します。
|
to_country_number | alpha-2/3の国名コードまたは国名を ISO3166 の numeric の国名コードに変換します。
|
to_date | 文字列またはタイムスタンプを日付に変換します。フォーマット可能です。
|
to_f | 浮動小数点数に変換します。標準の端数処理規則に基づいて、数値が切り上げまたは切り下げられます。
|
to_hex | バイナリ文字列を16進表現に変換します。 |
to_i | 整数に変換します。小数は常に切り捨てられます。
|
to_json | ハッシュまたは配列を JSON 文字列に変換します。
|
to_phone | 文字列または数値をフォーマットされた電話番号に変換します。
|
to_param | URL クエリー文字列として使用する文字列表現を返します。
|
to_s | 文字列に変換します。
|
to_state_code | 州の名前をコードに変換します。
|
to_state_name | 州のコードを名前に変換します。
|
to_time | 文字列または日付をタイムスタンプに変換します。
|
to_xml | ハッシュまたは配列を XML 文字列に変換します。
|
today | 本日の日付。太平洋時間 (UTC-8/UTC-7) で、formula が実行された日付を返します。
|
transliterate | 非 ASCII 文字を ASCII 近似に置き換えます。これらが存在しない場合、置換文字はデフォルトで「?」になります。
|
upcase | 文字列を大文字に変換します。
|
uniq | 配列内で一意の項目を返します。
|
unpack | 文字列を配列にデコードします。 詳細については、こちらをご覧ください。 |
utc | Time をUTC タイムゾーンに変換します。 詳細については、こちらをご覧ください。 |
uuid | UUID を作成します。要求内で一意の文字列を送信する場合に役立ちます。
|
where | 指定された条件で配列をフィルタリングします。 |
while | while loop ステートメント。 詳細については、こちらをご覧ください。 |
wday | 曜日を返します。1が月曜日になります。 |
wrap | すでに配列である場合を除き、配列内の引数をラップします。 wrap メソッドは、多くの場合、execute ブロックで使用されます。while loop ステートメント。
これにより、何が返されても accounts 変数は常に配列となります。Workato では、使用するさまざまな API から予期しない値が返されるのを防ぐためによくこれを使用します。 詳細については、こちらをご覧ください。 |
yday | 年内通算日数を返します。
|
yweek | 年内通算週数を返します。
|
zip | 配列で呼び出されるメソッドとして使用されます。引数を配列に変換した後、それ自体の要素を各引数からの対応する要素と結合します。 詳細については、こちらをご覧ください。 |
このリストは絶えず拡張されています。このリストに対する更新および追加については、ご遠慮なくお問い合わせください。
←
メソッド
Last updated: 2024/12/20 18:05:23