| 1 |
# Licensed to Elasticsearch B.V. under one or more contributor |
| 2 |
# license agreements. See the NOTICE file distributed with |
| 3 |
# this work for additional information regarding copyright |
| 4 |
# ownership. Elasticsearch B.V. licenses this file to you under |
| 5 |
# the Apache License, Version 2.0 (the "License"); you may |
| 6 |
# not use this file except in compliance with the License. |
| 7 |
# You may obtain a copy of the License at |
| 8 |
# |
| 9 |
# http://www.apache.org/licenses/LICENSE-2.0 |
| 10 |
# |
| 11 |
# Unless required by applicable law or agreed to in writing, |
| 12 |
# software distributed under the License is distributed on an |
| 13 |
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 14 |
# KIND, either express or implied. See the License for the |
| 15 |
# specific language governing permissions and limitations |
| 16 |
# under the License. |
| 17 |
|
| 18 |
package Search::Elasticsearch::Client::8_0::Direct::Connector; |
| 19 |
$Search::Elasticsearch::Client::8_0::Direct::Connector::VERSION = '8.12'; |
| 20 |
use Moo; |
| 21 |
with 'Search::Elasticsearch::Client::8_0::Role::API'; |
| 22 |
with 'Search::Elasticsearch::Role::Client::Direct'; |
| 23 |
__PACKAGE__->_install_api('connector'); |
| 24 |
|
| 25 |
1; |
| 26 |
|
| 27 |
=pod |
| 28 |
|
| 29 |
=encoding UTF-8 |
| 30 |
|
| 31 |
=head1 NAME |
| 32 |
|
| 33 |
Search::Elasticsearch::Client::8_0::Direct::Connector - A client for create and manage Elastic connectors |
| 34 |
|
| 35 |
=head1 VERSION |
| 36 |
|
| 37 |
version 8.12 |
| 38 |
|
| 39 |
=head1 DESCRIPTION |
| 40 |
|
| 41 |
The connector and sync jobs API provides a convenient way to create |
| 42 |
and manage Elastic connectors and sync jobs in an internal index. |
| 43 |
|
| 44 |
This API provides an alternative to relying solely on Kibana UI |
| 45 |
for connector and sync job management. The API comes with a set of |
| 46 |
validations and assertions to ensure that the state representation |
| 47 |
in the internal index remains valid. |
| 48 |
|
| 49 |
The full documentation for Eql feature is available here: |
| 50 |
L<https://www.elastic.co/guide/en/elasticsearch/reference/master/connector-apis.html> |
| 51 |
|
| 52 |
It does L<Search::Elasticsearch::Role::Client::Direct>. |
| 53 |
|
| 54 |
=head1 METHODS |
| 55 |
|
| 56 |
=head2 C<put()> |
| 57 |
|
| 58 |
$response = $e->connector->put( |
| 59 |
connector_id => "my-connector", |
| 60 |
body => { |
| 61 |
index_name => "search-google-drive", |
| 62 |
name => "My Connector", |
| 63 |
service_type => "google_drive" |
| 64 |
} |
| 65 |
); |
| 66 |
|
| 67 |
The C<put()> method create a connector. |
| 68 |
|
| 69 |
=head1 AUTHOR |
| 70 |
|
| 71 |
Enrico Zimuel <[email protected]> |
| 72 |
|
| 73 |
=head1 COPYRIGHT AND LICENSE |
| 74 |
|
| 75 |
This software is Copyright (c) 2024 by Elasticsearch BV. |
| 76 |
|
| 77 |
This is free software, licensed under: |
| 78 |
|
| 79 |
The Apache License, Version 2.0, January 2004 |
| 80 |
|
| 81 |
=cut |
| 82 |
|
| 83 |
__END__ |
| 84 |
|
| 85 |
# ABSTRACT: A client for create and manage Elastic connectors |
| 86 |
|