Struct k8s_openapi::v1_8::api::core::v1::Service

source ·
pub struct Service {
    pub api_version: Option<String>,
    pub kind: Option<String>,
    pub metadata: Option<ObjectMeta>,
    pub spec: Option<ServiceSpec>,
    pub status: Option<ServiceStatus>,
}
Expand description

Service is a named abstraction of software service (for example, mysql) consisting of local port (for example 3306) that the proxy listens on, and the selector that determines which pods will answer requests sent through the proxy.

Fields§

§api_version: Option<String>

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources

§kind: Option<String>

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds

§metadata: Option<ObjectMeta>

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata

§spec: Option<ServiceSpec>

Spec defines the behavior of a service. https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

§status: Option<ServiceStatus>

Most recently observed status of the service. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status

Implementations§

connect DELETE requests to proxy of Service

Use ConnectCoreV1DeleteNamespacedServiceProxyResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • path

    Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

connect DELETE requests to proxy of Service

Use ConnectCoreV1DeleteNamespacedServiceProxyWithPathResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • path

    path to the resource

  • path_

    Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

connect GET requests to proxy of Service

Use ConnectCoreV1GetNamespacedServiceProxyResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • path

    Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

connect GET requests to proxy of Service

Use ConnectCoreV1GetNamespacedServiceProxyWithPathResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • path

    path to the resource

  • path_

    Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

connect PATCH requests to proxy of Service

Use ConnectCoreV1PatchNamespacedServiceProxyResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • path

    Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

connect PATCH requests to proxy of Service

Use ConnectCoreV1PatchNamespacedServiceProxyWithPathResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • path

    path to the resource

  • path_

    Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

source

pub fn connect_core_v1_post_namespaced_service_proxy(
    name: &str,
    namespace: &str,
    path: Option<&str>
) -> Result<Request<Vec<u8>>, RequestError>

connect POST requests to proxy of Service

Use ConnectCoreV1PostNamespacedServiceProxyResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • path

    Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

source

pub fn connect_core_v1_post_namespaced_service_proxy_with_path(
    name: &str,
    namespace: &str,
    path: &str,
    path_: Option<&str>
) -> Result<Request<Vec<u8>>, RequestError>

connect POST requests to proxy of Service

Use ConnectCoreV1PostNamespacedServiceProxyWithPathResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • path

    path to the resource

  • path_

    Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

connect PUT requests to proxy of Service

Use ConnectCoreV1PutNamespacedServiceProxyResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • path

    Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

connect PUT requests to proxy of Service

Use ConnectCoreV1PutNamespacedServiceProxyWithPathResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • path

    path to the resource

  • path_

    Path is the part of URLs that include service endpoints, suffixes, and parameters to use for the current proxy request to service. For example, the whole request URL is http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. Path is _search?q=user:kimchy.

create a Service

Use CreateCoreV1NamespacedServiceResponse to parse the HTTP response.

Arguments
  • namespace

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

  • body

  • pretty

    If ‘true’, then the output is pretty printed.

delete a Service

Use DeleteCoreV1NamespacedServiceResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • pretty

    If ‘true’, then the output is pretty printed.

list or watch objects of kind Service

Use ListCoreV1NamespacedServiceResponse to parse the HTTP response.

Arguments
  • namespace

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

  • 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 indicating the client must restart their list without the continue field. 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.

  • field_selector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • include_uninitialized

    If true, partially initialized resources are included in the response.

  • label_selector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • 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.

  • pretty

    If ‘true’, then the output is pretty printed.

  • 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.

  • timeout_seconds

    Timeout for the list/watch call.

  • watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

list or watch objects of kind Service

Use ListCoreV1ServiceForAllNamespacesResponse to parse the HTTP response.

Arguments
  • 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 indicating the client must restart their list without the continue field. 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.

  • field_selector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • include_uninitialized

    If true, partially initialized resources are included in the response.

  • label_selector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • 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.

  • pretty

    If ‘true’, then the output is pretty printed.

  • 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.

  • timeout_seconds

    Timeout for the list/watch call.

  • watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

partially update the specified Service

Use PatchCoreV1NamespacedServiceResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • body

  • pretty

    If ‘true’, then the output is pretty printed.

partially update status of the specified Service

Use PatchCoreV1NamespacedServiceStatusResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • body

  • pretty

    If ‘true’, then the output is pretty printed.

proxy DELETE requests to Service

Use ProxyCoreV1DELETENamespacedServiceResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

proxy DELETE requests to Service

Use ProxyCoreV1DELETENamespacedServiceWithPathResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • path

    path to the resource

proxy GET requests to Service

Use ProxyCoreV1GETNamespacedServiceResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

proxy GET requests to Service

Use ProxyCoreV1GETNamespacedServiceWithPathResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • path

    path to the resource

proxy PATCH requests to Service

Use ProxyCoreV1PATCHNamespacedServiceResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

proxy PATCH requests to Service

Use ProxyCoreV1PATCHNamespacedServiceWithPathResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • path

    path to the resource

source

pub fn proxy_core_v1_post_namespaced_service(
    name: &str,
    namespace: &str
) -> Result<Request<Vec<u8>>, RequestError>

proxy POST requests to Service

Use ProxyCoreV1POSTNamespacedServiceResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

source

pub fn proxy_core_v1_post_namespaced_service_with_path(
    name: &str,
    namespace: &str,
    path: &str
) -> Result<Request<Vec<u8>>, RequestError>

proxy POST requests to Service

Use ProxyCoreV1POSTNamespacedServiceWithPathResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • path

    path to the resource

proxy PUT requests to Service

Use ProxyCoreV1PUTNamespacedServiceResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

proxy PUT requests to Service

Use ProxyCoreV1PUTNamespacedServiceWithPathResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • path

    path to the resource

read the specified Service

Use ReadCoreV1NamespacedServiceResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • exact

    Should the export be exact. Exact export maintains cluster-specific fields like ‘Namespace’.

  • export

    Should this value be exported. Export strips fields that a user can not specify.

  • pretty

    If ‘true’, then the output is pretty printed.

read status of the specified Service

Use ReadCoreV1NamespacedServiceStatusResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • pretty

    If ‘true’, then the output is pretty printed.

replace the specified Service

Use ReplaceCoreV1NamespacedServiceResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • body

  • pretty

    If ‘true’, then the output is pretty printed.

replace status of the specified Service

Use ReplaceCoreV1NamespacedServiceStatusResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • body

  • pretty

    If ‘true’, then the output is pretty printed.

watch changes to an object of kind Service

Use WatchCoreV1NamespacedServiceResponse to parse the HTTP response.

Arguments
  • name

    name of the Service

  • namespace

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

  • 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 indicating the client must restart their list without the continue field. 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.

  • field_selector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • include_uninitialized

    If true, partially initialized resources are included in the response.

  • label_selector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • 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.

  • pretty

    If ‘true’, then the output is pretty printed.

  • 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.

  • timeout_seconds

    Timeout for the list/watch call.

  • watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

watch individual changes to a list of Service

Use WatchCoreV1NamespacedServiceListResponse to parse the HTTP response.

Arguments
  • namespace

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

  • 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 indicating the client must restart their list without the continue field. 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.

  • field_selector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • include_uninitialized

    If true, partially initialized resources are included in the response.

  • label_selector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • 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.

  • pretty

    If ‘true’, then the output is pretty printed.

  • 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.

  • timeout_seconds

    Timeout for the list/watch call.

  • watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

watch individual changes to a list of Service

Use WatchCoreV1ServiceListForAllNamespacesResponse to parse the HTTP response.

Arguments
  • 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 indicating the client must restart their list without the continue field. 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.

  • field_selector

    A selector to restrict the list of returned objects by their fields. Defaults to everything.

  • include_uninitialized

    If true, partially initialized resources are included in the response.

  • label_selector

    A selector to restrict the list of returned objects by their labels. Defaults to everything.

  • 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.

  • pretty

    If ‘true’, then the output is pretty printed.

  • 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.

  • timeout_seconds

    Timeout for the list/watch call.

  • watch

    Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more
Deserialize this value from the given Serde deserializer. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.