azure.batch.models.PoolGetOptions.yml

### YamlMime:PythonClass
uid: azure.batch.models.PoolGetOptions
name: PoolGetOptions
fullName: azure.batch.models.PoolGetOptions
module: azure.batch.models
inheritances:
- msrest.serialization.Model
summary: Additional parameters for get operation.
constructor:
  syntax: 'PoolGetOptions(*, select: str = None, expand: str = None, 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)'
  parameters:
  - name: select
    description: An OData $select clause.
    isRequired: true
    types:
    - <xref:str>
  - name: expand
    description: An OData $expand clause.
    isRequired: true
    types:
    - <xref:str>
  - name: timeout
    description: 'The maximum time that the server can spend processing the

      request, in seconds. The default is 30 seconds. If the value is larger

      than 30, the default will be used instead. Default value: 30 .'
    isRequired: true
    types:
    - <xref:int>
  - name: client_request_id
    description: 'The caller-generated request identity, in the

      form of a GUID with no decoration such as curly braces, e.g.

      9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.'
    isRequired: true
    types:
    - <xref:str>
  - name: return_client_request_id
    description: 'Whether the server should return the

      client-request-id in the response. Default value: False .'
    isRequired: true
    types:
    - <xref:bool>
  - name: ocp_date
    description: 'The time the request was issued. Client libraries

      typically set this to the current system clock time; set it explicitly if

      you are calling the REST API directly.'
    isRequired: true
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value associated with the version of the resource

      known to the client. The operation will be performed only if the

      resource''s current ETag on the service exactly matches the value specified

      by the client.'
    isRequired: true
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value associated with the version of the

      resource known to the client. The operation will be performed only if the

      resource''s current ETag on the service does not match the value specified

      by the client.'
    isRequired: true
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A timestamp indicating the last modified time of

      the resource known to the client. The operation will be performed only if

      the resource on the service has been modified since the specified time.'
    isRequired: true
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A timestamp indicating the last modified time

      of the resource known to the client. The operation will be performed only

      if the resource on the service has not been modified since the specified

      time.'
    isRequired: true
    types:
    - <xref:datetime>
  keywordOnlyParameters:
  - name: select
    isRequired: true
  - name: expand
    isRequired: true
  - name: timeout
    defaultValue: '30'
  - name: client_request_id
    isRequired: true
  - name: return_client_request_id
    isRequired: true
  - name: ocp_date
    isRequired: true
  - name: if_match
    isRequired: true
  - name: if_none_match
    isRequired: true
  - name: if_modified_since
    isRequired: true
  - name: if_unmodified_since
    isRequired: true
methods:
- uid: azure.batch.models.PoolGetOptions.as_dict
  name: as_dict
  summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\
    \ optionally use a callback as parameter:\n\nKey is the attribute name used in\
    \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\
    msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\
    \ in this object.\n\nThe string returned will be used to serialize the key.\n\
    If the return type is a list, this is considered hierarchical\nresult dict.\n\n\
    See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\
    \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\
    \ pass the kwargs is_xml=True."
  signature: as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>,
    **kwargs)
  parameters:
  - name: key_transformer
    description: A key transformer function.
    types:
    - <xref:function>
  - name: keep_readonly
    defaultValue: 'True'
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.batch.models.PoolGetOptions.deserialize
  name: deserialize
  summary: Parse a str using the RestAPI syntax and return a model.
  signature: deserialize(data, content_type=None)
  parameters:
  - name: data
    description: A str using RestAPI structure. JSON by default.
    isRequired: true
    types:
    - <xref:str>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.batch.models.PoolGetOptions.enable_additional_properties_sending
  name: enable_additional_properties_sending
  signature: enable_additional_properties_sending()
- uid: azure.batch.models.PoolGetOptions.from_dict
  name: from_dict
  summary: '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)'
  signature: from_dict(data, key_extractors=None, content_type=None)
  parameters:
  - name: data
    description: A dict using RestAPI structure
    isRequired: true
    types:
    - <xref:dict>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  - name: key_extractors
    defaultValue: None
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.batch.models.PoolGetOptions.is_xml_model
  name: is_xml_model
  signature: is_xml_model()
- uid: azure.batch.models.PoolGetOptions.serialize
  name: serialize
  summary: '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.'
  signature: serialize(keep_readonly=False, **kwargs)
  parameters:
  - name: keep_readonly
    description: If you want to serialize the readonly attributes
    defaultValue: 'False'
    types:
    - <xref:bool>
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.batch.models.PoolGetOptions.validate
  name: validate
  summary: Validate this model recursively and return a list of ValidationError.
  signature: validate()
  return:
    description: A list of validation error
    types:
    - <xref:list>