BatchV1Api.pm

=begin comment

Kubernetes

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1.13.7

Generated by: https://openapi-generator.tech

=end comment

=cut

#
# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
# Do not edit the class manually.
# Ref: https://openapi-generator.tech
#
package Kubernetes::BatchV1Api;

require 5.6.0;
use strict;
use warnings;
use utf8;
use Exporter;
use Carp qw( croak );
use Log::Any qw($log);

use Kubernetes::ApiClient;

use base "Class::Data::Inheritable";

__PACKAGE__->mk_classdata( 'method_documentation' => {} );

sub new {
    my $class = shift;
    my $api_client;

    if ( $_[0] && ref $_[0] && ref $_[0] eq 'Kubernetes::ApiClient' ) {
        $api_client = $_[0];
    }
    else {
        $api_client = Kubernetes::ApiClient->new(@_);
    }

    bless { api_client => $api_client }, $class;

}

#
# create_namespaced_job
#
#
#
# @param string $namespace object name and auth scope, such as for teams and projects (required)
# @param V1Job $body  (required)
# @param boolean $include_uninitialized If true, partially initialized resources are included in the response. (optional)
# @param string $pretty If 'true', then the output is pretty printed. (optional)
# @param string $dry_run When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
{
    my $params = {
        'namespace' => {
            data_type => 'string',
            description =>
              'object name and auth scope, such as for teams and projects',
            required => '1',
        },
        'body' => {
            data_type   => 'V1Job',
            description => '',
            required    => '1',
        },
        'include_uninitialized' => {
            data_type => 'boolean',
            description =>
'If true, partially initialized resources are included in the response.',
            required => '0',
        },
        'pretty' => {
            data_type => 'string',
            description =>
              'If 'true', then the output is pretty printed.',
            required => '0',
        },
        'dry_run' => {
            data_type => 'string',
            description =>
'When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed',
            required => '0',
        },
    };
    __PACKAGE__->method_documentation->{'create_namespaced_job'} = {
        summary => '',
        params  => $params,
        returns => 'V1Job',
    };
}

# @return V1Job
#
sub create_namespaced_job {
    my ( $self, %args ) = @_;

    # verify the required parameter 'namespace' is set
    unless ( exists $args{'namespace'} ) {
        croak(
"Missing the required parameter 'namespace' when calling create_namespaced_job"
        );
    }

    # verify the required parameter 'body' is set
    unless ( exists $args{'body'} ) {
        croak(
"Missing the required parameter 'body' when calling create_namespaced_job"
        );
    }

    # parse inputs
    my $_resource_path = '/apis/batch/v1/namespaces/{namespace}/jobs';

    my $_method       = 'POST';
    my $query_params  = {};
    my $header_params = {};
    my $form_params   = {};

    # 'Accept' and 'Content-Type' header
    my $_header_accept =
      $self->{api_client}
      ->select_header_accept( 'application/json', 'application/yaml',
        'application/vnd.kubernetes.protobuf' );
    if ($_header_accept) {
        $header_params->{'Accept'} = $_header_accept;
    }
    $header_params->{'Content-Type'} =
      $self->{api_client}->select_header_content_type();

    # query params
    if ( exists $args{'include_uninitialized'} ) {
        $query_params->{'includeUninitialized'} =
          $self->{api_client}->to_query_value( $args{'include_uninitialized'} );
    }

    # query params
    if ( exists $args{'pretty'} ) {
        $query_params->{'pretty'} =
          $self->{api_client}->to_query_value( $args{'pretty'} );
    }

    # query params
    if ( exists $args{'dry_run'} ) {
        $query_params->{'dryRun'} =
          $self->{api_client}->to_query_value( $args{'dry_run'} );
    }

    # path params
    if ( exists $args{'namespace'} ) {
        my $_base_variable = "{" . "namespace" . "}";
        my $_base_value =
          $self->{api_client}->to_path_value( $args{'namespace'} );
        $_resource_path =~ s/$_base_variable/$_base_value/g;
    }

    my $_body_data;

    # body params
    if ( exists $args{'body'} ) {
        $_body_data = $args{'body'};
    }

    # authentication setting, if any
    my $auth_settings = [qw(BearerToken )];

    # make the API Call
    my $response = $self->{api_client}->call_api(
        $_resource_path, $_method,    $query_params, $form_params,
        $header_params,  $_body_data, $auth_settings
    );
    if ( !$response ) {
        return;
    }
    my $_response_object =
      $self->{api_client}->deserialize( 'V1Job', $response );
    return $_response_object;
}

#
# delete_collection_namespaced_job
#
#
#
# @param string $namespace object name and auth scope, such as for teams and projects (required)
# @param boolean $include_uninitialized If true, partially initialized resources are included in the response. (optional)
# @param string $pretty If 'true', then the output is pretty printed. (optional)
# @param string $continue The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
# @param string $field_selector A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
# @param string $label_selector A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
# @param int $limit limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.  The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
# @param string $resource_version When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
# @param int $timeout_seconds Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
# @param boolean $watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
{
    my $params = {
        'namespace' => {
            data_type => 'string',
            description =>
              'object name and auth scope, such as for teams and projects',
            required => '1',
        },
        'include_uninitialized' => {
            data_type => 'boolean',
            description =>
'If true, partially initialized resources are included in the response.',
            required => '0',
        },
        'pretty' => {
            data_type => 'string',
            description =>
              'If 'true', then the output is pretty printed.',
            required => '0',
        },
        'continue' => {
            data_type => 'string',
            description =>
'The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.',
            required => '0',
        },
        'field_selector' => {
            data_type => 'string',
            description =>
'A selector to restrict the list of returned objects by their fields. Defaults to everything.',
            required => '0',
        },
        'label_selector' => {
            data_type => 'string',
            description =>
'A selector to restrict the list of returned objects by their labels. Defaults to everything.',
            required => '0',
        },
        'limit' => {
            data_type => 'int',
            description =>
'limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.  The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.',
            required => '0',
        },
        'resource_version' => {
            data_type => 'string',
            description =>
'When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.',
            required => '0',
        },
        'timeout_seconds' => {
            data_type => 'int',
            description =>
'Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.',
            required => '0',
        },
        'watch' => {
            data_type => 'boolean',
            description =>
'Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.',
            required => '0',
        },
    };
    __PACKAGE__->method_documentation->{'delete_collection_namespaced_job'} = {
        summary => '',
        params  => $params,
        returns => 'V1Status',
    };
}

# @return V1Status
#
sub delete_collection_namespaced_job {
    my ( $self, %args ) = @_;

    # verify the required parameter 'namespace' is set
    unless ( exists $args{'namespace'} ) {
        croak(
"Missing the required parameter 'namespace' when calling delete_collection_namespaced_job"
        );
    }

    # parse inputs
    my $_resource_path = '/apis/batch/v1/namespaces/{namespace}/jobs';

    my $_method       = 'DELETE';
    my $query_params  = {};
    my $header_params = {};
    my $form_params   = {};

    # 'Accept' and 'Content-Type' header
    my $_header_accept =
      $self->{api_client}
      ->select_header_accept( 'application/json', 'application/yaml',
        'application/vnd.kubernetes.protobuf' );
    if ($_header_accept) {
        $header_params->{'Accept'} = $_header_accept;
    }
    $header_params->{'Content-Type'} =
      $self->{api_client}->select_header_content_type();

    # query params
    if ( exists $args{'include_uninitialized'} ) {
        $query_params->{'includeUninitialized'} =
          $self->{api_client}->to_query_value( $args{'include_uninitialized'} );
    }

    # query params
    if ( exists $args{'pretty'} ) {
        $query_params->{'pretty'} =
          $self->{api_client}->to_query_value( $args{'pretty'} );
    }

    # query params
    if ( exists $args{'continue'} ) {
        $query_params->{'continue'} =
          $self->{api_client}->to_query_value( $args{'continue'} );
    }

    # query params
    if ( exists $args{'field_selector'} ) {
        $query_params->{'fieldSelector'} =
          $self->{api_client}->to_query_value( $args{'field_selector'} );
    }

    # query params
    if ( exists $args{'label_selector'} ) {
        $query_params->{'labelSelector'} =
          $self->{api_client}->to_query_value( $args{'label_selector'} );
    }

    # query params
    if ( exists $args{'limit'} ) {
        $query_params->{'limit'} =
          $self->{api_client}->to_query_value( $args{'limit'} );
    }

    # query params
    if ( exists $args{'resource_version'} ) {
        $query_params->{'resourceVersion'} =
          $self->{api_client}->to_query_value( $args{'resource_version'} );
    }

    # query params
    if ( exists $args{'timeout_seconds'} ) {
        $query_params->{'timeoutSeconds'} =
          $self->{api_client}->to_query_value( $args{'timeout_seconds'} );
    }

    # query params
    if ( exists $args{'watch'} ) {
        $query_params->{'watch'} =
          $self->{api_client}->to_query_value( $args{'watch'} );
    }

    # path params
    if ( exists $args{'namespace'} ) {
        my $_base_variable = "{" . "namespace" . "}";
        my $_base_value =
          $self->{api_client}->to_path_value( $args{'namespace'} );
        $_resource_path =~ s/$_base_variable/$_base_value/g;
    }

    my $_body_data;

    # authentication setting, if any
    my $auth_settings = [qw(BearerToken )];

    # make the API Call
    my $response = $self->{api_client}->call_api(
        $_resource_path, $_method,    $query_params, $form_params,
        $header_params,  $_body_data, $auth_settings
    );
    if ( !$response ) {
        return;
    }
    my $_response_object =
      $self->{api_client}->deserialize( 'V1Status', $response );
    return $_response_object;
}

#
# delete_namespaced_job
#
#
#
# @param string $name name of the Job (required)
# @param string $namespace object name and auth scope, such as for teams and projects (required)
# @param string $pretty If 'true', then the output is pretty printed. (optional)
# @param string $dry_run When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)
# @param int $grace_period_seconds The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately. (optional)
# @param boolean $orphan_dependents Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both. (optional)
# @param string $propagation_policy Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground. (optional)
# @param V1DeleteOptions $body  (optional)
{
    my $params = {
        'name' => {
            data_type   => 'string',
            description => 'name of the Job',
            required    => '1',
        },
        'namespace' => {
            data_type => 'string',
            description =>
              'object name and auth scope, such as for teams and projects',
            required => '1',
        },
        'pretty' => {
            data_type => 'string',
            description =>
              'If 'true', then the output is pretty printed.',
            required => '0',
        },
        'dry_run' => {
            data_type => 'string',
            description =>
'When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed',
            required => '0',
        },
        'grace_period_seconds' => {
            data_type => 'int',
            description =>
'The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.',
            required => '0',
        },
        'orphan_dependents' => {
            data_type => 'boolean',
            description =>
'Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the \"orphan\" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.',
            required => '0',
        },
        'propagation_policy' => {
            data_type => 'string',
            description =>
'Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.',
            required => '0',
        },
        'body' => {
            data_type   => 'V1DeleteOptions',
            description => '',
            required    => '0',
        },
    };
    __PACKAGE__->method_documentation->{'delete_namespaced_job'} = {
        summary => '',
        params  => $params,
        returns => 'V1Status',
    };
}

# @return V1Status
#
sub delete_namespaced_job {
    my ( $self, %args ) = @_;

    # verify the required parameter 'name' is set
    unless ( exists $args{'name'} ) {
        croak(
"Missing the required parameter 'name' when calling delete_namespaced_job"
        );
    }

    # verify the required parameter 'namespace' is set
    unless ( exists $args{'namespace'} ) {
        croak(
"Missing the required parameter 'namespace' when calling delete_namespaced_job"
        );
    }

    # parse inputs
    my $_resource_path = '/apis/batch/v1/namespaces/{namespace}/jobs/{name}';

    my $_method       = 'DELETE';
    my $query_params  = {};
    my $header_params = {};
    my $form_params   = {};

    # 'Accept' and 'Content-Type' header
    my $_header_accept =
      $self->{api_client}
      ->select_header_accept( 'application/json', 'application/yaml',
        'application/vnd.kubernetes.protobuf' );
    if ($_header_accept) {
        $header_params->{'Accept'} = $_header_accept;
    }
    $header_params->{'Content-Type'} =
      $self->{api_client}->select_header_content_type();

    # query params
    if ( exists $args{'pretty'} ) {
        $query_params->{'pretty'} =
          $self->{api_client}->to_query_value( $args{'pretty'} );
    }

    # query params
    if ( exists $args{'dry_run'} ) {
        $query_params->{'dryRun'} =
          $self->{api_client}->to_query_value( $args{'dry_run'} );
    }

    # query params
    if ( exists $args{'grace_period_seconds'} ) {
        $query_params->{'gracePeriodSeconds'} =
          $self->{api_client}->to_query_value( $args{'grace_period_seconds'} );
    }

    # query params
    if ( exists $args{'orphan_dependents'} ) {
        $query_params->{'orphanDependents'} =
          $self->{api_client}->to_query_value( $args{'orphan_dependents'} );
    }

    # query params
    if ( exists $args{'propagation_policy'} ) {
        $query_params->{'propagationPolicy'} =
          $self->{api_client}->to_query_value( $args{'propagation_policy'} );
    }

    # path params
    if ( exists $args{'name'} ) {
        my $_base_variable = "{" . "name" . "}";
        my $_base_value = $self->{api_client}->to_path_value( $args{'name'} );
        $_resource_path =~ s/$_base_variable/$_base_value/g;
    }

    # path params
    if ( exists $args{'namespace'} ) {
        my $_base_variable = "{" . "namespace" . "}";
        my $_base_value =
          $self->{api_client}->to_path_value( $args{'namespace'} );
        $_resource_path =~ s/$_base_variable/$_base_value/g;
    }

    my $_body_data;

    # body params
    if ( exists $args{'body'} ) {
        $_body_data = $args{'body'};
    }

    # authentication setting, if any
    my $auth_settings = [qw(BearerToken )];

    # make the API Call
    my $response = $self->{api_client}->call_api(
        $_resource_path, $_method,    $query_params, $form_params,
        $header_params,  $_body_data, $auth_settings
    );
    if ( !$response ) {
        return;
    }
    my $_response_object =
      $self->{api_client}->deserialize( 'V1Status', $response );
    return $_response_object;
}

#
# get_api_resources
#
#
#
{
    my $params = {};
    __PACKAGE__->method_documentation->{'get_api_resources'} = {
        summary => '',
        params  => $params,
        returns => 'V1APIResourceList',
    };
}

# @return V1APIResourceList
#
sub get_api_resources {
    my ( $self, %args ) = @_;

    # parse inputs
    my $_resource_path = '/apis/batch/v1/';

    my $_method       = 'GET';
    my $query_params  = {};
    my $header_params = {};
    my $form_params   = {};

    # 'Accept' and 'Content-Type' header
    my $_header_accept =
      $self->{api_client}
      ->select_header_accept( 'application/json', 'application/yaml',
        'application/vnd.kubernetes.protobuf' );
    if ($_header_accept) {
        $header_params->{'Accept'} = $_header_accept;
    }
    $header_params->{'Content-Type'} =
      $self->{api_client}->select_header_content_type();

    my $_body_data;

    # authentication setting, if any
    my $auth_settings = [qw(BearerToken )];

    # make the API Call
    my $response = $self->{api_client}->call_api(
        $_resource_path, $_method,    $query_params, $form_params,
        $header_params,  $_body_data, $auth_settings
    );
    if ( !$response ) {
        return;
    }
    my $_response_object =
      $self->{api_client}->deserialize( 'V1APIResourceList', $response );
    return $_response_object;
}

#
# list_job_for_all_namespaces
#
#
#
# @param string $continue The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
# @param string $field_selector A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
# @param boolean $include_uninitialized If true, partially initialized resources are included in the response. (optional)
# @param string $label_selector A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
# @param int $limit limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.  The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
# @param string $pretty If 'true', then the output is pretty printed. (optional)
# @param string $resource_version When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
# @param int $timeout_seconds Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
# @param boolean $watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
{
    my $params = {
        'continue' => {
            data_type => 'string',
            description =>
'The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.',
            required => '0',
        },
        'field_selector' => {
            data_type => 'string',
            description =>
'A selector to restrict the list of returned objects by their fields. Defaults to everything.',
            required => '0',
        },
        'include_uninitialized' => {
            data_type => 'boolean',
            description =>
'If true, partially initialized resources are included in the response.',
            required => '0',
        },
        'label_selector' => {
            data_type => 'string',
            description =>
'A selector to restrict the list of returned objects by their labels. Defaults to everything.',
            required => '0',
        },
        'limit' => {
            data_type => 'int',
            description =>
'limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.  The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.',
            required => '0',
        },
        'pretty' => {
            data_type => 'string',
            description =>
              'If 'true', then the output is pretty printed.',
            required => '0',
        },
        'resource_version' => {
            data_type => 'string',
            description =>
'When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.',
            required => '0',
        },
        'timeout_seconds' => {
            data_type => 'int',
            description =>
'Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.',
            required => '0',
        },
        'watch' => {
            data_type => 'boolean',
            description =>
'Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.',
            required => '0',
        },
    };
    __PACKAGE__->method_documentation->{'list_job_for_all_namespaces'} = {
        summary => '',
        params  => $params,
        returns => 'V1JobList',
    };
}

# @return V1JobList
#
sub list_job_for_all_namespaces {
    my ( $self, %args ) = @_;

    # parse inputs
    my $_resource_path = '/apis/batch/v1/jobs';

    my $_method       = 'GET';
    my $query_params  = {};
    my $header_params = {};
    my $form_params   = {};

    # 'Accept' and 'Content-Type' header
    my $_header_accept = $self->{api_client}->select_header_accept(
        'application/json',
        'application/yaml',
        'application/vnd.kubernetes.protobuf',
        'application/json;stream=watch',
        'application/vnd.kubernetes.protobuf;stream=watch'
    );
    if ($_header_accept) {
        $header_params->{'Accept'} = $_header_accept;
    }
    $header_params->{'Content-Type'} =
      $self->{api_client}->select_header_content_type();

    # query params
    if ( exists $args{'continue'} ) {
        $query_params->{'continue'} =
          $self->{api_client}->to_query_value( $args{'continue'} );
    }

    # query params
    if ( exists $args{'field_selector'} ) {
        $query_params->{'fieldSelector'} =
          $self->{api_client}->to_query_value( $args{'field_selector'} );
    }

    # query params
    if ( exists $args{'include_uninitialized'} ) {
        $query_params->{'includeUninitialized'} =
          $self->{api_client}->to_query_value( $args{'include_uninitialized'} );
    }

    # query params
    if ( exists $args{'label_selector'} ) {
        $query_params->{'labelSelector'} =
          $self->{api_client}->to_query_value( $args{'label_selector'} );
    }

    # query params
    if ( exists $args{'limit'} ) {
        $query_params->{'limit'} =
          $self->{api_client}->to_query_value( $args{'limit'} );
    }

    # query params
    if ( exists $args{'pretty'} ) {
        $query_params->{'pretty'} =
          $self->{api_client}->to_query_value( $args{'pretty'} );
    }

    # query params
    if ( exists $args{'resource_version'} ) {
        $query_params->{'resourceVersion'} =
          $self->{api_client}->to_query_value( $args{'resource_version'} );
    }

    # query params
    if ( exists $args{'timeout_seconds'} ) {
        $query_params->{'timeoutSeconds'} =
          $self->{api_client}->to_query_value( $args{'timeout_seconds'} );
    }

    # query params
    if ( exists $args{'watch'} ) {
        $query_params->{'watch'} =
          $self->{api_client}->to_query_value( $args{'watch'} );
    }

    my $_body_data;

    # authentication setting, if any
    my $auth_settings = [qw(BearerToken )];

    # make the API Call
    my $response = $self->{api_client}->call_api(
        $_resource_path, $_method,    $query_params, $form_params,
        $header_params,  $_body_data, $auth_settings
    );
    if ( !$response ) {
        return;
    }
    my $_response_object =
      $self->{api_client}->deserialize( 'V1JobList', $response );
    return $_response_object;
}

#
# list_namespaced_job
#
#
#
# @param string $namespace object name and auth scope, such as for teams and projects (required)
# @param boolean $include_uninitialized If true, partially initialized resources are included in the response. (optional)
# @param string $pretty If 'true', then the output is pretty printed. (optional)
# @param string $continue The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications. (optional)
# @param string $field_selector A selector to restrict the list of returned objects by their fields. Defaults to everything. (optional)
# @param string $label_selector A selector to restrict the list of returned objects by their labels. Defaults to everything. (optional)
# @param int $limit limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.  The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned. (optional)
# @param string $resource_version When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv. (optional)
# @param int $timeout_seconds Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity. (optional)
# @param boolean $watch Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion. (optional)
{
    my $params = {
        'namespace' => {
            data_type => 'string',
            description =>
              'object name and auth scope, such as for teams and projects',
            required => '1',
        },
        'include_uninitialized' => {
            data_type => 'boolean',
            description =>
'If true, partially initialized resources are included in the response.',
            required => '0',
        },
        'pretty' => {
            data_type => 'string',
            description =>
              'If 'true', then the output is pretty printed.',
            required => '0',
        },
        'continue' => {
            data_type => 'string',
            description =>
'The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".  This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.',
            required => '0',
        },
        'field_selector' => {
            data_type => 'string',
            description =>
'A selector to restrict the list of returned objects by their fields. Defaults to everything.',
            required => '0',
        },
        'label_selector' => {
            data_type => 'string',
            description =>
'A selector to restrict the list of returned objects by their labels. Defaults to everything.',
            required => '0',
        },
        'limit' => {
            data_type => 'int',
            description =>
'limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.  The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.',
            required => '0',
        },
        'resource_version' => {
            data_type => 'string',
            description =>
'When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.',
            required => '0',
        },
        'timeout_seconds' => {
            data_type => 'int',
            description =>
'Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.',
            required => '0',
        },
        'watch' => {
            data_type => 'boolean',
            description =>
'Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.',
            required => '0',
        },
    };
    __PACKAGE__->method_documentation->{'list_namespaced_job'} = {
        summary => '',
        params  => $params,
        returns => 'V1JobList',
    };
}

# @return V1JobList
#
sub list_namespaced_job {
    my ( $self, %args ) = @_;

    # verify the required parameter 'namespace' is set
    unless ( exists $args{'namespace'} ) {
        croak(
"Missing the required parameter 'namespace' when calling list_namespaced_job"
        );
    }

    # parse inputs
    my $_resource_path = '/apis/batch/v1/namespaces/{namespace}/jobs';

    my $_method       = 'GET';
    my $query_params  = {};
    my $header_params = {};
    my $form_params   = {};

    # 'Accept' and 'Content-Type' header
    my $_header_accept = $self->{api_client}->select_header_accept(
        'application/json',
        'application/yaml',
        'application/vnd.kubernetes.protobuf',
        'application/json;stream=watch',
        'application/vnd.kubernetes.protobuf;stream=watch'
    );
    if ($_header_accept) {
        $header_params->{'Accept'} = $_header_accept;
    }
    $header_params->{'Content-Type'} =
      $self->{api_client}->select_header_content_type();

    # query params
    if ( exists $args{'include_uninitialized'} ) {
        $query_params->{'includeUninitialized'} =
          $self->{api_client}->to_query_value( $args{'include_uninitialized'} );
    }

    # query params
    if ( exists $args{'pretty'} ) {
        $query_params->{'pretty'} =
          $self->{api_client}->to_query_value( $args{'pretty'} );
    }

    # query params
    if ( exists $args{'continue'} ) {
        $query_params->{'continue'} =
          $self->{api_client}->to_query_value( $args{'continue'} );
    }

    # query params
    if ( exists $args{'field_selector'} ) {
        $query_params->{'fieldSelector'} =
          $self->{api_client}->to_query_value( $args{'field_selector'} );
    }

    # query params
    if ( exists $args{'label_selector'} ) {
        $query_params->{'labelSelector'} =
          $self->{api_client}->to_query_value( $args{'label_selector'} );
    }

    # query params
    if ( exists $args{'limit'} ) {
        $query_params->{'limit'} =
          $self->{api_client}->to_query_value( $args{'limit'} );
    }

    # query params
    if ( exists $args{'resource_version'} ) {
        $query_params->{'resourceVersion'} =
          $self->{api_client}->to_query_value( $args{'resource_version'} );
    }

    # query params
    if ( exists $args{'timeout_seconds'} ) {
        $query_params->{'timeoutSeconds'} =
          $self->{api_client}->to_query_value( $args{'timeout_seconds'} );
    }

    # query params
    if ( exists $args{'watch'} ) {
        $query_params->{'watch'} =
          $self->{api_client}->to_query_value( $args{'watch'} );
    }

    # path params
    if ( exists $args{'namespace'} ) {
        my $_base_variable = "{" . "namespace" . "}";
        my $_base_value =
          $self->{api_client}->to_path_value( $args{'namespace'} );
        $_resource_path =~ s/$_base_variable/$_base_value/g;
    }

    my $_body_data;

    # authentication setting, if any
    my $auth_settings = [qw(BearerToken )];

    # make the API Call
    my $response = $self->{api_client}->call_api(
        $_resource_path, $_method,    $query_params, $form_params,
        $header_params,  $_body_data, $auth_settings
    );
    if ( !$response ) {
        return;
    }
    my $_response_object =
      $self->{api_client}->deserialize( 'V1JobList', $response );
    return $_response_object;
}

#
# patch_namespaced_job
#
#
#
# @param string $name name of the Job (required)
# @param string $namespace object name and auth scope, such as for teams and projects (required)
# @param object $body  (required)
# @param string $pretty If 'true', then the output is pretty printed. (optional)
# @param string $dry_run When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed (optional)