Cloud Healthcare API . projects . locations . datasets . consentStores . userDataMappings

Instance Methods

archive(name, body=None, x__xgafv=None)

Archives the specified User data mapping.

close()

Close httplib2 connections.

create(parent, body=None, x__xgafv=None)

Creates a new User data mapping in the parent Consent store.

delete(name, x__xgafv=None)

Deletes the specified User data mapping.

get(name, x__xgafv=None)

Gets the specified User data mapping.

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists the User data mappings in the given Consent store.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates the specified User data mapping.

Method Details

archive(name, body=None, x__xgafv=None)
Archives the specified User data mapping.

Args:
  name: string, The resource name of the user data mapping to archive. (required)
  body: object, The request body.
    The object takes the form of:

{ # Archives the specified User data mapping.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Archives the specified User data mapping.
}
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Creates a new User data mapping in the parent Consent store.

Args:
  parent: string, Required. Name of the consent store. (required)
  body: object, The request body.
    The object takes the form of:

{ # Maps a user data entry to its end user and Attributes.
  "archiveTime": "A String", # Output only. Indicates the time when this data mapping was archived.
  "archived": True or False, # Output only. Indicates whether this data mapping is archived.
  "dataId": "A String", # Required. A unique identifier for the mapped data.
  "name": "A String", # Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`.
  "resourceAttributes": [ # Attributes of end user data. Each attribute can have exactly one value specified. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute.
    { # An attribute value for a consent or data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values.
      "attributeDefinitionId": "A String", # Indicates the name of an attribute defined at the consent store.
      "values": [ # The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values.
        "A String",
      ],
    },
  ],
  "userId": "A String", # Required. User's UUID provided by the client.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Maps a user data entry to its end user and Attributes.
  "archiveTime": "A String", # Output only. Indicates the time when this data mapping was archived.
  "archived": True or False, # Output only. Indicates whether this data mapping is archived.
  "dataId": "A String", # Required. A unique identifier for the mapped data.
  "name": "A String", # Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`.
  "resourceAttributes": [ # Attributes of end user data. Each attribute can have exactly one value specified. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute.
    { # An attribute value for a consent or data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values.
      "attributeDefinitionId": "A String", # Indicates the name of an attribute defined at the consent store.
      "values": [ # The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values.
        "A String",
      ],
    },
  ],
  "userId": "A String", # Required. User's UUID provided by the client.
}
delete(name, x__xgafv=None)
Deletes the specified User data mapping.

Args:
  name: string, Required. The resource name of the user data mapping to delete. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
}
get(name, x__xgafv=None)
Gets the specified User data mapping.

Args:
  name: string, Required. The resource name of the user data mapping to retrieve. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Maps a user data entry to its end user and Attributes.
  "archiveTime": "A String", # Output only. Indicates the time when this data mapping was archived.
  "archived": True or False, # Output only. Indicates whether this data mapping is archived.
  "dataId": "A String", # Required. A unique identifier for the mapped data.
  "name": "A String", # Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`.
  "resourceAttributes": [ # Attributes of end user data. Each attribute can have exactly one value specified. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute.
    { # An attribute value for a consent or data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values.
      "attributeDefinitionId": "A String", # Indicates the name of an attribute defined at the consent store.
      "values": [ # The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values.
        "A String",
      ],
    },
  ],
  "userId": "A String", # Required. User's UUID provided by the client.
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the User data mappings in the given Consent store.

Args:
  parent: string, Required. Name of the Consent store to retrieve user data mappings from. (required)
  filter: string, Restricts the user data mappings returned to those matching a filter. Syntax: https://cloud.google.com/appengine/docs/standard/python/search/query_strings The fields available for filtering are: - data_id - user_id - archived - archive_time
  pageSize: integer, Limit on the number of user data mappings to return in a single response. If zero the default page size of 100 is used.
  pageToken: string, Token to retrieve the next page of results or empty to get the first page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Lists the User data mappings in the given Consent store.
  "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more results in the list.
  "userDataMappings": [ # The returned user data mappings. The maximum number of user data mappings returned is determined by the value of page_size in the ListUserDataMappingsRequest.
    { # Maps a user data entry to its end user and Attributes.
      "archiveTime": "A String", # Output only. Indicates the time when this data mapping was archived.
      "archived": True or False, # Output only. Indicates whether this data mapping is archived.
      "dataId": "A String", # Required. A unique identifier for the mapped data.
      "name": "A String", # Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`.
      "resourceAttributes": [ # Attributes of end user data. Each attribute can have exactly one value specified. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute.
        { # An attribute value for a consent or data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values.
          "attributeDefinitionId": "A String", # Indicates the name of an attribute defined at the consent store.
          "values": [ # The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values.
            "A String",
          ],
        },
      ],
      "userId": "A String", # Required. User's UUID provided by the client.
    },
  ],
}
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the specified User data mapping.

Args:
  name: string, Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # Maps a user data entry to its end user and Attributes.
  "archiveTime": "A String", # Output only. Indicates the time when this data mapping was archived.
  "archived": True or False, # Output only. Indicates whether this data mapping is archived.
  "dataId": "A String", # Required. A unique identifier for the mapped data.
  "name": "A String", # Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`.
  "resourceAttributes": [ # Attributes of end user data. Each attribute can have exactly one value specified. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute.
    { # An attribute value for a consent or data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values.
      "attributeDefinitionId": "A String", # Indicates the name of an attribute defined at the consent store.
      "values": [ # The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values.
        "A String",
      ],
    },
  ],
  "userId": "A String", # Required. User's UUID provided by the client.
}

  updateMask: string, The update mask that applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Maps a user data entry to its end user and Attributes.
  "archiveTime": "A String", # Output only. Indicates the time when this data mapping was archived.
  "archived": True or False, # Output only. Indicates whether this data mapping is archived.
  "dataId": "A String", # Required. A unique identifier for the mapped data.
  "name": "A String", # Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`.
  "resourceAttributes": [ # Attributes of end user data. Each attribute can have exactly one value specified. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute.
    { # An attribute value for a consent or data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values.
      "attributeDefinitionId": "A String", # Indicates the name of an attribute defined at the consent store.
      "values": [ # The value of the attribute. Must be an acceptable value as defined in the consent store. For example, if the consent store defines "data type" with acceptable values "questionnaire" and "step-count", when the attribute name is data type, this field must contain one of those values.
        "A String",
      ],
    },
  ],
  "userId": "A String", # Required. User's UUID provided by the client.
}