TaskTerminateOptions Classe

Parâmetros adicionais para terminar a operação.

Herança

Model

TaskTerminateOptions

Construtor

TaskTerminateOptions(*, timeout: int = 30, client_request_id: str = None, return_client_request_id: bool = False, ocp_date=None, if_match: str = None, if_none_match: str = None, if_modified_since=None, if_unmodified_since=None, **kwargs)

Parâmetros

timeout

int

Necessário

O tempo máximo que o servidor pode gastar a processar o pedido, em segundos. A predefinição é 30 segundos. Valor predefinido: 30 .

client_request_id

str

Necessário

A identidade do pedido gerado pelo autor da chamada, sob a forma de um GUID sem decoração, como chavetas, por exemplo, 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return_client_request_id

bool

Necessário

Se o servidor deve devolver o client-request-id na resposta. Valor predefinido: Falso .

ocp_date

datetime

Necessário

A hora em que o pedido foi emitido. Normalmente, as bibliotecas de cliente definem isto como a hora atual do relógio do sistema; defina-a explicitamente se estiver a chamar a API REST diretamente.

if_match

str

Necessário

Um valor ETag associado à versão do recurso conhecido pelo cliente. A operação só será efetuada se a ETag atual do recurso no serviço corresponder exatamente ao valor especificado pelo cliente.

if_none_match

str

Necessário

Um valor ETag associado à versão do recurso conhecido pelo cliente. A operação só será efetuada se a ETag atual do recurso no serviço não corresponder ao valor especificado pelo cliente.

if_modified_since

datetime

Necessário

Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação só será efetuada se o recurso no serviço tiver sido modificado desde a hora especificada.

if_unmodified_since

datetime

Necessário

Um carimbo de data/hora que indica a hora da última modificação do recurso conhecido pelo cliente. A operação só será efetuada se o recurso no serviço não tiver sido modificado desde a hora especificada.

Métodos

as_dict	Devolver um ditado que pode ser JSONify com json.dump. Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro: A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente, contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. O valor é o valor atual neste objeto. A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict de resultado hierárquico. Veja os três exemplos neste ficheiro: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Se quiser serialização XML, pode transmitir os kwargs is_xml=True.
deserialize	Analise um str com a sintaxe RestAPI e devolva um modelo.
enable_additional_properties_sending
from_dict	Analisar um ditado com um determinado extrator de chaves devolve um modelo. Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Devolver o JSON que seria enviado para o Azure a partir deste modelo. Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso). Se quiser serialização XML, pode transmitir os kwargs is_xml=True.
validate	Valide este modelo de forma recursiva e devolva uma lista de ValidationError.

as_dict

Devolver um ditado que pode ser JSONify com json.dump.

Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro:

A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente, contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. O valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict de resultado hierárquico.

Veja os três exemplos neste ficheiro:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parâmetros

key_transformer

<xref:function>

Uma função de transformador de chaves.

keep_readonly

valor predefinido: True

Devoluções

Um objeto compatível com JSON de ditado

Tipo de retorno

dict

deserialize

Analise um str com a sintaxe RestAPI e devolva um modelo.

deserialize(data, content_type=None)

Parâmetros

data

str

Necessário

Um str com a estrutura RestAPI. JSON por predefinição.

content_type

str

valor predefinido: None

JSON por predefinição, defina application/xml se XML.

Devoluções

Uma instância deste modelo

Exceções

DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analisar um ditado com um determinado extrator de chaves devolve um modelo.

Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

from_dict(data, key_extractors=None, content_type=None)

Parâmetros

data

dict

Necessário

Um ditado com a estrutura restAPI

content_type

str

valor predefinido: None

JSON por predefinição, defina application/xml se XML.

key_extractors

valor predefinido: None

Devoluções

Uma instância deste modelo

Exceções

DeserializationError if something went wrong

is_xml_model

is_xml_model()

serialize

Devolver o JSON que seria enviado para o Azure a partir deste modelo.

Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso).

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parâmetros

keep_readonly

bool

valor predefinido: False

Se quiser serializar os atributos só de leitura

Devoluções

Um objeto compatível com JSON de ditado

Tipo de retorno

dict

validate

Valide este modelo de forma recursiva e devolva uma lista de ValidationError.

validate()

Devoluções

Uma lista de erros de validação

Tipo de retorno

list