signadot_sdk.models package

Submodules

signadot_sdk.models.cluster module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.cluster.Cluster(created_at=None, name=None, operator=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'created_at': 'createdAt', 'name': 'name', 'operator': 'operator'}

property created_at

Gets the created_at of this Cluster. # noqa: E501

The time when this cluster was registered with Signadot. # noqa: E501

Returns:

The created_at of this Cluster. # noqa: E501

Return type:

str

property name

Gets the name of this Cluster. # noqa: E501

The name of the cluster. # noqa: E501

Returns:

The name of this Cluster. # noqa: E501

Return type:

str

property operator

Gets the operator of this Cluster. # noqa: E501

Returns:

The operator of this Cluster. # noqa: E501

Return type:

ClusterOperator

swagger_types = {'created_at': 'str', 'name': 'str', 'operator': 'ClusterOperator'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.cluster_operator module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.cluster_operator.ClusterOperator(version=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'version': 'version'}

swagger_types = {'version': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this ClusterOperator. # noqa: E501

The operator version of the cluster. This may be nil if the cluster has not yet connected to Signadot. # noqa: E501

Returns:

The version of this ClusterOperator. # noqa: E501

Return type:

str

signadot_sdk.models.cluster_token module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.cluster_token.ClusterToken(created_at=None, id=None, masked_value=None, status=None, token=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'created_at': 'createdAt', 'id': 'id', 'masked_value': 'maskedValue', 'status': 'status', 'token': 'token'}

property created_at

Gets the created_at of this ClusterToken. # noqa: E501

The time when this cluster was registered with Signadot. # noqa: E501

Returns:

The created_at of this ClusterToken. # noqa: E501

Return type:

str

property id

Gets the id of this ClusterToken. # noqa: E501

The ID of this token # noqa: E501

Returns:

The id of this ClusterToken. # noqa: E501

Return type:

str

property masked_value

Gets the masked_value of this ClusterToken. # noqa: E501

A Masked token value. # noqa: E501

Returns:

The masked_value of this ClusterToken. # noqa: E501

Return type:

str

property status

Gets the status of this ClusterToken. # noqa: E501

Returns:

The status of this ClusterToken. # noqa: E501

Return type:

ClusterTokenStatus

swagger_types = {'created_at': 'str', 'id': 'str', 'masked_value': 'str', 'status': 'ClusterTokenStatus', 'token': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property token

Gets the token of this ClusterToken. # noqa: E501

The token value. # noqa: E501

Returns:

The token of this ClusterToken. # noqa: E501

Return type:

str

signadot_sdk.models.cluster_token_status module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.cluster_token_status.ClusterTokenStatus(last_connected_at=None, last_connected_ip=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'last_connected_at': 'lastConnectedAt', 'last_connected_ip': 'lastConnectedIp'}

property last_connected_at

Gets the last_connected_at of this ClusterTokenStatus. # noqa: E501

The last time at which this token was used to connect. # noqa: E501

Returns:

The last_connected_at of this ClusterTokenStatus. # noqa: E501

Return type:

str

property last_connected_ip

Gets the last_connected_ip of this ClusterTokenStatus. # noqa: E501

The last IP address from which this token connected. # noqa: E501

Returns:

The last_connected_ip of this ClusterTokenStatus. # noqa: E501

Return type:

str

swagger_types = {'last_connected_at': 'str', 'last_connected_ip': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.empty_response module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.empty_response.EmptyResponse(_configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {}

swagger_types = {}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.error_response module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.error_response.ErrorResponse(error=None, request_id=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'error': 'error', 'request_id': 'requestId'}

property error

Gets the error of this ErrorResponse. # noqa: E501

Returns:

The error of this ErrorResponse. # noqa: E501

Return type:

str

property request_id

Gets the request_id of this ErrorResponse. # noqa: E501

Returns:

The request_id of this ErrorResponse. # noqa: E501

Return type:

str

swagger_types = {'error': 'str', 'request_id': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.route_group module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.route_group.RouteGroup(created_at=None, endpoints=None, name=None, routing_key=None, spec=None, status=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'created_at': 'createdAt', 'endpoints': 'endpoints', 'name': 'name', 'routing_key': 'routingKey', 'spec': 'spec', 'status': 'status'}

property created_at

Gets the created_at of this RouteGroup. # noqa: E501

Returns:

The created_at of this RouteGroup. # noqa: E501

Return type:

str

property endpoints

Gets the endpoints of this RouteGroup. # noqa: E501

Returns:

The endpoints of this RouteGroup. # noqa: E501

Return type:

list[RouteGroupEndpoint]

property name

Gets the name of this RouteGroup. # noqa: E501

Returns:

The name of this RouteGroup. # noqa: E501

Return type:

str

property routing_key

Gets the routing_key of this RouteGroup. # noqa: E501

Returns:

The routing_key of this RouteGroup. # noqa: E501

Return type:

str

property spec

Gets the spec of this RouteGroup. # noqa: E501

Returns:

The spec of this RouteGroup. # noqa: E501

Return type:

RouteGroupSpec

property status

Gets the status of this RouteGroup. # noqa: E501

Returns:

The status of this RouteGroup. # noqa: E501

Return type:

RouteGroupStatus

swagger_types = {'created_at': 'str', 'endpoints': 'list[RouteGroupEndpoint]', 'name': 'str', 'routing_key': 'str', 'spec': 'RouteGroupSpec', 'status': 'RouteGroupStatus'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.route_group_endpoint module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.route_group_endpoint.RouteGroupEndpoint(name=None, target=None, url=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'name': 'name', 'target': 'target', 'url': 'url'}

property name

Gets the name of this RouteGroupEndpoint. # noqa: E501

Returns:

The name of this RouteGroupEndpoint. # noqa: E501

Return type:

str

swagger_types = {'name': 'str', 'target': 'str', 'url': 'str'}

property target

Gets the target of this RouteGroupEndpoint. # noqa: E501

Returns:

The target of this RouteGroupEndpoint. # noqa: E501

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property url

Gets the url of this RouteGroupEndpoint. # noqa: E501

Returns:

The url of this RouteGroupEndpoint. # noqa: E501

Return type:

str

signadot_sdk.models.route_group_match module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.route_group_match.RouteGroupMatch(all=None, any=None, label=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

property all

Gets the all of this RouteGroupMatch. # noqa: E501

When All is non-nil, T matches a set of labels if and only if every element of All matches them. Only one field may be non-nil. # noqa: E501

Returns:

The all of this RouteGroupMatch. # noqa: E501

Return type:

list[RouteGroupMatch]

property any

Gets the any of this RouteGroupMatch. # noqa: E501

When Any is non-nil, T matches a set of labels if and only if some element of Any matches them. Only one field may be non-nil. # noqa: E501

Returns:

The any of this RouteGroupMatch. # noqa: E501

Return type:

list[RouteGroupMatch]

attribute_map = {'all': 'all', 'any': 'any', 'label': 'label'}

property label

Gets the label of this RouteGroupMatch. # noqa: E501

Returns:

The label of this RouteGroupMatch. # noqa: E501

Return type:

RouteGroupMatchLabel

swagger_types = {'all': 'list[RouteGroupMatch]', 'any': 'list[RouteGroupMatch]', 'label': 'RouteGroupMatchLabel'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.route_group_match_label module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.route_group_match_label.RouteGroupMatchLabel(key=None, value=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'key': 'key', 'value': 'value'}

property key

Gets the key of this RouteGroupMatchLabel. # noqa: E501

Key is an exact match on a label key, glob characters are just considered normal characters. # noqa: E501

Returns:

The key of this RouteGroupMatchLabel. # noqa: E501

Return type:

str

swagger_types = {'key': 'str', 'value': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this RouteGroupMatchLabel. # noqa: E501

Value is a glob match for the value of a sandbox label. See https://pkg.go.dev/path/filepath#Match for the file glob syntax. # noqa: E501

Returns:

The value of this RouteGroupMatchLabel. # noqa: E501

Return type:

str

signadot_sdk.models.route_group_spec module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.route_group_spec.RouteGroupSpec(cluster=None, description=None, endpoints=None, match=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'cluster': 'cluster', 'description': 'description', 'endpoints': 'endpoints', 'match': 'match'}

property cluster

Gets the cluster of this RouteGroupSpec. # noqa: E501

Cluster gives the cluster to which the route group applies. # noqa: E501

Returns:

The cluster of this RouteGroupSpec. # noqa: E501

Return type:

str

property description

Gets the description of this RouteGroupSpec. # noqa: E501

Description provides a short description of the route group. # noqa: E501

Returns:

The description of this RouteGroupSpec. # noqa: E501

Return type:

str

property endpoints

Gets the endpoints of this RouteGroupSpec. # noqa: E501

Endpoints define endpoints which target different in-cluster services. # noqa: E501

Returns:

The endpoints of this RouteGroupSpec. # noqa: E501

Return type:

list[RouteGroupSpecEndpoint]

property match

Gets the match of this RouteGroupSpec. # noqa: E501

Returns:

The match of this RouteGroupSpec. # noqa: E501

Return type:

RouteGroupMatch

swagger_types = {'cluster': 'str', 'description': 'str', 'endpoints': 'list[RouteGroupSpecEndpoint]', 'match': 'RouteGroupMatch'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.route_group_spec_endpoint module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.route_group_spec_endpoint.RouteGroupSpecEndpoint(name=None, target=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'name': 'name', 'target': 'target'}

property name

Gets the name of this RouteGroupSpecEndpoint. # noqa: E501

Returns:

The name of this RouteGroupSpecEndpoint. # noqa: E501

Return type:

str

swagger_types = {'name': 'str', 'target': 'str'}

property target

Gets the target of this RouteGroupSpecEndpoint. # noqa: E501

Returns:

The target of this RouteGroupSpecEndpoint. # noqa: E501

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.route_group_status module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.route_group_status.RouteGroupStatus(matched_sandboxes=None, message=None, ready=None, reason=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'matched_sandboxes': 'matchedSandboxes', 'message': 'message', 'ready': 'ready', 'reason': 'reason'}

property matched_sandboxes

Gets the matched_sandboxes of this RouteGroupStatus. # noqa: E501

MatchedSandboxes gives the list of sandboxes whose labels were matched by the ‘match’ object in the spec. # noqa: E501

Returns:

The matched_sandboxes of this RouteGroupStatus. # noqa: E501

Return type:

list[str]

property message

Gets the message of this RouteGroupStatus. # noqa: E501

Message is a human readable explanation of why the sandbox is healthy or not. # noqa: E501

Returns:

The message of this RouteGroupStatus. # noqa: E501

Return type:

str

property ready

Gets the ready of this RouteGroupStatus. # noqa: E501

Ready indicates whether the sandbox is ready, meaning that it can be used for testing. # noqa: E501

Returns:

The ready of this RouteGroupStatus. # noqa: E501

Return type:

bool

property reason

Gets the reason of this RouteGroupStatus. # noqa: E501

Reason is a machine readable explanation of why the sandbox is healthy or not. # noqa: E501

Returns:

The reason of this RouteGroupStatus. # noqa: E501

Return type:

str

swagger_types = {'matched_sandboxes': 'list[str]', 'message': 'str', 'ready': 'bool', 'reason': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.sandbox module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox.Sandbox(created_at=None, endpoints=None, name=None, routing_key=None, spec=None, status=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'created_at': 'createdAt', 'endpoints': 'endpoints', 'name': 'name', 'routing_key': 'routingKey', 'spec': 'spec', 'status': 'status'}

property created_at

Gets the created_at of this Sandbox. # noqa: E501

Returns:

The created_at of this Sandbox. # noqa: E501

Return type:

str

property endpoints

Gets the endpoints of this Sandbox. # noqa: E501

Returns:

The endpoints of this Sandbox. # noqa: E501

Return type:

list[SandboxEndpoint]

property name

Gets the name of this Sandbox. # noqa: E501

Human-readable name of this sandbox # noqa: E501

Returns:

The name of this Sandbox. # noqa: E501

Return type:

str

property routing_key

Gets the routing_key of this Sandbox. # noqa: E501

Returns:

The routing_key of this Sandbox. # noqa: E501

Return type:

str

property spec

Gets the spec of this Sandbox. # noqa: E501

Returns:

The spec of this Sandbox. # noqa: E501

Return type:

SandboxSpec

property status

Gets the status of this Sandbox. # noqa: E501

Returns:

The status of this Sandbox. # noqa: E501

Return type:

SandboxReadiness

swagger_types = {'created_at': 'str', 'endpoints': 'list[SandboxEndpoint]', 'name': 'str', 'routing_key': 'str', 'spec': 'SandboxSpec', 'status': 'SandboxReadiness'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.sandbox_custom_patch module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_custom_patch.SandboxCustomPatch(type=None, value=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'type': 'type', 'value': 'value'}

swagger_types = {'type': 'str', 'value': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this SandboxCustomPatch. # noqa: E501

Returns:

The type of this SandboxCustomPatch. # noqa: E501

Return type:

str

property value

Gets the value of this SandboxCustomPatch. # noqa: E501

Returns:

The value of this SandboxCustomPatch. # noqa: E501

Return type:

str

signadot_sdk.models.sandbox_customizations module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_customizations.SandboxCustomizations(env=None, images=None, patch=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'env': 'env', 'images': 'images', 'patch': 'patch'}

property env

Gets the env of this SandboxCustomizations. # noqa: E501

Env var modifications that will be applied to the forked workload # noqa: E501

Returns:

The env of this SandboxCustomizations. # noqa: E501

Return type:

list[SandboxEnvVar]

property images

Gets the images of this SandboxCustomizations. # noqa: E501

One or more docker images that will be applied to the forked workload # noqa: E501

Returns:

The images of this SandboxCustomizations. # noqa: E501

Return type:

list[SandboxImage]

property patch

Gets the patch of this SandboxCustomizations. # noqa: E501

Returns:

The patch of this SandboxCustomizations. # noqa: E501

Return type:

SandboxCustomPatch

swagger_types = {'env': 'list[SandboxEnvVar]', 'images': 'list[SandboxImage]', 'patch': 'SandboxCustomPatch'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.sandbox_default_route_group module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_default_route_group.SandboxDefaultRouteGroup(endpoints=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'endpoints': 'endpoints'}

property endpoints

Gets the endpoints of this SandboxDefaultRouteGroup. # noqa: E501

Returns:

The endpoints of this SandboxDefaultRouteGroup. # noqa: E501

Return type:

list[RouteGroupSpecEndpoint]

swagger_types = {'endpoints': 'list[RouteGroupSpecEndpoint]'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.sandbox_endpoint module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_endpoint.SandboxEndpoint(baseline_url=None, host=None, name=None, port=None, protocol=None, route_type=None, target=None, url=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'baseline_url': 'baselineUrl', 'host': 'host', 'name': 'name', 'port': 'port', 'protocol': 'protocol', 'route_type': 'routeType', 'target': 'target', 'url': 'url'}

property baseline_url

Gets the baseline_url of this SandboxEndpoint. # noqa: E501

Returns:

The baseline_url of this SandboxEndpoint. # noqa: E501

Return type:

str

property host

Gets the host of this SandboxEndpoint. # noqa: E501

Returns:

The host of this SandboxEndpoint. # noqa: E501

Return type:

str

property name

Gets the name of this SandboxEndpoint. # noqa: E501

Returns:

The name of this SandboxEndpoint. # noqa: E501

Return type:

str

property port

Gets the port of this SandboxEndpoint. # noqa: E501

Returns:

The port of this SandboxEndpoint. # noqa: E501

Return type:

int

property protocol

Gets the protocol of this SandboxEndpoint. # noqa: E501

Returns:

The protocol of this SandboxEndpoint. # noqa: E501

Return type:

str

property route_type

Gets the route_type of this SandboxEndpoint. # noqa: E501

Returns:

The route_type of this SandboxEndpoint. # noqa: E501

Return type:

str

swagger_types = {'baseline_url': 'str', 'host': 'str', 'name': 'str', 'port': 'int', 'protocol': 'str', 'route_type': 'str', 'target': 'str', 'url': 'str'}

property target

Gets the target of this SandboxEndpoint. # noqa: E501

Returns:

The target of this SandboxEndpoint. # noqa: E501

Return type:

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property url

Gets the url of this SandboxEndpoint. # noqa: E501

Returns:

The url of this SandboxEndpoint. # noqa: E501

Return type:

str

signadot_sdk.models.sandbox_env_value_from module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_env_value_from.SandboxEnvValueFrom(fork=None, resource=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'fork': 'fork', 'resource': 'resource'}

property fork

Gets the fork of this SandboxEnvValueFrom. # noqa: E501

Returns:

The fork of this SandboxEnvValueFrom. # noqa: E501

Return type:

SandboxEnvValueFromFork

property resource

Gets the resource of this SandboxEnvValueFrom. # noqa: E501

Returns:

The resource of this SandboxEnvValueFrom. # noqa: E501

Return type:

SandboxEnvValueFromResource

swagger_types = {'fork': 'SandboxEnvValueFromFork', 'resource': 'SandboxEnvValueFromResource'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.sandbox_env_value_from_fork module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_env_value_from_fork.SandboxEnvValueFromFork(expression=None, fork_of=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'expression': 'expression', 'fork_of': 'forkOf'}

property expression

Gets the expression of this SandboxEnvValueFromFork. # noqa: E501

Returns:

The expression of this SandboxEnvValueFromFork. # noqa: E501

Return type:

str

property fork_of

Gets the fork_of of this SandboxEnvValueFromFork. # noqa: E501

Returns:

The fork_of of this SandboxEnvValueFromFork. # noqa: E501

Return type:

SandboxForkOf

swagger_types = {'expression': 'str', 'fork_of': 'SandboxForkOf'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.sandbox_env_value_from_resource module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_env_value_from_resource.SandboxEnvValueFromResource(name=None, output_key=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'name': 'name', 'output_key': 'outputKey'}

property name

Gets the name of this SandboxEnvValueFromResource. # noqa: E501

Returns:

The name of this SandboxEnvValueFromResource. # noqa: E501

Return type:

str

property output_key

Gets the output_key of this SandboxEnvValueFromResource. # noqa: E501

Returns:

The output_key of this SandboxEnvValueFromResource. # noqa: E501

Return type:

str

swagger_types = {'name': 'str', 'output_key': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.sandbox_env_var module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_env_var.SandboxEnvVar(container=None, name=None, operation=None, value=None, value_from=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'container': 'container', 'name': 'name', 'operation': 'operation', 'value': 'value', 'value_from': 'valueFrom'}

property container

Gets the container of this SandboxEnvVar. # noqa: E501

name of container to which it applies # noqa: E501

Returns:

The container of this SandboxEnvVar. # noqa: E501

Return type:

str

property name

Gets the name of this SandboxEnvVar. # noqa: E501

environmental variable name # noqa: E501

Returns:

The name of this SandboxEnvVar. # noqa: E501

Return type:

str

property operation

Gets the operation of this SandboxEnvVar. # noqa: E501

upsert or delete # noqa: E501

Returns:

The operation of this SandboxEnvVar. # noqa: E501

Return type:

str

swagger_types = {'container': 'str', 'name': 'str', 'operation': 'str', 'value': 'str', 'value_from': 'SandboxEnvValueFrom'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this SandboxEnvVar. # noqa: E501

environmental variable value # noqa: E501

Returns:

The value of this SandboxEnvVar. # noqa: E501

Return type:

str

property value_from

Gets the value_from of this SandboxEnvVar. # noqa: E501

Returns:

The value_from of this SandboxEnvVar. # noqa: E501

Return type:

SandboxEnvValueFrom

signadot_sdk.models.sandbox_fork module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_fork.SandboxFork(customizations=None, endpoints=None, fork_of=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'customizations': 'customizations', 'endpoints': 'endpoints', 'fork_of': 'forkOf'}

property customizations

Gets the customizations of this SandboxFork. # noqa: E501

Returns:

The customizations of this SandboxFork. # noqa: E501

Return type:

SandboxCustomizations

property endpoints

Gets the endpoints of this SandboxFork. # noqa: E501

Deprecated. Use defaultRouteGroup.Endpoints instead. # noqa: E501

Returns:

The endpoints of this SandboxFork. # noqa: E501

Return type:

list[SandboxForkEndpoint]

property fork_of

Gets the fork_of of this SandboxFork. # noqa: E501

Returns:

The fork_of of this SandboxFork. # noqa: E501

Return type:

SandboxForkOf

swagger_types = {'customizations': 'SandboxCustomizations', 'endpoints': 'list[SandboxForkEndpoint]', 'fork_of': 'SandboxForkOf'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.sandbox_fork_endpoint module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_fork_endpoint.SandboxForkEndpoint(name=None, port=None, protocol=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'name': 'name', 'port': 'port', 'protocol': 'protocol'}

property name

Gets the name of this SandboxForkEndpoint. # noqa: E501

Name of the endpoint # noqa: E501

Returns:

The name of this SandboxForkEndpoint. # noqa: E501

Return type:

str

property port

Gets the port of this SandboxForkEndpoint. # noqa: E501

Port it will map to on the forked workload # noqa: E501

Returns:

The port of this SandboxForkEndpoint. # noqa: E501

Return type:

int

property protocol

Gets the protocol of this SandboxForkEndpoint. # noqa: E501

Protocol that this endpoint uses # noqa: E501

Returns:

The protocol of this SandboxForkEndpoint. # noqa: E501

Return type:

str

swagger_types = {'name': 'str', 'port': 'int', 'protocol': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.sandbox_fork_of module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_fork_of.SandboxForkOf(kind=None, name=None, namespace=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'kind': 'kind', 'name': 'name', 'namespace': 'namespace'}

property kind

Gets the kind of this SandboxForkOf. # noqa: E501

Kind of entity that we want to route to. One of (Service or Deployment or Rollout). # noqa: E501

Returns:

The kind of this SandboxForkOf. # noqa: E501

Return type:

str

property name

Gets the name of this SandboxForkOf. # noqa: E501

Name of the entity within the Kubernetes cluster. # noqa: E501

Returns:

The name of this SandboxForkOf. # noqa: E501

Return type:

str

property namespace

Gets the namespace of this SandboxForkOf. # noqa: E501

Namespace within which the entity lives in the Kubernetes cluster. # noqa: E501

Returns:

The namespace of this SandboxForkOf. # noqa: E501

Return type:

str

swagger_types = {'kind': 'str', 'name': 'str', 'namespace': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.sandbox_host_endpoint module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_host_endpoint.SandboxHostEndpoint(host=None, name=None, port=None, protocol=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'host': 'host', 'name': 'name', 'port': 'port', 'protocol': 'protocol'}

property host

Gets the host of this SandboxHostEndpoint. # noqa: E501

Hostname that this endpoint points to # noqa: E501

Returns:

The host of this SandboxHostEndpoint. # noqa: E501

Return type:

str

property name

Gets the name of this SandboxHostEndpoint. # noqa: E501

Name of the endpoint # noqa: E501

Returns:

The name of this SandboxHostEndpoint. # noqa: E501

Return type:

str

property port

Gets the port of this SandboxHostEndpoint. # noqa: E501

Port it will map to on the specified host # noqa: E501

Returns:

The port of this SandboxHostEndpoint. # noqa: E501

Return type:

int

property protocol

Gets the protocol of this SandboxHostEndpoint. # noqa: E501

Protocol that this endpoint uses # noqa: E501

Returns:

The protocol of this SandboxHostEndpoint. # noqa: E501

Return type:

str

swagger_types = {'host': 'str', 'name': 'str', 'port': 'int', 'protocol': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.sandbox_image module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_image.SandboxImage(container=None, image=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'container': 'container', 'image': 'image'}

property container

Gets the container of this SandboxImage. # noqa: E501

Container is the container this image must apply to in the forked workload # noqa: E501

Returns:

The container of this SandboxImage. # noqa: E501

Return type:

str

property image

Gets the image of this SandboxImage. # noqa: E501

Name of the image (e.g. gcr.io/my-image/repo:my-tag) # noqa: E501

Returns:

The image of this SandboxImage. # noqa: E501

Return type:

str

swagger_types = {'container': 'str', 'image': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.sandbox_readiness module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_readiness.SandboxReadiness(message=None, ready=None, reason=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'message': 'message', 'ready': 'ready', 'reason': 'reason'}

property message

Gets the message of this SandboxReadiness. # noqa: E501

Message is a human readable explanation of why the sandbox is healthy or not. # noqa: E501

Returns:

The message of this SandboxReadiness. # noqa: E501

Return type:

str

property ready

Gets the ready of this SandboxReadiness. # noqa: E501

Ready indicates whether the sandbox is ready, meaning that it can be used for testing. # noqa: E501

Returns:

The ready of this SandboxReadiness. # noqa: E501

Return type:

bool

property reason

Gets the reason of this SandboxReadiness. # noqa: E501

Reason is a machine readable explanation of why the sandbox is healthy or not. # noqa: E501

Returns:

The reason of this SandboxReadiness. # noqa: E501

Return type:

str

swagger_types = {'message': 'str', 'ready': 'bool', 'reason': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.sandbox_resource module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_resource.SandboxResource(name=None, params=None, plugin=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'name': 'name', 'params': 'params', 'plugin': 'plugin'}

property name

Gets the name of this SandboxResource. # noqa: E501

Returns:

The name of this SandboxResource. # noqa: E501

Return type:

str

property params

Gets the params of this SandboxResource. # noqa: E501

Returns:

The params of this SandboxResource. # noqa: E501

Return type:

dict(str, str)

property plugin

Gets the plugin of this SandboxResource. # noqa: E501

Returns:

The plugin of this SandboxResource. # noqa: E501

Return type:

str

swagger_types = {'name': 'str', 'params': 'dict(str, str)', 'plugin': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

signadot_sdk.models.sandbox_spec module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_spec.SandboxSpec(cluster=None, default_route_group=None, description=None, endpoints=None, forks=None, labels=None, resources=None, ttl=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'cluster': 'cluster', 'default_route_group': 'defaultRouteGroup', 'description': 'description', 'endpoints': 'endpoints', 'forks': 'forks', 'labels': 'labels', 'resources': 'resources', 'ttl': 'ttl'}

property cluster

Gets the cluster of this SandboxSpec. # noqa: E501

Cluster within which this sandbox should be created # noqa: E501

Returns:

The cluster of this SandboxSpec. # noqa: E501

Return type:

str

property default_route_group

Gets the default_route_group of this SandboxSpec. # noqa: E501

Returns:

The default_route_group of this SandboxSpec. # noqa: E501

Return type:

SandboxDefaultRouteGroup

property description

Gets the description of this SandboxSpec. # noqa: E501

Description of the purpose of this sandbox # noqa: E501

Returns:

The description of this SandboxSpec. # noqa: E501

Return type:

str

property endpoints

Gets the endpoints of this SandboxSpec. # noqa: E501

Deprecated. Use defaultRouteGroup.Endpoints instead. # noqa: E501

Returns:

The endpoints of this SandboxSpec. # noqa: E501

Return type:

list[SandboxHostEndpoint]

property forks

Gets the forks of this SandboxSpec. # noqa: E501

Forks is the specification of each forked entity # noqa: E501

Returns:

The forks of this SandboxSpec. # noqa: E501

Return type:

list[SandboxFork]

property labels

Gets the labels of this SandboxSpec. # noqa: E501

Labels are used to specify metadata associated with the sandbox as key-value pairs. # noqa: E501

Returns:

The labels of this SandboxSpec. # noqa: E501

Return type:

dict(str, str)

property resources

Gets the resources of this SandboxSpec. # noqa: E501

Resources specifies each required resource to spin up the sandbox # noqa: E501

Returns:

The resources of this SandboxSpec. # noqa: E501

Return type:

list[SandboxResource]

swagger_types = {'cluster': 'str', 'default_route_group': 'SandboxDefaultRouteGroup', 'description': 'str', 'endpoints': 'list[SandboxHostEndpoint]', 'forks': 'list[SandboxFork]', 'labels': 'dict(str, str)', 'resources': 'list[SandboxResource]', 'ttl': 'SandboxTTL'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property ttl

Gets the ttl of this SandboxSpec. # noqa: E501

Returns:

The ttl of this SandboxSpec. # noqa: E501

Return type:

SandboxTTL

signadot_sdk.models.sandbox_ttl module

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

class signadot_sdk.models.sandbox_ttl.SandboxTTL(duration=None, offset_from=None, _configuration=None)

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

attribute_map = {'duration': 'duration', 'offset_from': 'offsetFrom'}

property duration

Gets the duration of this SandboxTTL. # noqa: E501

Duration represents the duration until sandbox end of life. It should be an unsigned integer not exceeding 32 bits followed by a units character, which can be one of the following. - ‘m’ for minutes - ‘h’ for hours - ‘d’ for days - ‘w’ for weeks # noqa: E501

Returns:

The duration of this SandboxTTL. # noqa: E501

Return type:

str

property offset_from

Gets the offset_from of this SandboxTTL. # noqa: E501

OffsetFrom indicates what the Duration is relative to. It may be the empty string or “createdAt”. The empty string defaults to meaning “createdAt”. # noqa: E501

Returns:

The offset_from of this SandboxTTL. # noqa: E501

Return type:

str

swagger_types = {'duration': 'str', 'offset_from': 'str'}

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Module contents

Signadot API

API for Signadot Sandboxes # noqa: E501

OpenAPI spec version: 2.0

Generated by: https://github.com/swagger-api/swagger-codegen.git