1. class
  2. Google
  3. \
  4. Service
  5. \
  6. CloudHealthcare
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsDatasetsConsentStoresAttributeDefinitions

ProjectsLocationsDatasetsConsentStoresAttributeDefinitions

class ProjectsLocationsDatasetsConsentStoresAttributeDefinitions extends Resource (View source)

The "attributeDefinitions" collection of methods.

Typical usage is:

 $healthcareService = new Google\Service\CloudHealthcare(...);
 $attributeDefinitions = $healthcareService->projects_locations_datasets_consentStores_attributeDefinitions;

Methods

AttributeDefinition
create(string $parent, AttributeDefinition $postBody, array $optParams = [])

Creates a new Attribute definition in the parent consent store.

HealthcareEmpty
delete(string $name, array $optParams = [])

Deletes the specified Attribute definition. Fails if the Attribute definition is referenced by any User data mapping, or the latest revision of any Consent. (attributeDefinitions.delete)

AttributeDefinition
get(string $name, array $optParams = [])

Gets the specified Attribute definition. (attributeDefinitions.get)

ListAttributeDefinitionsResponse
listProjectsLocationsDatasetsConsentStoresAttributeDefinitions(string $parent, array $optParams = [])

Lists the Attribute definitions in the specified consent store. (attributeDef initions.listProjectsLocationsDatasetsConsentStoresAttributeDefinitions)

AttributeDefinition
patch(string $name, AttributeDefinition $postBody, array $optParams = [])

Updates the specified Attribute definition. (attributeDefinitions.patch)

Details

at line 51
AttributeDefinition create(string $parent, AttributeDefinition $postBody, array $optParams = [])

Creates a new Attribute definition in the parent consent store.

(attributeDefinitions.create)

Parameters

string $parent

Required. The name of the consent store that this Attribute definition belongs to.
AttributeDefinition $postBody
array $optParams

Optional parameters.

Return Value

AttributeDefinition

Exceptions

Exception

at line 70
HealthcareEmpty delete(string $name, array $optParams = [])

Deletes the specified Attribute definition. Fails if the Attribute definition is referenced by any User data mapping, or the latest revision of any Consent. (attributeDefinitions.delete)

Parameters

string $name

Required. The resource name of the Attribute definition to delete. To preserve referential integrity, Attribute definitions referenced by a User data mapping or the latest revision of a Consent cannot be deleted.
array $optParams

Optional parameters.

Return Value

HealthcareEmpty

Exceptions

Exception

at line 85
AttributeDefinition get(string $name, array $optParams = [])

Gets the specified Attribute definition. (attributeDefinitions.get)

Parameters

string $name

Required. The resource name of the Attribute definition to get.
array $optParams

Optional parameters.

Return Value

AttributeDefinition

Exceptions

Exception

at line 110
ListAttributeDefinitionsResponse listProjectsLocationsDatasetsConsentStoresAttributeDefinitions(string $parent, array $optParams = [])

Lists the Attribute definitions in the specified consent store. (attributeDef initions.listProjectsLocationsDatasetsConsentStoresAttributeDefinitions)

Parameters

string $parent

Required. Name of the consent store to retrieve Attribute definitions from.
array $optParams

Optional parameters.

Return Value

ListAttributeDefinitionsResponse

Exceptions

Exception

at line 136
AttributeDefinition patch(string $name, AttributeDefinition $postBody, array $optParams = [])

Updates the specified Attribute definition. (attributeDefinitions.patch)

Parameters

string $name

Identifier. Resource name of the Attribute definition, of the form projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_ id}. Cannot be changed after creation.
AttributeDefinition $postBody
array $optParams

Optional parameters.

Return Value

AttributeDefinition

Exceptions

Exception