DeployedStatelessServiceInstanceInfo Class
Information about a stateless service instance deployed on a node.
All required parameters must be populated in order to send to Azure.
Constructor
DeployedStatelessServiceInstanceInfo(*, service_name: str = None, service_type_name: str = None, service_manifest_name: str = None, code_package_name: str = None, partition_id: str = None, replica_status=None, address: str = None, service_package_activation_id: str = None, host_process_id: str = None, instance_id: str = None, **kwargs)
Parameters
| Name | Description |
|---|---|
|
service_name
Required
|
The full name of the service with 'fabric:' URI scheme. |
|
service_type_name
Required
|
Name of the service type as specified in the service manifest. |
|
service_manifest_name
Required
|
The name of the service manifest in which this service type is defined. |
|
code_package_name
Required
|
The name of the code package that hosts this replica. |
|
partition_id
Required
|
An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different. |
|
replica_status
Required
|
str or
ReplicaStatus
The status of a replica of a service. Possible values include: 'Invalid', 'InBuild', 'Standby', 'Ready', 'Down', 'Dropped' |
|
address
Required
|
The last address returned by the replica in Open or ChangeRole. |
|
service_package_activation_id
Required
|
The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string. |
|
host_process_id
Required
|
Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel. |
|
service_kind
Required
|
Required. Constant filled by server. |
|
instance_id
Required
|
Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
service_name
|
Default value: None
|
|
service_type_name
|
Default value: None
|
|
service_manifest_name
|
Default value: None
|
|
code_package_name
|
Default value: None
|
|
partition_id
|
Default value: None
|
|
replica_status
|
Default value: None
|
|
address
|
Default value: None
|
|
service_package_activation_id
|
Default value: None
|
|
host_process_id
|
Default value: None
|
|
instance_id
|
Default value: None
|
Methods
| as_dict |
Return a dict that can be JSONify using json.dump. Advanced usage might optionally use a callback as parameter: Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object. The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict. See the three examples in this file:
If you want XML serialization, you can pass the kwargs is_xml=True. |
| deserialize |
Parse a str using the RestAPI syntax and return a model. |
| enable_additional_properties_sending | |
| from_dict |
Parse a dict using given key extractor return a model. By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor) |
| is_xml_model | |
| serialize |
Return the JSON that would be sent to azure from this model. This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False). If you want XML serialization, you can pass the kwargs is_xml=True. |
| validate |
Validate this model recursively and return a list of ValidationError. |
as_dict
Return a dict that can be JSONify using json.dump.
Advanced usage might optionally use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)
Parameters
| Name | Description |
|---|---|
|
key_transformer
|
<xref:function>
A key transformer function. |
|
keep_readonly
|
Default value: True
|
Returns
| Type | Description |
|---|---|
|
A dict JSON compatible object |
deserialize
Parse a str using the RestAPI syntax and return a model.
deserialize(data, content_type=None)
Parameters
| Name | Description |
|---|---|
|
data
Required
|
A str using RestAPI structure. JSON by default. |
|
content_type
|
JSON by default, set application/xml if XML. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An instance of this model |
Exceptions
| Type | Description |
|---|---|
|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
from_dict(data, key_extractors=None, content_type=None)
Parameters
| Name | Description |
|---|---|
|
data
Required
|
A dict using RestAPI structure |
|
content_type
|
JSON by default, set application/xml if XML. Default value: None
|
|
key_extractors
|
Default value: None
|
Returns
| Type | Description |
|---|---|
|
An instance of this model |
Exceptions
| Type | Description |
|---|---|
|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model()
serialize
Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)
Parameters
| Name | Description |
|---|---|
|
keep_readonly
|
If you want to serialize the readonly attributes Default value: False
|
Returns
| Type | Description |
|---|---|
|
A dict JSON compatible object |
validate
Validate this model recursively and return a list of ValidationError.
validate()
Returns
| Type | Description |
|---|---|
|
A list of validation error |