Struct Template

pub struct Template {
    pub labels: Option<BTreeMap<String, String>>,
    pub message: Option<String>,
    pub metadata: ObjectMeta,
    pub objects: Vec<RawExtension>,
    pub parameters: Option<Vec<Parameter>>,
}

Template contains the inputs needed to produce a Config.

Fields

labels: Option<BTreeMap<String, String>>

labels is a optional set of labels that are applied to every object during the Template to Config transformation.

message: Option<String>

message is an optional instructional message that will be displayed when this template is instantiated. This field should inform the user how to utilize the newly created resources. Parameter substitution will be performed on the message before being displayed so that generated credentials and other parameters can be included in the output.

metadata: ObjectMeta

Standard object’s metadata.

objects: Vec<RawExtension>

objects is an array of resources to include in this template. If a namespace value is hardcoded in the object, it will be removed during template instantiation, however if the namespace value is, or contains, a ${PARAMETER_REFERENCE}, the resolved value after parameter substitution will be respected and the object will be created in that namespace.

parameters: Option<Vec<Parameter>>

parameters is an optional array of Parameters used during the Template to Config transformation.

Implementations

impl Template

pub fn create_namespaced_template( namespace: &str, body: &Template, optional: CreateOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<CreateResponse<Self>>), RequestError>

create a Template

Use the returned k8s_openapi::ResponseBody<k8s_openapi::CreateResponse<Self>> constructor, or k8s_openapi::CreateResponse<Self> directly, to parse the HTTP response.

Arguments

• namespace

  object name and auth scope, such as for teams and projects

• body

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Template

pub fn delete_collection_namespaced_template( namespace: &str, delete_optional: DeleteOptional<'_>, list_optional: ListOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<DeleteResponse<List<Self>>>), RequestError>

delete collection of Template

Use the returned k8s_openapi::ResponseBody<k8s_openapi::DeleteResponse<k8s_openapi::List<Self>>> constructor, or k8s_openapi::DeleteResponse<k8s_openapi::List<Self>> directly, to parse the HTTP response.

Arguments

• namespace

  object name and auth scope, such as for teams and projects

• delete_optional

  Delete options. Use Default::default() to not pass any.

• list_optional

  List options. Use Default::default() to not pass any.

impl Template

pub fn delete_namespaced_template( name: &str, namespace: &str, optional: DeleteOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<DeleteResponse<Self>>), RequestError>

delete a Template

Use the returned k8s_openapi::ResponseBody<k8s_openapi::DeleteResponse<Self>> constructor, or k8s_openapi::DeleteResponse<Self> directly, to parse the HTTP response.

Arguments

• name

  name of the Template

• namespace

  object name and auth scope, such as for teams and projects

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Template

pub fn list_namespaced_template( namespace: &str, optional: ListOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<ListResponse<Self>>), RequestError>

list or watch objects of kind Template

This operation only supports listing all items of this type.

Use the returned k8s_openapi::ResponseBody<k8s_openapi::ListResponse<Self>> constructor, or k8s_openapi::ListResponse<Self> directly, to parse the HTTP response.

Arguments

• namespace

  object name and auth scope, such as for teams and projects

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Template

pub fn list_template_for_all_namespaces( optional: ListOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<ListResponse<Self>>), RequestError>

list or watch objects of kind Template

This operation only supports listing all items of this type.

Use the returned k8s_openapi::ResponseBody<k8s_openapi::ListResponse<Self>> constructor, or k8s_openapi::ListResponse<Self> directly, to parse the HTTP response.

Arguments

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Template

pub fn patch_namespaced_template( name: &str, namespace: &str, body: &Patch, optional: PatchOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<PatchResponse<Self>>), RequestError>

partially update the specified Template

Use the returned k8s_openapi::ResponseBody<k8s_openapi::PatchResponse<Self>> constructor, or k8s_openapi::PatchResponse<Self> directly, to parse the HTTP response.

Arguments

• name

  name of the Template

• namespace

  object name and auth scope, such as for teams and projects

• body

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Template

pub fn read_namespaced_template( name: &str, namespace: &str, optional: ReadNamespacedTemplateOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<ReadNamespacedTemplateResponse>), RequestError>

read the specified Template

Use the returned k8s_openapi::ResponseBody<ReadNamespacedTemplateResponse> constructor, or ReadNamespacedTemplateResponse directly, to parse the HTTP response.

Arguments

• name

  name of the Template

• namespace

  object name and auth scope, such as for teams and projects

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Template

pub fn replace_namespaced_template( name: &str, namespace: &str, body: &Template, optional: ReplaceOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<ReplaceResponse<Self>>), RequestError>

replace the specified Template

Use the returned k8s_openapi::ResponseBody<k8s_openapi::ReplaceResponse<Self>> constructor, or k8s_openapi::ReplaceResponse<Self> directly, to parse the HTTP response.

Arguments

• name

  name of the Template

• namespace

  object name and auth scope, such as for teams and projects

• body

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Template

pub fn watch_namespaced_template( namespace: &str, optional: WatchOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<WatchResponse<Self>>), RequestError>

list or watch objects of kind Template

This operation only supports watching one item, or a list of items, of this type for changes.

Use the returned k8s_openapi::ResponseBody<k8s_openapi::WatchResponse<Self>> constructor, or k8s_openapi::WatchResponse<Self> directly, to parse the HTTP response.

Arguments

• namespace

  object name and auth scope, such as for teams and projects

• optional

  Optional parameters. Use Default::default() to not pass any.

impl Template

pub fn watch_template_for_all_namespaces( optional: WatchOptional<'_>, ) -> Result<(Request<Vec<u8>>, fn(StatusCode) -> ResponseBody<WatchResponse<Self>>), RequestError>

list or watch objects of kind Template

This operation only supports watching one item, or a list of items, of this type for changes.

Use the returned k8s_openapi::ResponseBody<k8s_openapi::WatchResponse<Self>> constructor, or k8s_openapi::WatchResponse<Self> directly, to parse the HTTP response.

Arguments

• optional

  Optional parameters. Use Default::default() to not pass any.

Trait Implementations

impl Clone for Template

fn clone(&self) -> Template

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Template

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Template

fn default() -> Template

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Template

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ListableResource for Template

const LIST_KIND: &'static str = "TemplateList"

The kind of the list type of the resource.

impl Metadata for Template

type Ty = ObjectMeta

The type of the metadata object.

fn metadata(&self) -> &<Self as Metadata>::Ty

Gets a reference to the metadata of this resource value.

fn metadata_mut(&mut self) -> &mut <Self as Metadata>::Ty

Gets a mutable reference to the metadata of this resource value.

impl PartialEq for Template

fn eq(&self, other: &Template) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Resource for Template

const API_VERSION: &'static str = "template.openshift.io/v1"

The API version of the resource. This is a composite of Resource::GROUP and Resource::VERSION (eg "apiextensions.k8s.io/v1beta1") or just the version for resources without a group (eg "v1").

const GROUP: &'static str = "template.openshift.io"

The group of the resource, or the empty string if the resource doesn’t have a group.

const KIND: &'static str = "Template"

The kind of the resource.

const VERSION: &'static str = "v1"

The version of the resource.

impl Serialize for Template

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Template