UniversityOfAdelaide\OpenShift\Batch_v1Api

All URIs are relative to https://localhost

Method	HTTP request	Description
createBatchV1JobForAllNamespaces	POST /apis/batch/v1/jobs
createBatchV1NamespacedJob	POST /apis/batch/v1/namespaces/{namespace}/jobs
deleteBatchV1CollectionNamespacedJob	DELETE /apis/batch/v1/namespaces/{namespace}/jobs
deleteBatchV1NamespacedJob	DELETE /apis/batch/v1/namespaces/{namespace}/jobs/{name}
getBatchV1APIResources	GET /apis/batch/v1/
listBatchV1JobForAllNamespaces	GET /apis/batch/v1/jobs
listBatchV1NamespacedJob	GET /apis/batch/v1/namespaces/{namespace}/jobs
patchBatchV1NamespacedJob	PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}
patchBatchV1NamespacedJobStatus	PATCH /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
readBatchV1NamespacedJob	GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}
readBatchV1NamespacedJobStatus	GET /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
replaceBatchV1NamespacedJob	PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}
replaceBatchV1NamespacedJobStatus	PUT /apis/batch/v1/namespaces/{namespace}/jobs/{name}/status
watchBatchV1JobListForAllNamespaces	GET /apis/batch/v1/watch/jobs
watchBatchV1NamespacedJob	GET /apis/batch/v1/watch/namespaces/{namespace}/jobs/{name}
watchBatchV1NamespacedJobList	GET /apis/batch/v1/watch/namespaces/{namespace}/jobs

createBatchV1JobForAllNamespaces

\UniversityOfAdelaide\OpenShift\Model\V1Job createBatchV1JobForAllNamespaces($body, $pretty)

create a Job

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());
$body = new \UniversityOfAdelaide\OpenShift\Model\V1Job(); // \UniversityOfAdelaide\OpenShift\Model\V1Job | 
$pretty = "pretty_example"; // string | If 'true', then the output is pretty printed.

try {
    $result = $api_instance->createBatchV1JobForAllNamespaces($body, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->createBatchV1JobForAllNamespaces: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\UniversityOfAdelaide\OpenShift\Model\V1Job
pretty	string	If 'true', then the output is pretty printed.	[optional]

Return type

\UniversityOfAdelaide\OpenShift\Model\V1Job

Authorization

openshift_auth

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createBatchV1NamespacedJob

\UniversityOfAdelaide\OpenShift\Model\V1Job createBatchV1NamespacedJob($namespace, $body, $pretty)

create a Job

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());
$namespace = "namespace_example"; // string | object name and auth scope, such as for teams and projects
$body = new \UniversityOfAdelaide\OpenShift\Model\V1Job(); // \UniversityOfAdelaide\OpenShift\Model\V1Job | 
$pretty = "pretty_example"; // string | If 'true', then the output is pretty printed.

try {
    $result = $api_instance->createBatchV1NamespacedJob($namespace, $body, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->createBatchV1NamespacedJob: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
namespace	string	object name and auth scope, such as for teams and projects
body	\UniversityOfAdelaide\OpenShift\Model\V1Job
pretty	string	If 'true', then the output is pretty printed.	[optional]

Return type

\UniversityOfAdelaide\OpenShift\Model\V1Job

Authorization

openshift_auth

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteBatchV1CollectionNamespacedJob

\UniversityOfAdelaide\OpenShift\Model\V1Status deleteBatchV1CollectionNamespacedJob($namespace, $pretty, $fieldSelector, $labelSelector, $resourceVersion, $timeoutSeconds, $watch)

delete collection of Job

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());
$namespace = "namespace_example"; // string | object name and auth scope, such as for teams and projects
$pretty = "pretty_example"; // string | If 'true', then the output is pretty printed.
$fieldSelector = "fieldSelector_example"; // string | A selector to restrict the list of returned objects by their fields. Defaults to everything.
$labelSelector = "labelSelector_example"; // string | A selector to restrict the list of returned objects by their labels. Defaults to everything.
$resourceVersion = "resourceVersion_example"; // string | 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.
$timeoutSeconds = 56; // int | Timeout for the list/watch call.
$watch = true; // bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

try {
    $result = $api_instance->deleteBatchV1CollectionNamespacedJob($namespace, $pretty, $fieldSelector, $labelSelector, $resourceVersion, $timeoutSeconds, $watch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->deleteBatchV1CollectionNamespacedJob: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
namespace	string	object name and auth scope, such as for teams and projects
pretty	string	If 'true', then the output is pretty printed.	[optional]
fieldSelector	string	A selector to restrict the list of returned objects by their fields. Defaults to everything.	[optional]
labelSelector	string	A selector to restrict the list of returned objects by their labels. Defaults to everything.	[optional]
resourceVersion	string	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]
timeoutSeconds	int	Timeout for the list/watch call.	[optional]
watch	bool	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	[optional]

Return type

\UniversityOfAdelaide\OpenShift\Model\V1Status

Authorization

openshift_auth

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteBatchV1NamespacedJob

\UniversityOfAdelaide\OpenShift\Model\V1Status deleteBatchV1NamespacedJob($name, $namespace, $body, $pretty, $gracePeriodSeconds, $orphanDependents, $propagationPolicy)

delete a Job

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());
$name = "name_example"; // string | name of the Job
$namespace = "namespace_example"; // string | object name and auth scope, such as for teams and projects
$body = new \UniversityOfAdelaide\OpenShift\Model\V1DeleteOptions(); // \UniversityOfAdelaide\OpenShift\Model\V1DeleteOptions | 
$pretty = "pretty_example"; // string | If 'true', then the output is pretty printed.
$gracePeriodSeconds = 56; // int | 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.
$orphanDependents = true; // bool | 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.
$propagationPolicy = "propagationPolicy_example"; // string | 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.

try {
    $result = $api_instance->deleteBatchV1NamespacedJob($name, $namespace, $body, $pretty, $gracePeriodSeconds, $orphanDependents, $propagationPolicy);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->deleteBatchV1NamespacedJob: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
name	string	name of the Job
namespace	string	object name and auth scope, such as for teams and projects
body	\UniversityOfAdelaide\OpenShift\Model\V1DeleteOptions
pretty	string	If 'true', then the output is pretty printed.	[optional]
gracePeriodSeconds	int	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]
orphanDependents	bool	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]
propagationPolicy	string	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.	[optional]

Return type

\UniversityOfAdelaide\OpenShift\Model\V1Status

Authorization

openshift_auth

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getBatchV1APIResources

\UniversityOfAdelaide\OpenShift\Model\V1APIResourceList getBatchV1APIResources()

get available resources

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());

try {
    $result = $api_instance->getBatchV1APIResources();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->getBatchV1APIResources: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

\UniversityOfAdelaide\OpenShift\Model\V1APIResourceList

Authorization

openshift_auth

HTTP request headers

Content-Type: application/json, application/yaml, application/vnd.kubernetes.protobuf
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listBatchV1JobForAllNamespaces

\UniversityOfAdelaide\OpenShift\Model\V1JobList listBatchV1JobForAllNamespaces($pretty, $fieldSelector, $labelSelector, $resourceVersion, $timeoutSeconds, $watch)

list or watch objects of kind Job

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());
$pretty = "pretty_example"; // string | If 'true', then the output is pretty printed.
$fieldSelector = "fieldSelector_example"; // string | A selector to restrict the list of returned objects by their fields. Defaults to everything.
$labelSelector = "labelSelector_example"; // string | A selector to restrict the list of returned objects by their labels. Defaults to everything.
$resourceVersion = "resourceVersion_example"; // string | 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.
$timeoutSeconds = 56; // int | Timeout for the list/watch call.
$watch = true; // bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

try {
    $result = $api_instance->listBatchV1JobForAllNamespaces($pretty, $fieldSelector, $labelSelector, $resourceVersion, $timeoutSeconds, $watch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->listBatchV1JobForAllNamespaces: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
pretty	string	If 'true', then the output is pretty printed.	[optional]
fieldSelector	string	A selector to restrict the list of returned objects by their fields. Defaults to everything.	[optional]
labelSelector	string	A selector to restrict the list of returned objects by their labels. Defaults to everything.	[optional]
resourceVersion	string	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]
timeoutSeconds	int	Timeout for the list/watch call.	[optional]
watch	bool	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	[optional]

Return type

\UniversityOfAdelaide\OpenShift\Model\V1JobList

Authorization

openshift_auth

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listBatchV1NamespacedJob

\UniversityOfAdelaide\OpenShift\Model\V1JobList listBatchV1NamespacedJob($namespace, $pretty, $fieldSelector, $labelSelector, $resourceVersion, $timeoutSeconds, $watch)

list or watch objects of kind Job

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());
$namespace = "namespace_example"; // string | object name and auth scope, such as for teams and projects
$pretty = "pretty_example"; // string | If 'true', then the output is pretty printed.
$fieldSelector = "fieldSelector_example"; // string | A selector to restrict the list of returned objects by their fields. Defaults to everything.
$labelSelector = "labelSelector_example"; // string | A selector to restrict the list of returned objects by their labels. Defaults to everything.
$resourceVersion = "resourceVersion_example"; // string | 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.
$timeoutSeconds = 56; // int | Timeout for the list/watch call.
$watch = true; // bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

try {
    $result = $api_instance->listBatchV1NamespacedJob($namespace, $pretty, $fieldSelector, $labelSelector, $resourceVersion, $timeoutSeconds, $watch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->listBatchV1NamespacedJob: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
namespace	string	object name and auth scope, such as for teams and projects
pretty	string	If 'true', then the output is pretty printed.	[optional]
fieldSelector	string	A selector to restrict the list of returned objects by their fields. Defaults to everything.	[optional]
labelSelector	string	A selector to restrict the list of returned objects by their labels. Defaults to everything.	[optional]
resourceVersion	string	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]
timeoutSeconds	int	Timeout for the list/watch call.	[optional]
watch	bool	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	[optional]

Return type

\UniversityOfAdelaide\OpenShift\Model\V1JobList

Authorization

openshift_auth

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchBatchV1NamespacedJob

\UniversityOfAdelaide\OpenShift\Model\V1Job patchBatchV1NamespacedJob($name, $namespace, $body, $pretty)

partially update the specified Job

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());
$name = "name_example"; // string | name of the Job
$namespace = "namespace_example"; // string | object name and auth scope, such as for teams and projects
$body = new \UniversityOfAdelaide\OpenShift\Model\V1Patch(); // \UniversityOfAdelaide\OpenShift\Model\V1Patch | 
$pretty = "pretty_example"; // string | If 'true', then the output is pretty printed.

try {
    $result = $api_instance->patchBatchV1NamespacedJob($name, $namespace, $body, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->patchBatchV1NamespacedJob: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
name	string	name of the Job
namespace	string	object name and auth scope, such as for teams and projects
body	\UniversityOfAdelaide\OpenShift\Model\V1Patch
pretty	string	If 'true', then the output is pretty printed.	[optional]

Return type

\UniversityOfAdelaide\OpenShift\Model\V1Job

Authorization

openshift_auth

HTTP request headers

Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patchBatchV1NamespacedJobStatus

\UniversityOfAdelaide\OpenShift\Model\V1Job patchBatchV1NamespacedJobStatus($name, $namespace, $body, $pretty)

partially update status of the specified Job

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());
$name = "name_example"; // string | name of the Job
$namespace = "namespace_example"; // string | object name and auth scope, such as for teams and projects
$body = new \UniversityOfAdelaide\OpenShift\Model\V1Patch(); // \UniversityOfAdelaide\OpenShift\Model\V1Patch | 
$pretty = "pretty_example"; // string | If 'true', then the output is pretty printed.

try {
    $result = $api_instance->patchBatchV1NamespacedJobStatus($name, $namespace, $body, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->patchBatchV1NamespacedJobStatus: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
name	string	name of the Job
namespace	string	object name and auth scope, such as for teams and projects
body	\UniversityOfAdelaide\OpenShift\Model\V1Patch
pretty	string	If 'true', then the output is pretty printed.	[optional]

Return type

\UniversityOfAdelaide\OpenShift\Model\V1Job

Authorization

openshift_auth

HTTP request headers

Content-Type: application/json-patch+json, application/merge-patch+json, application/strategic-merge-patch+json
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

readBatchV1NamespacedJob

\UniversityOfAdelaide\OpenShift\Model\V1Job readBatchV1NamespacedJob($name, $namespace, $pretty, $exact, $export)

read the specified Job

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());
$name = "name_example"; // string | name of the Job
$namespace = "namespace_example"; // string | object name and auth scope, such as for teams and projects
$pretty = "pretty_example"; // string | If 'true', then the output is pretty printed.
$exact = true; // bool | Should the export be exact.  Exact export maintains cluster-specific fields like 'Namespace'.
$export = true; // bool | Should this value be exported.  Export strips fields that a user can not specify.

try {
    $result = $api_instance->readBatchV1NamespacedJob($name, $namespace, $pretty, $exact, $export);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->readBatchV1NamespacedJob: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
name	string	name of the Job
namespace	string	object name and auth scope, such as for teams and projects
pretty	string	If 'true', then the output is pretty printed.	[optional]
exact	bool	Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.	[optional]
export	bool	Should this value be exported. Export strips fields that a user can not specify.	[optional]

Return type

\UniversityOfAdelaide\OpenShift\Model\V1Job

Authorization

openshift_auth

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

readBatchV1NamespacedJobStatus

\UniversityOfAdelaide\OpenShift\Model\V1Job readBatchV1NamespacedJobStatus($name, $namespace, $pretty)

read status of the specified Job

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());
$name = "name_example"; // string | name of the Job
$namespace = "namespace_example"; // string | object name and auth scope, such as for teams and projects
$pretty = "pretty_example"; // string | If 'true', then the output is pretty printed.

try {
    $result = $api_instance->readBatchV1NamespacedJobStatus($name, $namespace, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->readBatchV1NamespacedJobStatus: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
name	string	name of the Job
namespace	string	object name and auth scope, such as for teams and projects
pretty	string	If 'true', then the output is pretty printed.	[optional]

Return type

\UniversityOfAdelaide\OpenShift\Model\V1Job

Authorization

openshift_auth

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

replaceBatchV1NamespacedJob

\UniversityOfAdelaide\OpenShift\Model\V1Job replaceBatchV1NamespacedJob($name, $namespace, $body, $pretty)

replace the specified Job

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());
$name = "name_example"; // string | name of the Job
$namespace = "namespace_example"; // string | object name and auth scope, such as for teams and projects
$body = new \UniversityOfAdelaide\OpenShift\Model\V1Job(); // \UniversityOfAdelaide\OpenShift\Model\V1Job | 
$pretty = "pretty_example"; // string | If 'true', then the output is pretty printed.

try {
    $result = $api_instance->replaceBatchV1NamespacedJob($name, $namespace, $body, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->replaceBatchV1NamespacedJob: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
name	string	name of the Job
namespace	string	object name and auth scope, such as for teams and projects
body	\UniversityOfAdelaide\OpenShift\Model\V1Job
pretty	string	If 'true', then the output is pretty printed.	[optional]

Return type

\UniversityOfAdelaide\OpenShift\Model\V1Job

Authorization

openshift_auth

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

replaceBatchV1NamespacedJobStatus

\UniversityOfAdelaide\OpenShift\Model\V1Job replaceBatchV1NamespacedJobStatus($name, $namespace, $body, $pretty)

replace status of the specified Job

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());
$name = "name_example"; // string | name of the Job
$namespace = "namespace_example"; // string | object name and auth scope, such as for teams and projects
$body = new \UniversityOfAdelaide\OpenShift\Model\V1Job(); // \UniversityOfAdelaide\OpenShift\Model\V1Job | 
$pretty = "pretty_example"; // string | If 'true', then the output is pretty printed.

try {
    $result = $api_instance->replaceBatchV1NamespacedJobStatus($name, $namespace, $body, $pretty);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->replaceBatchV1NamespacedJobStatus: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
name	string	name of the Job
namespace	string	object name and auth scope, such as for teams and projects
body	\UniversityOfAdelaide\OpenShift\Model\V1Job
pretty	string	If 'true', then the output is pretty printed.	[optional]

Return type

\UniversityOfAdelaide\OpenShift\Model\V1Job

Authorization

openshift_auth

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

watchBatchV1JobListForAllNamespaces

\UniversityOfAdelaide\OpenShift\Model\V1WatchEvent watchBatchV1JobListForAllNamespaces($fieldSelector, $labelSelector, $pretty, $resourceVersion, $timeoutSeconds, $watch)

watch individual changes to a list of Job

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());
$fieldSelector = "fieldSelector_example"; // string | A selector to restrict the list of returned objects by their fields. Defaults to everything.
$labelSelector = "labelSelector_example"; // string | A selector to restrict the list of returned objects by their labels. Defaults to everything.
$pretty = "pretty_example"; // string | If 'true', then the output is pretty printed.
$resourceVersion = "resourceVersion_example"; // string | 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.
$timeoutSeconds = 56; // int | Timeout for the list/watch call.
$watch = true; // bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

try {
    $result = $api_instance->watchBatchV1JobListForAllNamespaces($fieldSelector, $labelSelector, $pretty, $resourceVersion, $timeoutSeconds, $watch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->watchBatchV1JobListForAllNamespaces: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
fieldSelector	string	A selector to restrict the list of returned objects by their fields. Defaults to everything.	[optional]
labelSelector	string	A selector to restrict the list of returned objects by their labels. Defaults to everything.	[optional]
pretty	string	If 'true', then the output is pretty printed.	[optional]
resourceVersion	string	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]
timeoutSeconds	int	Timeout for the list/watch call.	[optional]
watch	bool	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	[optional]

Return type

\UniversityOfAdelaide\OpenShift\Model\V1WatchEvent

Authorization

openshift_auth

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

watchBatchV1NamespacedJob

\UniversityOfAdelaide\OpenShift\Model\V1WatchEvent watchBatchV1NamespacedJob($name, $namespace, $fieldSelector, $labelSelector, $pretty, $resourceVersion, $timeoutSeconds, $watch)

watch changes to an object of kind Job

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());
$name = "name_example"; // string | name of the Job
$namespace = "namespace_example"; // string | object name and auth scope, such as for teams and projects
$fieldSelector = "fieldSelector_example"; // string | A selector to restrict the list of returned objects by their fields. Defaults to everything.
$labelSelector = "labelSelector_example"; // string | A selector to restrict the list of returned objects by their labels. Defaults to everything.
$pretty = "pretty_example"; // string | If 'true', then the output is pretty printed.
$resourceVersion = "resourceVersion_example"; // string | 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.
$timeoutSeconds = 56; // int | Timeout for the list/watch call.
$watch = true; // bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

try {
    $result = $api_instance->watchBatchV1NamespacedJob($name, $namespace, $fieldSelector, $labelSelector, $pretty, $resourceVersion, $timeoutSeconds, $watch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->watchBatchV1NamespacedJob: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
name	string	name of the Job
namespace	string	object name and auth scope, such as for teams and projects
fieldSelector	string	A selector to restrict the list of returned objects by their fields. Defaults to everything.	[optional]
labelSelector	string	A selector to restrict the list of returned objects by their labels. Defaults to everything.	[optional]
pretty	string	If 'true', then the output is pretty printed.	[optional]
resourceVersion	string	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]
timeoutSeconds	int	Timeout for the list/watch call.	[optional]
watch	bool	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	[optional]

Return type

\UniversityOfAdelaide\OpenShift\Model\V1WatchEvent

Authorization

openshift_auth

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

watchBatchV1NamespacedJobList

\UniversityOfAdelaide\OpenShift\Model\V1WatchEvent watchBatchV1NamespacedJobList($namespace, $fieldSelector, $labelSelector, $pretty, $resourceVersion, $timeoutSeconds, $watch)

watch individual changes to a list of Job

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: openshift_auth
UniversityOfAdelaide\OpenShift\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new UniversityOfAdelaide\OpenShift\Api\Batch_v1Api(new \Http\Adapter\Guzzle6\Client());
$namespace = "namespace_example"; // string | object name and auth scope, such as for teams and projects
$fieldSelector = "fieldSelector_example"; // string | A selector to restrict the list of returned objects by their fields. Defaults to everything.
$labelSelector = "labelSelector_example"; // string | A selector to restrict the list of returned objects by their labels. Defaults to everything.
$pretty = "pretty_example"; // string | If 'true', then the output is pretty printed.
$resourceVersion = "resourceVersion_example"; // string | 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.
$timeoutSeconds = 56; // int | Timeout for the list/watch call.
$watch = true; // bool | Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

try {
    $result = $api_instance->watchBatchV1NamespacedJobList($namespace, $fieldSelector, $labelSelector, $pretty, $resourceVersion, $timeoutSeconds, $watch);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Batch_v1Api->watchBatchV1NamespacedJobList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
namespace	string	object name and auth scope, such as for teams and projects
fieldSelector	string	A selector to restrict the list of returned objects by their fields. Defaults to everything.	[optional]
labelSelector	string	A selector to restrict the list of returned objects by their labels. Defaults to everything.	[optional]
pretty	string	If 'true', then the output is pretty printed.	[optional]
resourceVersion	string	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]
timeoutSeconds	int	Timeout for the list/watch call.	[optional]
watch	bool	Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.	[optional]

Return type

\UniversityOfAdelaide\OpenShift\Model\V1WatchEvent

Authorization

openshift_auth

HTTP request headers

Content-Type: /
Accept: application/json, application/yaml, application/vnd.kubernetes.protobuf, application/json;stream=watch, application/vnd.kubernetes.protobuf;stream=watch

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

Batch_v1Api.md

Latest commit

History

Batch_v1Api.md

File metadata and controls

UniversityOfAdelaide\OpenShift\Batch_v1Api

createBatchV1JobForAllNamespaces

Example

Parameters

Return type

Authorization

HTTP request headers

createBatchV1NamespacedJob

Example

Parameters

Return type

Authorization

HTTP request headers

deleteBatchV1CollectionNamespacedJob

Example

Parameters

Return type

Authorization

HTTP request headers

deleteBatchV1NamespacedJob

Example

Parameters

Return type

Authorization

HTTP request headers

getBatchV1APIResources

Example

Parameters

Return type

Authorization

HTTP request headers

listBatchV1JobForAllNamespaces

Example

Parameters

Return type

Authorization

HTTP request headers

listBatchV1NamespacedJob

Example

Parameters

Return type

Authorization

HTTP request headers

patchBatchV1NamespacedJob

Example

Parameters

Return type

Authorization

HTTP request headers

patchBatchV1NamespacedJobStatus

Example

Parameters

Return type

Authorization

HTTP request headers

readBatchV1NamespacedJob

Example

Parameters

Return type

Authorization

HTTP request headers

readBatchV1NamespacedJobStatus

Example

Parameters

Return type

Authorization

HTTP request headers

replaceBatchV1NamespacedJob

Example

Parameters

Return type

Authorization

HTTP request headers

replaceBatchV1NamespacedJobStatus