Debian Codegraph @

lib/Search/Elasticsearch/Client/8_0/Direct/ConnectorSyncJob.pm

raw
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::ConnectorSyncJob;
19 $Search::Elasticsearch::Client::8_0::Direct::ConnectorSyncJob::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_sync_job');
24
25 1;
26
27 =pod
28
29 =encoding UTF-8
30
31 =head1 NAME
32
33 Search::Elasticsearch::Client::8_0::Direct::ConnectorSyncJob - A client for create and manage Elastic sync jobs
34
35 =head1 VERSION
36
37 version 8.12
38
39 =head1 DESCRIPTION
40
41 The sync jobs API provides a convenient way to create
42 and manage Elastic sync jobs in an internal index.
43
44 This API provides an alternative to relying solely on Kibana UI
45 for sync job management.
46
47 The full documentation for Sync job feature is available here:
48 L<https://www.elastic.co/guide/en/elasticsearch/reference/8.12/connector-apis.html#sync-job-apis>
49
50 It does L<Search::Elasticsearch::Role::Client::Direct>.
51
52 =head1 METHODS
53
54 =head2 C<put()>
55
56 $response = $e->connector_sync_job->post(
57 body => {
58 id => "connector-id",
59 job_type => "full",
60 trigger_method => 'on_demand'
61 }
62 );
63
64 The C<post()> method create a connector sync job.
65
66 =head1 AUTHOR
67
68 Enrico Zimuel <[email protected]>
69
70 =head1 COPYRIGHT AND LICENSE
71
72 This software is Copyright (c) 2024 by Elasticsearch BV.
73
74 This is free software, licensed under:
75
76 The Apache License, Version 2.0, January 2004
77
78 =cut
79
80 __END__
81
82 # ABSTRACT: A client for create and manage Elastic sync jobs
83