LifecycleApi.md

nexus_api_python_client.LifecycleApi

All URIs are relative to http://localhost/service/rest

Method	HTTP request	Description
bounce	PUT /v1/lifecycle/bounce	Bounce lifecycle phase
get_phase	GET /v1/lifecycle/phase	Get current lifecycle phase
set_phase	PUT /v1/lifecycle/phase	Move to new lifecycle phase

bounce

bounce(body=body)

Bounce lifecycle phase

Re-runs all phases from the given phase to the current phase

Example

from __future__ import print_function
import time
import nexus_api_python_client
from nexus_api_python_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with nexus_api_python_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = nexus_api_python_client.LifecycleApi(api_client)
    body = 'body_example' # str | The phase to bounce (optional)

    try:
        # Bounce lifecycle phase
        api_instance.bounce(body=body)
    except ApiException as e:
        print("Exception when calling LifecycleApi->bounce: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	str	The phase to bounce	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: text/plain
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
0	successful operation	-

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

get_phase

str get_phase()

Get current lifecycle phase

Example

from __future__ import print_function
import time
import nexus_api_python_client
from nexus_api_python_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with nexus_api_python_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = nexus_api_python_client.LifecycleApi(api_client)
    
    try:
        # Get current lifecycle phase
        api_response = api_instance.get_phase()
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling LifecycleApi->get_phase: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain

HTTP response details

Status code	Description	Response headers
200	successful operation	-

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

set_phase

set_phase(body=body)

Move to new lifecycle phase

Example

from __future__ import print_function
import time
import nexus_api_python_client
from nexus_api_python_client.rest import ApiException
from pprint import pprint

# Enter a context with an instance of the API client
with nexus_api_python_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = nexus_api_python_client.LifecycleApi(api_client)
    body = 'body_example' # str | The phase to move to (optional)

    try:
        # Move to new lifecycle phase
        api_instance.set_phase(body=body)
    except ApiException as e:
        print("Exception when calling LifecycleApi->set_phase: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	str	The phase to move to	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: text/plain
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
0	successful operation	-

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