Refresh Tekton Python SDK

tektoncd · Aug 17, 2021 · eddc3ed · eddc3ed
1 parent e3477cc
commit eddc3ed
Show file tree

Hide file tree

Showing 218 changed files with 1,560 additions and 353 deletions.
diff --git a/sdk/hack/boilerplate.python.txt b/sdk/hack/boilerplate.python.txt
@@ -1,4 +1,4 @@
-# Copyright 2020 The Tekton Authors
+# Copyright 2021 The Tekton Authors
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/sdk/hack/sdk-gen.sh b/sdk/hack/sdk-gen.sh
@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# Copyright 2020 The Tekton Authors
+# Copyright 2021 The Tekton Authors
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

diff --git a/sdk/python/README.md b/sdk/python/README.md
@@ -71,6 +71,7 @@ Class | Method | Description
  - [V1beta1PipelineRunConditionCheckStatus](docs/V1beta1PipelineRunConditionCheckStatus.md)
  - [V1beta1PipelineRunList](docs/V1beta1PipelineRunList.md)
  - [V1beta1PipelineRunResult](docs/V1beta1PipelineRunResult.md)
+ - [V1beta1PipelineRunRunStatus](docs/V1beta1PipelineRunRunStatus.md)
  - [V1beta1PipelineRunSpec](docs/V1beta1PipelineRunSpec.md)
  - [V1beta1PipelineRunSpecServiceAccountName](docs/V1beta1PipelineRunSpecServiceAccountName.md)
  - [V1beta1PipelineRunStatus](docs/V1beta1PipelineRunStatus.md)
@@ -85,6 +86,7 @@ Class | Method | Description
  - [V1beta1PipelineTaskParam](docs/V1beta1PipelineTaskParam.md)
  - [V1beta1PipelineTaskResources](docs/V1beta1PipelineTaskResources.md)
  - [V1beta1PipelineTaskRun](docs/V1beta1PipelineTaskRun.md)
+ - [V1beta1TaskRunDebug](docs/V1beta1TaskRunDebug.md)
  - [V1beta1PipelineTaskRunSpec](docs/V1beta1PipelineTaskRunSpec.md)
  - [V1beta1PipelineWorkspaceDeclaration](docs/V1beta1PipelineWorkspaceDeclaration.md)
  - [V1beta1ResultRef](docs/V1beta1ResultRef.md)
@@ -110,9 +112,9 @@ Class | Method | Description
  - [V1beta1TaskRunStatus](docs/V1beta1TaskRunStatus.md)
  - [V1beta1TaskRunStatusFields](docs/V1beta1TaskRunStatusFields.md)
  - [V1beta1TaskSpec](docs/V1beta1TaskSpec.md)
+ - [V1beta1TimeoutFields](docs/V1beta1TimeoutFields.md)
  - [V1beta1WhenExpression](docs/V1beta1WhenExpression.md)
  - [V1beta1WorkspaceBinding](docs/V1beta1WorkspaceBinding.md)
  - [V1beta1WorkspaceDeclaration](docs/V1beta1WorkspaceDeclaration.md)
  - [V1beta1WorkspacePipelineTaskBinding](docs/V1beta1WorkspacePipelineTaskBinding.md)
 
-
diff --git a/sdk/python/docs/PodTemplate.md b/sdk/python/docs/PodTemplate.md
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **dns_config** | [**V1PodDNSConfig**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1PodDNSConfig.md) |  | [optional] 
 **dns_policy** | **str** | Set DNS policy for the pod. Defaults to \&quot;ClusterFirst\&quot;. Valid values are &#39;ClusterFirst&#39;, &#39;Default&#39; or &#39;None&#39;. DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. | [optional] 
 **enable_service_links** | **bool** | EnableServiceLinks indicates whether information about services should be injected into pod&#39;s environment variables, matching the syntax of Docker links. Optional: Defaults to true. | [optional] 
+**host_aliases** | [**list[V1HostAlias]**](V1HostAlias.md) | HostAliases is an optional list of hosts and IPs that will be injected into the pod&#39;s hosts file if specified. This is only valid for non-hostNetwork pods. | [optional] 
 **host_network** | **bool** | HostNetwork specifies whether the pod may use the node network namespace | [optional] 
 **image_pull_secrets** | [**list[V1LocalObjectReference]**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1LocalObjectReference.md) | ImagePullSecrets gives the name of the secret used by the pod to pull the image if specified | [optional] 
 **node_selector** | **dict(str, str)** | NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node&#39;s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ | [optional] 

diff --git a/sdk/python/docs/V1alpha1PipelineResourceSpec.md b/sdk/python/docs/V1alpha1PipelineResourceSpec.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **description** | **str** | Description is a user-facing description of the resource that may be used to populate a UI. | [optional] 
 **params** | [**list[V1alpha1ResourceParam]**](V1alpha1ResourceParam.md) |  | 
 **secrets** | [**list[V1alpha1SecretParam]**](V1alpha1SecretParam.md) | Secrets to fetch to populate some of resource fields | [optional] 
-**type** | **str** |  | 
+**type** | **str** |  | [default to '']
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/sdk/python/docs/V1alpha1ResourceDeclaration.md b/sdk/python/docs/V1alpha1ResourceDeclaration.md
@@ -5,10 +5,10 @@ ResourceDeclaration defines an input or output PipelineResource declared as a re
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **description** | **str** | Description is a user-facing description of the declared resource that may be used to populate a UI. | [optional] 
-**name** | **str** | Name declares the name by which a resource is referenced in the definition. Resources may be referenced by name in the definition of a Task&#39;s steps. | 
+**name** | **str** | Name declares the name by which a resource is referenced in the definition. Resources may be referenced by name in the definition of a Task&#39;s steps. | [default to '']
 **optional** | **bool** | Optional declares the resource as optional. By default optional is set to false which makes a resource required. optional: true - the resource is considered optional optional: false - the resource is considered required (equivalent of not specifying it) | [optional] 
 **target_path** | **str** | TargetPath is the path in workspace directory where the resource will be copied. | [optional] 
-**type** | **str** | Type is the type of this resource; | 
+**type** | **str** | Type is the type of this resource; | [default to '']
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/sdk/python/docs/V1alpha1ResourceParam.md b/sdk/python/docs/V1alpha1ResourceParam.md
@@ -4,8 +4,8 @@ ResourceParam declares a string value to use for the parameter called Name, and
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **str** |  | 
-**value** | **str** |  | 
+**name** | **str** |  | [default to '']
+**value** | **str** |  | [default to '']
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/sdk/python/docs/V1alpha1SecretParam.md b/sdk/python/docs/V1alpha1SecretParam.md
@@ -4,9 +4,9 @@ SecretParam indicates which secret can be used to populate a field of the resour
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**field_name** | **str** |  | 
-**secret_key** | **str** |  | 
-**secret_name** | **str** |  | 
+**field_name** | **str** |  | [default to '']
+**secret_key** | **str** |  | [default to '']
+**secret_name** | **str** |  | [default to '']
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/sdk/python/docs/V1beta1ArrayOrString.md b/sdk/python/docs/V1beta1ArrayOrString.md
@@ -5,8 +5,8 @@ ArrayOrString is a type that can hold a single string or string array. Used in J
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **array_val** | **list[str]** |  | 
-**string_val** | **str** | Represents the stored type of ArrayOrString. | 
-**type** | **str** |  | 
+**string_val** | **str** | Represents the stored type of ArrayOrString. | [default to '']
+**type** | **str** |  | [default to '']
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/sdk/python/docs/V1beta1CannotConvertError.md b/sdk/python/docs/V1beta1CannotConvertError.md
@@ -4,8 +4,8 @@ CannotConvertError is returned when a field cannot be converted.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**field** | **str** |  | 
-**message** | **str** |  | 
+**field** | **str** |  | [default to '']
+**message** | **str** |  | [default to '']
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/sdk/python/docs/V1beta1CloudEventDeliveryState.md b/sdk/python/docs/V1beta1CloudEventDeliveryState.md
@@ -5,8 +5,8 @@ CloudEventDeliveryState reports the state of a cloud event to be sent.
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **condition** | **str** | Current status | [optional] 
-**message** | **str** | Error is the text of error (if any) | 
-**retry_count** | **int** | RetryCount is the number of attempts of sending the cloud event | 
+**message** | **str** | Error is the text of error (if any) | [default to '']
+**retry_count** | **int** | RetryCount is the number of attempts of sending the cloud event | [default to 0]
 **sent_at** | [**V1Time**](V1Time.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/sdk/python/docs/V1beta1ConditionCheckStatus.md b/sdk/python/docs/V1beta1ConditionCheckStatus.md
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **completion_time** | [**V1Time**](V1Time.md) |  | [optional] 
 **conditions** | [**list[KnativeCondition]**](KnativeCondition.md) | Conditions the latest available observations of a resource&#39;s current state. | [optional] 
 **observed_generation** | **int** | ObservedGeneration is the &#39;Generation&#39; of the Service that was last processed by the controller. | [optional] 
-**pod_name** | **str** | PodName is the name of the pod responsible for executing this condition check. | 
+**pod_name** | **str** | PodName is the name of the pod responsible for executing this condition check. | [default to '']
 **start_time** | [**V1Time**](V1Time.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/sdk/python/docs/V1beta1ConditionCheckStatusFields.md b/sdk/python/docs/V1beta1ConditionCheckStatusFields.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **check** | [**V1ContainerState**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1ContainerState.md) |  | [optional] 
 **completion_time** | [**V1Time**](V1Time.md) |  | [optional] 
-**pod_name** | **str** | PodName is the name of the pod responsible for executing this condition check. | 
+**pod_name** | **str** | PodName is the name of the pod responsible for executing this condition check. | [default to '']
 **start_time** | [**V1Time**](V1Time.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/sdk/python/docs/V1beta1EmbeddedTask.md b/sdk/python/docs/V1beta1EmbeddedTask.md
@@ -3,12 +3,15 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**api_version** | **str** |  | [optional] 
 **description** | **str** | Description is a user-facing description of the task that may be used to populate a UI. | [optional] 
+**kind** | **str** |  | [optional] 
 **metadata** | [**V1beta1PipelineTaskMetadata**](V1beta1PipelineTaskMetadata.md) |  | [optional] 
 **params** | [**list[V1beta1ParamSpec]**](V1beta1ParamSpec.md) | Params is a list of input parameters required to run the task. Params must be supplied as inputs in TaskRuns unless they declare a default value. | [optional] 
 **resources** | [**V1beta1TaskResources**](V1beta1TaskResources.md) |  | [optional] 
 **results** | [**list[V1beta1TaskResult]**](V1beta1TaskResult.md) | Results are values that this Task can output | [optional] 
 **sidecars** | [**list[V1beta1Sidecar]**](V1beta1Sidecar.md) | Sidecars are run alongside the Task&#39;s step containers. They begin before the steps start and end after the steps complete. | [optional] 
+**spec** | [**K8sIoApimachineryPkgRuntimeRawExtension**](K8sIoApimachineryPkgRuntimeRawExtension.md) |  | [optional] 
 **step_template** | [**V1Container**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1Container.md) |  | [optional] 
 **steps** | [**list[V1beta1Step]**](V1beta1Step.md) | Steps are the steps of the build; each step is run sequentially with the source mounted into /workspace. | [optional] 
 **volumes** | [**list[V1Volume]**](https://github.com/kubernetes-client/python/blob/master/kubernetes/docs/V1Volume.md) | Volumes is a collection of volumes that are available to mount into the steps of the build. | [optional] 

diff --git a/sdk/python/docs/V1beta1Param.md b/sdk/python/docs/V1beta1Param.md
@@ -4,7 +4,7 @@ Param declares an ArrayOrString to use for the parameter called name.
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **str** |  | 
+**name** | **str** |  | [default to '']
 **value** | [**V1beta1ArrayOrString**](V1beta1ArrayOrString.md) |  | 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/sdk/python/docs/V1beta1ParamSpec.md b/sdk/python/docs/V1beta1ParamSpec.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **default** | [**V1beta1ArrayOrString**](V1beta1ArrayOrString.md) |  | [optional] 
 **description** | **str** | Description is a user-facing description of the parameter that may be used to populate a UI. | [optional] 
-**name** | **str** | Name declares the name by which a parameter is referenced. | 
+**name** | **str** | Name declares the name by which a parameter is referenced. | [default to '']
 **type** | **str** | Type is the user-specified type of the parameter. The possible types are currently \&quot;string\&quot; and \&quot;array\&quot;, and \&quot;string\&quot; is the default. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/sdk/python/docs/V1beta1PipelineDeclaredResource.md b/sdk/python/docs/V1beta1PipelineDeclaredResource.md
@@ -4,9 +4,9 @@ PipelineDeclaredResource is used by a Pipeline to declare the types of the Pipel
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **str** | Name is the name that will be used by the Pipeline to refer to this resource. It does not directly correspond to the name of any PipelineResources Task inputs or outputs, and it does not correspond to the actual names of the PipelineResources that will be bound in the PipelineRun. | 
+**name** | **str** | Name is the name that will be used by the Pipeline to refer to this resource. It does not directly correspond to the name of any PipelineResources Task inputs or outputs, and it does not correspond to the actual names of the PipelineResources that will be bound in the PipelineRun. | [default to '']
 **optional** | **bool** | Optional declares the resource as optional. optional: true - the resource is considered optional optional: false - the resource is considered required (default/equivalent of not specifying it) | [optional] 
-**type** | **str** | Type is the type of the PipelineResource. | 
+**type** | **str** | Type is the type of the PipelineResource. | [default to '']
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/sdk/python/docs/V1beta1PipelineResourceResult.md b/sdk/python/docs/V1beta1PipelineResourceResult.md
@@ -4,11 +4,11 @@ PipelineResourceResult used to export the image name and digest as json
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**key** | **str** |  | 
+**key** | **str** |  | [default to '']
 **resource_name** | **str** |  | [optional] 
 **resource_ref** | [**V1beta1PipelineResourceRef**](V1beta1PipelineResourceRef.md) |  | [optional] 
 **type** | **str** |  | [optional] 
-**value** | **str** |  | 
+**value** | **str** |  | [default to '']
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/sdk/python/docs/V1beta1PipelineResult.md b/sdk/python/docs/V1beta1PipelineResult.md
@@ -4,9 +4,9 @@ PipelineResult used to describe the results of a pipeline
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**description** | **str** | Description is a human-readable description of the result | [optional] 
-**name** | **str** | Name the given name | 
-**value** | **str** | Value the expression used to retrieve the value | 
+**description** | **str** | Description is a human-readable description of the result | [optional] [default to '']
+**name** | **str** | Name the given name | [default to '']
+**value** | **str** | Value the expression used to retrieve the value | [default to '']
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/sdk/python/docs/V1beta1PipelineRunResult.md b/sdk/python/docs/V1beta1PipelineRunResult.md
@@ -4,8 +4,8 @@ PipelineRunResult used to describe the results of a pipeline
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **str** | Name is the result&#39;s name as declared by the Pipeline | 
-**value** | **str** | Value is the result returned from the execution of this PipelineRun | 
+**name** | **str** | Name is the result&#39;s name as declared by the Pipeline | [default to '']
+**value** | **str** | Value is the result returned from the execution of this PipelineRun | [default to '']
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

diff --git a/sdk/python/docs/V1beta1PipelineRunRunStatus.md b/sdk/python/docs/V1beta1PipelineRunRunStatus.md
@@ -0,0 +1,13 @@
+# V1beta1PipelineRunRunStatus
+
+PipelineRunRunStatus contains the name of the PipelineTask for this Run and the Run's Status
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pipeline_task_name** | **str** | PipelineTaskName is the name of the PipelineTask. | [optional] 
+**status** | [**GithubComTektoncdPipelinePkgApisRunV1alpha1RunStatus**](GithubComTektoncdPipelinePkgApisRunV1alpha1RunStatus.md) |  | [optional] 
+**when_expressions** | [**list[V1beta1WhenExpression]**](V1beta1WhenExpression.md) | WhenExpressions is the list of checks guarding the execution of the PipelineTask | [optional] 
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+
diff --git a/sdk/python/docs/V1beta1PipelineRunSpec.md b/sdk/python/docs/V1beta1PipelineRunSpec.md
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **status** | **str** | Used for cancelling a pipelinerun (and maybe more later on) | [optional] 
 **task_run_specs** | [**list[V1beta1PipelineTaskRunSpec]**](V1beta1PipelineTaskRunSpec.md) | TaskRunSpecs holds a set of runtime specs | [optional] 
 **timeout** | [**V1Duration**](V1Duration.md) |  | [optional] 
+**timeouts** | [**V1beta1TimeoutFields**](V1beta1TimeoutFields.md) |  | [optional] 
 **workspaces** | [**list[V1beta1WorkspaceBinding]**](V1beta1WorkspaceBinding.md) | Workspaces holds a set of workspace bindings that must match names with those declared in the pipeline. | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

diff --git a/sdk/python/docs/V1beta1PipelineRunStatus.md b/sdk/python/docs/V1beta1PipelineRunStatus.md
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **observed_generation** | **int** | ObservedGeneration is the &#39;Generation&#39; of the Service that was last processed by the controller. | [optional] 
 **pipeline_results** | [**list[V1beta1PipelineRunResult]**](V1beta1PipelineRunResult.md) | PipelineResults are the list of results written out by the pipeline task&#39;s containers | [optional] 
 **pipeline_spec** | [**V1beta1PipelineSpec**](V1beta1PipelineSpec.md) |  | [optional] 
+**runs** | [**dict(str, V1beta1PipelineRunRunStatus)**](V1beta1PipelineRunRunStatus.md) | map of PipelineRunRunStatus with the run name as the key | [optional] 
 **skipped_tasks** | [**list[V1beta1SkippedTask]**](V1beta1SkippedTask.md) | list of tasks that were skipped due to when expressions evaluating to false | [optional] 
 **start_time** | [**V1Time**](V1Time.md) |  | [optional] 
 **task_runs** | [**dict(str, V1beta1PipelineRunTaskRunStatus)**](V1beta1PipelineRunTaskRunStatus.md) | map of PipelineRunTaskRunStatus with the taskRun name as the key | [optional]