healthcare

package
v0.51.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 22, 2021 License: BSD-3-Clause Imports: 15 Imported by: 1

Documentation

Overview

Package healthcare provides access to the Cloud Healthcare API.

For product documentation, see: https://cloud.google.com/healthcare

Creating a client

Usage example:

import "google.golang.org/api/healthcare/v1beta1"
...
ctx := context.Background()
healthcareService, err := healthcare.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

healthcareService, err := healthcare.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
healthcareService, err := healthcare.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// See, edit, configure, and delete your Google Cloud Platform data
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivateConsentRequest added in v0.33.0

type ActivateConsentRequest struct {
	// ConsentArtifact: Required. The resource name of the Consent artifact
	// that contains documentation of the user's consent, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/c
	// onsentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}
	// `. If the draft Consent had a Consent artifact, this Consent artifact
	// overwrites it.
	ConsentArtifact string `json:"consentArtifact,omitempty"`

	// ExpireTime: Timestamp in UTC of when this Consent is considered
	// expired.
	ExpireTime string `json:"expireTime,omitempty"`

	// Ttl: The time to live for this Consent from when it is marked as
	// active.
	Ttl string `json:"ttl,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ConsentArtifact") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConsentArtifact") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ActivateConsentRequest: Activates the latest revision of the specified Consent by committing a new revision with `state` updated to `ACTIVE`. If the latest revision of the given Consent is in the `ACTIVE` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the given consent is in the `REJECTED` or `REVOKED` state.

func (*ActivateConsentRequest) MarshalJSON added in v0.33.0

func (s *ActivateConsentRequest) MarshalJSON() ([]byte, error)

type AnalyzeEntitiesRequest added in v0.35.0

type AnalyzeEntitiesRequest struct {
	// DocumentContent: document_content is a document to be annotated.
	DocumentContent string `json:"documentContent,omitempty"`

	// LicensedVocabularies: A list of licensed vocabularies to use in the
	// request, in addition to the default unlicensed vocabularies.
	//
	// Possible values:
	//   "LICENSED_VOCABULARY_UNSPECIFIED" - No licensed vocabulary
	// specified.
	//   "ICD10CM" - ICD-10-CM vocabulary
	//   "SNOMEDCT_US" - SNOMED CT (US version) vocabulary
	LicensedVocabularies []string `json:"licensedVocabularies,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DocumentContent") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DocumentContent") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AnalyzeEntitiesRequest: The request to analyze healthcare entities in a document.

func (*AnalyzeEntitiesRequest) MarshalJSON added in v0.35.0

func (s *AnalyzeEntitiesRequest) MarshalJSON() ([]byte, error)

type AnalyzeEntitiesResponse added in v0.35.0

type AnalyzeEntitiesResponse struct {
	// Entities: The union of all the candidate entities that the
	// entity_mentions in this response could link to. These are UMLS
	// concepts or normalized mention content.
	Entities []*Entity `json:"entities,omitempty"`

	// EntityMentions: entity_mentions contains all the annotated medical
	// entities that were mentioned in the provided document.
	EntityMentions []*EntityMention `json:"entityMentions,omitempty"`

	// Relationships: relationships contains all the binary relationships
	// that were identified between entity mentions within the provided
	// document.
	Relationships []*EntityMentionRelationship `json:"relationships,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Entities") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Entities") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AnalyzeEntitiesResponse: Includes recognized entity mentions and relationships between them.

func (*AnalyzeEntitiesResponse) MarshalJSON added in v0.35.0

func (s *AnalyzeEntitiesResponse) MarshalJSON() ([]byte, error)

type Annotation added in v0.28.0

type Annotation struct {
	// AnnotationSource: Details of the source.
	AnnotationSource *AnnotationSource `json:"annotationSource,omitempty"`

	// CustomData: Additional information for this annotation record, such
	// as annotator and verifier information or study campaign.
	CustomData map[string]string `json:"customData,omitempty"`

	// ImageAnnotation: Annotations for images. For example, bounding
	// polygons.
	ImageAnnotation *ImageAnnotation `json:"imageAnnotation,omitempty"`

	// Name: Resource name of the Annotation, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/a
	// nnotationStores/{annotation_store_id}/annotations/{annotation_id}`.
	Name string `json:"name,omitempty"`

	// ResourceAnnotation: Annotations for resource. For example,
	// classification tags.
	ResourceAnnotation *ResourceAnnotation `json:"resourceAnnotation,omitempty"`

	// TextAnnotation: Annotations for sensitive texts. For example, a range
	// that describes the location of sensitive text.
	TextAnnotation *SensitiveTextAnnotation `json:"textAnnotation,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AnnotationSource") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AnnotationSource") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Annotation: An annotation record.

func (*Annotation) MarshalJSON added in v0.28.0

func (s *Annotation) MarshalJSON() ([]byte, error)

type AnnotationConfig added in v0.28.0

type AnnotationConfig struct {
	// AnnotationStoreName: The name of the annotation store, in the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/a
	// nnotationStores/{annotation_store_id}`). * The destination annotation
	// store must be in the same project as the source data. De-identifying
	// data across multiple projects is not supported. * The destination
	// annotation store must exist when using DeidentifyDicomStore or
	// DeidentifyFhirStore. DeidentifyDataset automatically creates the
	// destination annotation store.
	AnnotationStoreName string `json:"annotationStoreName,omitempty"`

	// StoreQuote: If set to true, the sensitive texts are included in
	// SensitiveTextAnnotation of Annotation.
	StoreQuote bool `json:"storeQuote,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AnnotationStoreName")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AnnotationStoreName") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AnnotationConfig: Specifies how to store annotations during de-identification operation.

func (*AnnotationConfig) MarshalJSON added in v0.28.0

func (s *AnnotationConfig) MarshalJSON() ([]byte, error)

type AnnotationSource added in v0.28.0

type AnnotationSource struct {
	// CloudHealthcareSource: Cloud Healthcare API resource.
	CloudHealthcareSource *CloudHealthcareSource `json:"cloudHealthcareSource,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "CloudHealthcareSource") to unconditionally include in API requests.
	// By default, fields with empty values are omitted from API requests.
	// However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CloudHealthcareSource") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AnnotationSource: AnnotationSource holds the source information of the annotation.

func (*AnnotationSource) MarshalJSON added in v0.28.0

func (s *AnnotationSource) MarshalJSON() ([]byte, error)

type AnnotationStore added in v0.28.0

type AnnotationStore struct {
	// Labels: Optional. User-supplied key-value pairs used to organize
	// Annotation stores. Label keys must be between 1 and 63 characters
	// long, have a UTF-8 encoding of maximum 128 bytes, and must conform to
	// the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label
	// values must be between 1 and 63 characters long, have a UTF-8
	// encoding of maximum 128 bytes, and must conform to the following PCRE
	// regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64
	// labels can be associated with a given store.
	Labels map[string]string `json:"labels,omitempty"`

	// Name: Resource name of the Annotation store, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/a
	// nnotationStores/{annotation_store_id}`.
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Labels") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Labels") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AnnotationStore: An Annotation store that can store annotation resources such as labels and tags for text, image and audio.

func (*AnnotationStore) MarshalJSON added in v0.28.0

func (s *AnnotationStore) MarshalJSON() ([]byte, error)

type ArchiveUserDataMappingRequest added in v0.33.0

type ArchiveUserDataMappingRequest struct {
}

ArchiveUserDataMappingRequest: Archives the specified User data mapping.

type ArchiveUserDataMappingResponse added in v0.33.0

type ArchiveUserDataMappingResponse struct {
	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`
}

ArchiveUserDataMappingResponse: Archives the specified User data mapping.

type Attribute added in v0.33.0

type Attribute struct {
	// AttributeDefinitionId: Indicates the name of an attribute defined in
	// the consent store.
	AttributeDefinitionId string `json:"attributeDefinitionId,omitempty"`

	// 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.
	Values []string `json:"values,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "AttributeDefinitionId") to unconditionally include in API requests.
	// By default, fields with empty values are omitted from API requests.
	// However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AttributeDefinitionId") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Attribute: An attribute value for a Consent or User data mapping. Each Attribute must have a corresponding AttributeDefinition in the consent store that defines the default and allowed values.

func (*Attribute) MarshalJSON added in v0.33.0

func (s *Attribute) MarshalJSON() ([]byte, error)

type AttributeDefinition added in v0.33.0

type AttributeDefinition struct {
	// AllowedValues: Required. Possible values for the attribute. The
	// number of allowed values must not exceed 100. An empty list is
	// invalid. The list can only be expanded after creation.
	AllowedValues []string `json:"allowedValues,omitempty"`

	// Category: Required. The category of the attribute. The value of this
	// field cannot be changed after creation.
	//
	// Possible values:
	//   "CATEGORY_UNSPECIFIED" - No category specified. This option is
	// invalid.
	//   "RESOURCE" - Specify this category when this attribute describes
	// the properties of resources. For example, data anonymity or data
	// type.
	//   "REQUEST" - Specify this category when this attribute describes the
	// properties of requests. For example, requester's role or requester's
	// organization.
	Category string `json:"category,omitempty"`

	// ConsentDefaultValues: Optional. Default values of the attribute in
	// Consents. If no default values are specified, it defaults to an empty
	// value.
	ConsentDefaultValues []string `json:"consentDefaultValues,omitempty"`

	// DataMappingDefaultValue: Optional. Default value of the attribute in
	// User data mappings. If no default value is specified, it defaults to
	// an empty value. This field is only applicable to attributes of the
	// category `RESOURCE`.
	DataMappingDefaultValue string `json:"dataMappingDefaultValue,omitempty"`

	// Description: Optional. A description of the attribute.
	Description string `json:"description,omitempty"`

	// Name: Resource name of the Attribute definition, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/c
	// onsentStores/{consent_store_id}/attributeDefinitions/{attribute_defini
	// tion_id}`. Cannot be changed after creation.
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AllowedValues") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AllowedValues") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AttributeDefinition: A client-defined consent attribute.

func (*AttributeDefinition) MarshalJSON added in v0.33.0

func (s *AttributeDefinition) MarshalJSON() ([]byte, error)

type AuditConfig

type AuditConfig struct {
	// AuditLogConfigs: The configuration for logging of each type of
	// permission.
	AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`

	// Service: Specifies a service that will be enabled for audit logging.
	// For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
	// `allServices` is a special value that covers all services.
	Service string `json:"service,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AuditLogConfigs") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AuditConfig: Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

func (*AuditConfig) MarshalJSON

func (s *AuditConfig) MarshalJSON() ([]byte, error)

type AuditLogConfig

type AuditLogConfig struct {
	// ExemptedMembers: Specifies the identities that do not cause logging
	// for this type of permission. Follows the same format of
	// Binding.members.
	ExemptedMembers []string `json:"exemptedMembers,omitempty"`

	// LogType: The log type that this config enables.
	//
	// Possible values:
	//   "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
	//   "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
	//   "DATA_WRITE" - Data writes. Example: CloudSQL Users create
	//   "DATA_READ" - Data reads. Example: CloudSQL Users list
	LogType string `json:"logType,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ExemptedMembers") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ExemptedMembers") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AuditLogConfig: Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

func (*AuditLogConfig) MarshalJSON

func (s *AuditLogConfig) MarshalJSON() ([]byte, error)

type BatchGetMessagesResponse added in v0.40.0

type BatchGetMessagesResponse struct {
	// Messages: The returned Messages. See `MessageView` for populated
	// fields.
	Messages []*Message `json:"messages,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Messages") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Messages") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BatchGetMessagesResponse: Gets multiple messages in a specified HL7v2 store.

func (*BatchGetMessagesResponse) MarshalJSON added in v0.40.0

func (s *BatchGetMessagesResponse) MarshalJSON() ([]byte, error)

type Binding

type Binding struct {
	// Condition: The condition that is associated with this binding. If the
	// condition evaluates to `true`, then this binding applies to the
	// current request. If the condition evaluates to `false`, then this
	// binding does not apply to the current request. However, a different
	// role binding might grant the same role to one or more of the members
	// in this binding. To learn which resources support conditions in their
	// IAM policies, see the IAM documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Condition *Expr `json:"condition,omitempty"`

	// Members: Specifies the identities requesting access for a Cloud
	// Platform resource. `members` can have the following values: *
	// `allUsers`: A special identifier that represents anyone who is on the
	// internet; with or without a Google account. *
	// `allAuthenticatedUsers`: A special identifier that represents anyone
	// who is authenticated with a Google account or a service account. *
	// `user:{emailid}`: An email address that represents a specific Google
	// account. For example, `alice@example.com` . *
	// `serviceAccount:{emailid}`: An email address that represents a
	// service account. For example,
	// `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An
	// email address that represents a Google group. For example,
	// `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An
	// email address (plus unique identifier) representing a user that has
	// been recently deleted. For example,
	// `alice@example.com?uid=123456789012345678901`. If the user is
	// recovered, this value reverts to `user:{emailid}` and the recovered
	// user retains the role in the binding. *
	// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address
	// (plus unique identifier) representing a service account that has been
	// recently deleted. For example,
	// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
	// If the service account is undeleted, this value reverts to
	// `serviceAccount:{emailid}` and the undeleted service account retains
	// the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`:
	// An email address (plus unique identifier) representing a Google group
	// that has been recently deleted. For example,
	// `admins@example.com?uid=123456789012345678901`. If the group is
	// recovered, this value reverts to `group:{emailid}` and the recovered
	// group retains the role in the binding. * `domain:{domain}`: The G
	// Suite domain (primary) that represents all the users of that domain.
	// For example, `google.com` or `example.com`.
	Members []string `json:"members,omitempty"`

	// Role: Role that is assigned to `members`. For example,
	// `roles/viewer`, `roles/editor`, or `roles/owner`.
	Role string `json:"role,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Condition") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Condition") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Binding: Associates `members` with a `role`.

func (*Binding) MarshalJSON

func (s *Binding) MarshalJSON() ([]byte, error)

type BoundingPoly added in v0.28.0

type BoundingPoly struct {
	// Label: A description of this polygon.
	Label string `json:"label,omitempty"`

	// Vertices: List of the vertices of this polygon.
	Vertices []*Vertex `json:"vertices,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Label") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Label") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BoundingPoly: A bounding polygon for the detected image annotation.

func (*BoundingPoly) MarshalJSON added in v0.28.0

func (s *BoundingPoly) MarshalJSON() ([]byte, error)

type CancelOperationRequest added in v0.22.0

type CancelOperationRequest struct {
}

CancelOperationRequest: The request message for Operations.CancelOperation.

type CharacterMaskConfig

type CharacterMaskConfig struct {
	// MaskingCharacter: Character to mask the sensitive values. If not
	// supplied, defaults to "*".
	MaskingCharacter string `json:"maskingCharacter,omitempty"`

	// ForceSendFields is a list of field names (e.g. "MaskingCharacter") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MaskingCharacter") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

CharacterMaskConfig: Mask a string by replacing its characters with a fixed character.

func (*CharacterMaskConfig) MarshalJSON

func (s *CharacterMaskConfig) MarshalJSON() ([]byte, error)

type CheckDataAccessRequest added in v0.33.0

type CheckDataAccessRequest struct {
	// ConsentList: Optional. Specific Consents to evaluate the access
	// request against. These Consents must have the same `user_id` as the
	// evaluated User data mapping, must exist in the current
	// `consent_store`, and have a `state` of either `ACTIVE` or `DRAFT`. A
	// maximum of 100 Consents can be provided here. If no selection is
	// specified, the access request is evaluated against all `ACTIVE`
	// unexpired Consents with the same `user_id` as the evaluated User data
	// mapping.
	ConsentList *ConsentList `json:"consentList,omitempty"`

	// DataId: Required. The unique identifier of the resource to check
	// access for. This identifier must correspond to a User data mapping in
	// the given consent store.
	DataId string `json:"dataId,omitempty"`

	// RequestAttributes: The values of request attributes associated with
	// this access request.
	RequestAttributes map[string]string `json:"requestAttributes,omitempty"`

	// ResponseView: Optional. The view for CheckDataAccessResponse. If
	// unspecified, defaults to `BASIC` and returns `consented` as `TRUE` or
	// `FALSE`.
	//
	// Possible values:
	//   "RESPONSE_VIEW_UNSPECIFIED" - No response view specified. The API
	// will default to the BASIC view.
	//   "BASIC" - Only the `consented` field is populated in
	// CheckDataAccessResponse.
	//   "FULL" - All fields within CheckDataAccessResponse are populated.
	// When set to `FULL`, all `ACTIVE` Consents are evaluated even if a
	// matching policy is found during evaluation.
	ResponseView string `json:"responseView,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ConsentList") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConsentList") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CheckDataAccessRequest: Checks if a particular data_id of a User data mapping in the given consent store is consented for a given use.

func (*CheckDataAccessRequest) MarshalJSON added in v0.33.0

func (s *CheckDataAccessRequest) MarshalJSON() ([]byte, error)

type CheckDataAccessResponse added in v0.33.0

type CheckDataAccessResponse struct {
	// ConsentDetails: The resource names of all evaluated Consents mapped
	// to their evaluation.
	ConsentDetails map[string]ConsentEvaluation `json:"consentDetails,omitempty"`

	// Consented: Whether the requested resource is consented for the given
	// use.
	Consented bool `json:"consented,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ConsentDetails") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConsentDetails") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

CheckDataAccessResponse: Checks if a particular data_id of a User data mapping in the given consent store is consented for a given use.

func (*CheckDataAccessResponse) MarshalJSON added in v0.33.0

func (s *CheckDataAccessResponse) MarshalJSON() ([]byte, error)

type CloudHealthcareSource added in v0.28.0

type CloudHealthcareSource struct {
	// Name: Full path of a Cloud Healthcare API resource.
	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Name") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Name") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CloudHealthcareSource: Cloud Healthcare API resource.

func (*CloudHealthcareSource) MarshalJSON added in v0.28.0

func (s *CloudHealthcareSource) MarshalJSON() ([]byte, error)

type ConfigureSearchRequest added in v0.50.0

type ConfigureSearchRequest struct {
	// CanonicalUrls: The canonical URLs of the search parameters that are
	// intended to be used for the FHIR store. See
	// https://www.hl7.org/fhir/references.html#canonical for explanation on
	// FHIR canonical urls
	CanonicalUrls []string `json:"canonicalUrls,omitempty"`

	// ValidateOnly: If `validate_only` is set to true, the method will
	// compile all the search parameters without actually setting the search
	// config for the store and triggering the reindex.
	ValidateOnly bool `json:"validateOnly,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CanonicalUrls") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CanonicalUrls") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ConfigureSearchRequest: Request to configure the search parameters for the specified FHIR store.

func (*ConfigureSearchRequest) MarshalJSON added in v0.50.0

func (s *ConfigureSearchRequest) MarshalJSON() ([]byte, error)
type Consent struct {
	// ConsentArtifact: Required. The resource name of the Consent artifact
	// that contains proof of the end user's consent, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/c
	// onsentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}
	// `.
	ConsentArtifact string `json:"consentArtifact,omitempty"`

	// ExpireTime: Timestamp in UTC of when this Consent is considered
	// expired.
	ExpireTime string `json:"expireTime,omitempty"`

	// Metadata: Optional. User-supplied key-value pairs used to organize
	// Consent resources. Metadata keys must: - be between 1 and 63
	// characters long - have a UTF-8 encoding of maximum 128 bytes - begin
	// with a letter - consist of up to 63 characters including lowercase
	// letters, numeric characters, underscores, and dashes Metadata values
	// must be: - be between 1 and 63 characters long - have a UTF-8
	// encoding of maximum 128 bytes - consist of up to 63 characters
	// including lowercase letters, numeric characters, underscores, and
	// dashes No more than 64 metadata entries can be associated with a
	// given consent.
	Metadata map[string]string `json:"metadata,omitempty"`

	// Name: Resource name of the Consent, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/c
	// onsentStores/{consent_store_id}/consents/{consent_id}`. Cannot be
	// changed after creation.
	Name string `json:"name,omitempty"`

	// Policies: Optional. Represents a user's consent in terms of the
	// resources that can be accessed and under what conditions.
	Policies []*GoogleCloudHealthcareV1beta1ConsentPolicy `json:"policies,omitempty"`

	// RevisionCreateTime: Output only. The timestamp that the revision was
	// created.
	RevisionCreateTime string `json:"revisionCreateTime,omitempty"`

	// RevisionId: Output only. The revision ID of the Consent. The format
	// is an 8-character hexadecimal string. Refer to a specific revision of
	// a Consent by appending `@{revision_id}` to the Consent's resource
	// name.
	RevisionId string `json:"revisionId,omitempty"`

	// State: Required. Indicates the current state of this Consent.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - No state specified. Treated as ACTIVE only at
	// the time of resource creation.
	//   "ACTIVE" - The Consent is active and is considered when evaluating
	// a user's consent on resources.
	//   "ARCHIVED" - When a Consent is updated, the current version is
	// archived and a new one is created with its state set to the updated
	// Consent's previous state.
	//   "REVOKED" - A revoked Consent is not considered when evaluating a
	// user's consent on resources.
	//   "DRAFT" - A draft Consent is not considered when evaluating a
	// user's consent on resources unless explicitly specified.
	//   "REJECTED" - When a draft Consent is rejected by a user, it is set
	// to a rejected state. A rejected Consent is not considered when
	// evaluating a user's consent on resources.
	State string `json:"state,omitempty"`

	// Ttl: Input only. The time to live for this Consent from when it is
	// created.
	Ttl string `json:"ttl,omitempty"`

	// UserId: Required. User's UUID provided by the client.
	UserId string `json:"userId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ConsentArtifact") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConsentArtifact") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Consent: Represents a user's consent.

func (*Consent) MarshalJSON added in v0.33.0

func (s *Consent) MarshalJSON() ([]byte, error)

type ConsentArtifact added in v0.33.0

type ConsentArtifact struct {
	// ConsentContentScreenshots: Optional. Screenshots, PDFs, or other
	// binary information documenting the user's consent.
	ConsentContentScreenshots []*Image `json:"consentContentScreenshots,omitempty"`

	// ConsentContentVersion: Optional. An string indicating the version of
	// the consent information shown to the user.
	ConsentContentVersion string `json:"consentContentVersion,omitempty"`

	// GuardianSignature: Optional. A signature from a guardian.
	GuardianSignature *Signature `json:"guardianSignature,omitempty"`

	// Metadata: Optional. Metadata associated with the Consent artifact.
	// For example, the consent locale or user agent version.
	Metadata map[string]string `json:"metadata,omitempty"`

	// Name: Resource name of the Consent artifact, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/c
	// onsentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}
	// `. Cannot be changed after creation.
	Name string `json:"name,omitempty"`

	// UserId: Required. User's UUID provided by the client.
	UserId string `json:"userId,omitempty"`

	// UserSignature: Optional. User's signature.
	UserSignature *Signature `json:"userSignature,omitempty"`

	// WitnessSignature: Optional. A signature from a witness.
	WitnessSignature *Signature `json:"witnessSignature,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g.
	// "ConsentContentScreenshots") to unconditionally include in API
	// requests. By default, fields with empty values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g.
	// "ConsentContentScreenshots") to include in API requests with the JSON
	// null value. By default, fields with empty values are omitted from API
	// requests. However, any field with an empty value appearing in
	// NullFields will be sent to the server as null. It is an error if a
	// field in this list has a non-empty value. This may be used to include
	// null fields in Patch requests.
	NullFields []string `json:"-"`
}

ConsentArtifact: Documentation of a user's consent.

func (*ConsentArtifact) MarshalJSON added in v0.33.0

func (s *ConsentArtifact) MarshalJSON() ([]byte, error)

type ConsentEvaluation added in v0.33.0

type ConsentEvaluation struct {
	// EvaluationResult: The evaluation result.
	//
	// Possible values:
	//   "EVALUATION_RESULT_UNSPECIFIED" - No evaluation result specified.
	// This option is invalid.
	//   "NOT_APPLICABLE" - The Consent is not applicable to the requested
	// access determination. For example, the Consent does not apply to the
	// user for which the access determination is requested, or it has a
	// `state` of `REVOKED`, or it has expired.
	//   "NO_MATCHING_POLICY" - The Consent does not have a policy that
	// matches the `resource_attributes` of the evaluated resource.
	//   "NO_SATISFIED_POLICY" - The Consent has at least one policy that
	// matches the `resource_attributes` of the evaluated resource, but no
	// `authorization_rule` was satisfied.
	//   "HAS_SATISFIED_POLICY" - The Consent has at least one policy that
	// matches the `resource_attributes` of the evaluated resource, and at
	// least one `authorization_rule` was satisfied.
	EvaluationResult string `json:"evaluationResult,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EvaluationResult") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EvaluationResult") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ConsentEvaluation: The detailed evaluation of a particular Consent.

func (*ConsentEvaluation) MarshalJSON added in v0.33.0

func (s *ConsentEvaluation) MarshalJSON() ([]byte, error)

type ConsentList added in v0.33.0

type ConsentList struct {
	// Consents: The resource names of the Consents to evaluate against, of
	// the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/c
	// onsentStores/{consent_store_id}/consents/{consent_id}`.
	Consents []string `json:"consents,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Consents") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Consents") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ConsentList: List of resource names of Consent resources.

func (*ConsentList) MarshalJSON added in v0.33.0

func (s *ConsentList) MarshalJSON() ([]byte, error)

type ConsentStore added in v0.33.0

type ConsentStore struct {
	// DefaultConsentTtl: Optional. Default time to live for Consents
	// created in this store. Must be at least 24 hours. Updating this field
	// will not affect the expiration time of existing consents.
	DefaultConsentTtl string `json:"defaultConsentTtl,omitempty"`

	// EnableConsentCreateOnUpdate: Optional. If `true`, UpdateConsent
	// creates the Consent if it does not already exist. If unspecified,
	// defaults to `false`.
	EnableConsentCreateOnUpdate bool `json:"enableConsentCreateOnUpdate,omitempty"`

	// Labels: Optional. User-supplied key-value pairs used to organize
	// consent stores. Label keys must be between 1 and 63 characters long,
	// have a UTF-8 encoding of maximum 128 bytes, and must conform to the
	// following PCRE regular expression: \p{Ll}\p{Lo}{0,62}. Label values
	// must be between 1 and 63 characters long, have a UTF-8 encoding of
	// maximum 128 bytes, and must conform to the following PCRE regular
	// expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63}. No more than 64 labels can
	// be associated with a given store. For more information:
	// https://cloud.google.com/healthcare/docs/how-tos/labeling-resources
	Labels map[string]string `json:"labels,omitempty"`

	// Name: Resource name of the consent store, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/c
	// onsentStores/{consent_store_id}`. Cannot be changed after creation.
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "DefaultConsentTtl")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DefaultConsentTtl") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ConsentStore: Represents a consent store.

func (*ConsentStore) MarshalJSON added in v0.33.0

func (s *ConsentStore) MarshalJSON() ([]byte, error)

type CreateMessageRequest

type CreateMessageRequest struct {
	// Message: HL7v2 message.
	Message *Message `json:"message,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Message") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Message") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CreateMessageRequest: Creates a new message.

func (*CreateMessageRequest) MarshalJSON

func (s *CreateMessageRequest) MarshalJSON() ([]byte, error)

type CryptoHashConfig

type CryptoHashConfig struct {
	// CryptoKey: An AES 128/192/256 bit key. Causes the hash to be computed
	// based on this key. A default key is generated for each Deidentify
	// operation and is used wherever crypto_key is not specified.
	CryptoKey string `json:"cryptoKey,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CryptoKey") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CryptoKey") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CryptoHashConfig: Pseudonymization method that generates surrogates via cryptographic hashing. Uses SHA-256. Outputs a base64-encoded representation of the hashed output. For example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`.

func (*CryptoHashConfig) MarshalJSON

func (s *CryptoHashConfig) MarshalJSON() ([]byte, error)

type Dataset

type Dataset struct {
	// Name: Resource name of the dataset, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`.
	Name string `json:"name,omitempty"`

	// TimeZone: The default timezone used by this dataset. Must be a either
	// a valid IANA time zone name such as "America/New_York" or empty,
	// which defaults to UTC. This is used for parsing times in resources,
	// such as HL7 messages, where no explicit timezone is specified.
	TimeZone string `json:"timeZone,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Name") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Name") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Dataset: A message representing a health dataset. A health dataset represents a collection of healthcare data pertaining to one or more patients. This may include multiple modalities of healthcare data, such as electronic medical records or medical imaging data.

func (*Dataset) MarshalJSON

func (s *Dataset) MarshalJSON() ([]byte, error)

type DateShiftConfig

type DateShiftConfig struct {
	// CryptoKey: An AES 128/192/256 bit key. Causes the shift to be
	// computed based on this key and the patient ID. A default key is
	// generated for each Deidentify operation and is used wherever
	// crypto_key is not specified.
	CryptoKey string `json:"cryptoKey,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CryptoKey") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CryptoKey") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DateShiftConfig: Shift a date forward or backward in time by a random amount which is consistent for a given patient and crypto key combination.

func (*DateShiftConfig) MarshalJSON

func (s *DateShiftConfig) MarshalJSON() ([]byte, error)

type DeidentifyConfig

type DeidentifyConfig struct {
	// Annotation: Configures how annotations, meaning that the location and
	// infoType of sensitive information findings, are created during
	// de-identification. If unspecified, no annotations are created.
	Annotation *AnnotationConfig `json:"annotation,omitempty"`

	// Dicom: Configures de-id of application/DICOM content.
	Dicom *DicomConfig `json:"dicom,omitempty"`

	// Fhir: Configures de-id of application/FHIR content.
	Fhir *FhirConfig `json:"fhir,omitempty"`

	// Image: Configures de-identification of image pixels wherever they are
	// found in the source_dataset.
	Image *ImageConfig `json:"image,omitempty"`

	// Text: Configures de-identification of text wherever it is found in
	// the source_dataset.
	Text *TextConfig `json:"text,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Annotation") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Annotation") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DeidentifyConfig: Configures de-id options specific to different types of content. Each submessage customizes the handling of an https://tools.ietf.org/html/rfc6838 media type or subtype. Configs are applied in a nested manner at runtime.

func (*DeidentifyConfig) MarshalJSON

func (s *DeidentifyConfig) MarshalJSON() ([]byte, error)

type DeidentifyDatasetRequest

type DeidentifyDatasetRequest struct {
	// Config: Deidentify configuration.
	Config *DeidentifyConfig `json:"config,omitempty"`

	// DestinationDataset: The name of the dataset resource to create and
	// write the redacted data to. * The destination dataset must not exist.
	// * The destination dataset must be in the same location as the source
	// dataset. De-identifying data across multiple locations is not
	// supported.
	DestinationDataset string `json:"destinationDataset,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Config") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Config") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DeidentifyDatasetRequest: Redacts identifying information from the specified dataset.

func (*DeidentifyDatasetRequest) MarshalJSON

func (s *DeidentifyDatasetRequest) MarshalJSON() ([]byte, error)

type DeidentifyDicomStoreRequest added in v0.12.0

type DeidentifyDicomStoreRequest struct {
	// Config: De-identify configuration.
	Config *DeidentifyConfig `json:"config,omitempty"`

	// DestinationStore: The name of the DICOM store to create and write the
	// redacted data to. For example,
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/d
	// icomStores/{dicom_store_id}`. * The destination dataset must exist. *
	// The source dataset and destination dataset must both reside in the
	// same location. De-identifying data across multiple locations is not
	// supported. * The destination DICOM store must not exist. * The caller
	// must have the necessary permissions to create the destination DICOM
	// store.
	DestinationStore string `json:"destinationStore,omitempty"`

	// FilterConfig: Filter configuration.
	FilterConfig *DicomFilterConfig `json:"filterConfig,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Config") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Config") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DeidentifyDicomStoreRequest: Creates a new DICOM store with sensitive information de-identified.

func (*DeidentifyDicomStoreRequest) MarshalJSON added in v0.12.0

func (s *DeidentifyDicomStoreRequest) MarshalJSON() ([]byte, error)

type DeidentifyFhirStoreRequest added in v0.12.0

type DeidentifyFhirStoreRequest struct {
	// Config: Deidentify configuration.
	Config *DeidentifyConfig `json:"config,omitempty"`

	// DestinationStore: The name of the FHIR store to create and write the
	// redacted data to. For example,
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/f
	// hirStores/{fhir_store_id}`. * The destination dataset must exist. *
	// The source dataset and destination dataset must both reside in the
	// same location. De-identifying data across multiple locations is not
	// supported. * The destination FHIR store must exist. * The caller must
	// have the healthcare.fhirResources.update permission to write to the
	// destination FHIR store.
	DestinationStore string `json:"destinationStore,omitempty"`

	// ResourceFilter: A filter specifying the resources to include in the
	// output. If not specified, all resources are included in the output.
	ResourceFilter *FhirFilter `json:"resourceFilter,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Config") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Config") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DeidentifyFhirStoreRequest: Creates a new FHIR store with sensitive information de-identified.

func (*DeidentifyFhirStoreRequest) MarshalJSON added in v0.12.0

func (s *DeidentifyFhirStoreRequest) MarshalJSON() ([]byte, error)

type DeidentifySummary

type DeidentifySummary struct {
}

DeidentifySummary: Contains a detailed summary of the Deidentify operation.

type Detail added in v0.28.0

type Detail struct {
	Findings []*Finding `json:"findings,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Findings") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Findings") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Detail: Contains multiple sensitive information findings for each resource slice.

func (*Detail) MarshalJSON added in v0.28.0

func (s *Detail) MarshalJSON() ([]byte, error)

type DicomConfig

type DicomConfig struct {
	// FilterProfile: Tag filtering profile that determines which tags to
	// keep/remove.
	//
	// Possible values:
	//   "TAG_FILTER_PROFILE_UNSPECIFIED" - No tag filtration profile
	// provided. Same as KEEP_ALL_PROFILE.
	//   "MINIMAL_KEEP_LIST_PROFILE" - Keep only tags required to produce
	// valid DICOM.
	//   "ATTRIBUTE_CONFIDENTIALITY_BASIC_PROFILE" - Remove tags based on
	// DICOM Standard's Attribute Confidentiality Basic Profile (DICOM
	// Standard Edition 2018e)
	// http://dicom.nema.org/medical/dicom/2018e/output/chtml/part15/chapter_E.html.
	//   "KEEP_ALL_PROFILE" - Keep all tags.
	//   "DEIDENTIFY_TAG_CONTENTS" - Inspects within tag contents and
	// replaces sensitive text. The process can be configured using the
	// TextConfig. Applies to all tags with the following Value
	// Representation names: AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS
	FilterProfile string `json:"filterProfile,omitempty"`

	// KeepList: List of tags to keep. Remove all other tags.
	KeepList *TagFilterList `json:"keepList,omitempty"`

	// RemoveList: List of tags to remove. Keep all other tags.
	RemoveList *TagFilterList `json:"removeList,omitempty"`

	// SkipIdRedaction: If true, skip replacing StudyInstanceUID,
	// SeriesInstanceUID, SOPInstanceUID, and MediaStorageSOPInstanceUID and
	// leave them untouched. The Cloud Healthcare API regenerates these UIDs
	// by default based on the DICOM Standard's reasoning: "Whilst these
	// UIDs cannot be mapped directly to an individual out of context, given
	// access to the original images, or to a database of the original
	// images containing the UIDs, it would be possible to recover the
	// individual's identity."
	// http://dicom.nema.org/medical/dicom/current/output/chtml/part15/sect_E.3.9.html
	SkipIdRedaction bool `json:"skipIdRedaction,omitempty"`

	// ForceSendFields is a list of field names (e.g. "FilterProfile") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "FilterProfile") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DicomConfig: Specifies the parameters needed for de-identification of DICOM stores.

func (*DicomConfig) MarshalJSON

func (s *DicomConfig) MarshalJSON() ([]byte, error)

type DicomFilterConfig added in v0.12.0

type DicomFilterConfig struct {
	// ResourcePathsGcsUri: The Cloud Storage location of the filter
	// configuration file. The `gcs_uri` must be in the format
	// `gs://bucket/path/to/object`. The filter configuration file must
	// contain a list of resource paths separated by newline characters (\n
	// or \r\n). Each resource path must be in the format
	// "/studies/{studyUID}[/series/{seriesUID}[/instances/{instanceUID}]]"
	// The Cloud Healthcare API service account must have the
	// `roles/storage.objectViewer` Cloud IAM role for this Cloud Storage
	// location.
	ResourcePathsGcsUri string `json:"resourcePathsGcsUri,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ResourcePathsGcsUri")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ResourcePathsGcsUri") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

DicomFilterConfig: Specifies the filter configuration for DICOM resources.

func (*DicomFilterConfig) MarshalJSON added in v0.12.0

func (s *DicomFilterConfig) MarshalJSON() ([]byte, error)

type DicomStore

type DicomStore struct {
	// Labels: User-supplied key-value pairs used to organize DICOM stores.
	// Label keys must be between 1 and 63 characters long, have a UTF-8
	// encoding of maximum 128 bytes, and must conform to the following PCRE
	// regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional,
	// must be between 1 and 63 characters long, have a UTF-8 encoding of
	// maximum 128 bytes, and must conform to the following PCRE regular
	// expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be
	// associated with a given store.
	Labels map[string]string `json:"labels,omitempty"`

	// Name: Resource name of the DICOM store, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/d
	// icomStores/{dicom_store_id}`.
	Name string `json:"name,omitempty"`

	// NotificationConfig: Notification destination for new DICOM instances.
	// Supplied by the client.
	NotificationConfig *NotificationConfig `json:"notificationConfig,omitempty"`

	// StreamConfigs: A list of streaming configs used to configure the
	// destination of streaming exports for every DICOM instance insertion
	// in this DICOM store. After a new config is added to `stream_configs`,
	// DICOM instance insertions are streamed to the new destination. When a
	// config is removed from `stream_configs`, the server stops streaming
	// to that destination. Each config must contain a unique destination.
	StreamConfigs []*GoogleCloudHealthcareV1beta1DicomStreamConfig `json:"streamConfigs,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Labels") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Labels") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DicomStore: Represents a DICOM store.

func (*DicomStore) MarshalJSON

func (s *DicomStore) MarshalJSON() ([]byte, error)

type Empty

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`
}

Empty: 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 `{}`.

type Entity added in v0.35.0

type Entity struct {
	// EntityId: entity_id is a first class field entity_id uniquely
	// identifies this concept and its meta-vocabulary. For example,
	// "UMLS/C0000970".
	EntityId string `json:"entityId,omitempty"`

	// PreferredTerm: preferred_term is the preferred term for this concept.
	// For example, "Acetaminophen". For ad hoc entities formed by
	// normalization, this is the most popular unnormalized string.
	PreferredTerm string `json:"preferredTerm,omitempty"`

	// VocabularyCodes: Vocabulary codes are first-class fields and
	// differentiated from the concept unique identifier (entity_id).
	// vocabulary_codes contains the representation of this concept in
	// particular vocabularies, such as ICD-10, SNOMED-CT and RxNORM. These
	// are prefixed by the name of the vocabulary, followed by the unique
	// code within that vocabulary. For example, "RXNORM/A10334543".
	VocabularyCodes []string `json:"vocabularyCodes,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EntityId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EntityId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Entity: The candidate entities that an entity mention could link to.

func (*Entity) MarshalJSON added in v0.35.0

func (s *Entity) MarshalJSON() ([]byte, error)

type EntityMention added in v0.35.0

type EntityMention struct {
	// CertaintyAssessment: The certainty assessment of the entity mention.
	// Its value is one of: LIKELY, SOMEWHAT_LIKELY, UNCERTAIN,
	// SOMEWHAT_UNLIKELY, UNLIKELY, CONDITIONAL
	CertaintyAssessment *Feature `json:"certaintyAssessment,omitempty"`

	// Confidence: The model's confidence in this entity mention annotation.
	// A number between 0 and 1.
	Confidence float64 `json:"confidence,omitempty"`

	// LinkedEntities: linked_entities are candidate ontological concepts
	// that this entity mention may refer to. They are sorted by decreasing
	// confidence.it
	LinkedEntities []*LinkedEntity `json:"linkedEntities,omitempty"`

	// MentionId: mention_id uniquely identifies each entity mention in a
	// single response.
	MentionId string `json:"mentionId,omitempty"`

	// Subject: The subject this entity mention relates to. Its value is one
	// of: PATIENT, FAMILY_MEMBER, OTHER
	Subject *Feature `json:"subject,omitempty"`

	// TemporalAssessment: How this entity mention relates to the subject
	// temporally. Its value is one of: CURRENT, CLINICAL_HISTORY,
	// FAMILY_HISTORY, UPCOMING, ALLERGY
	TemporalAssessment *Feature `json:"temporalAssessment,omitempty"`

	// Text: text is the location of the entity mention in the document.
	Text *TextSpan `json:"text,omitempty"`

	// Type: The semantic type of the entity: UNKNOWN_ENTITY_TYPE, ALONE,
	// ANATOMICAL_STRUCTURE, ASSISTED_LIVING, BF_RESULT, BM_RESULT, BM_UNIT,
	// BM_VALUE, BODY_FUNCTION, BODY_MEASUREMENT, COMPLIANT,
	// DOESNOT_FOLLOWUP, FAMILY, FOLLOWSUP, LABORATORY_DATA, LAB_RESULT,
	// LAB_UNIT, LAB_VALUE, MEDICAL_DEVICE, MEDICINE, MED_DOSE,
	// MED_DURATION, MED_FORM, MED_FREQUENCY, MED_ROUTE, MED_STATUS,
	// MED_STRENGTH, MED_TOTALDOSE, MED_UNIT, NON_COMPLIANT,
	// OTHER_LIVINGSTATUS, PROBLEM, PROCEDURE, PROCEDURE_RESULT,
	// PROC_METHOD, REASON_FOR_NONCOMPLIANCE, SEVERITY, SUBSTANCE_ABUSE,
	// UNCLEAR_FOLLOWUP.
	Type string `json:"type,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CertaintyAssessment")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CertaintyAssessment") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

EntityMention: An entity mention in the document.

func (*EntityMention) MarshalJSON added in v0.35.0

func (s *EntityMention) MarshalJSON() ([]byte, error)

func (*EntityMention) UnmarshalJSON added in v0.35.0

func (s *EntityMention) UnmarshalJSON(data []byte) error

type EntityMentionRelationship added in v0.35.0

type EntityMentionRelationship struct {
	// Confidence: The model's confidence in this annotation. A number
	// between 0 and 1.
	Confidence float64 `json:"confidence,omitempty"`

	// ObjectId: object_id is the id of the object entity mention.
	ObjectId string `json:"objectId,omitempty"`

	// SubjectId: subject_id is the id of the subject entity mention.
	SubjectId string `json:"subjectId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Confidence") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Confidence") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

EntityMentionRelationship: Defines directed relationship from one entity mention to another.

func (*EntityMentionRelationship) MarshalJSON added in v0.35.0

func (s *EntityMentionRelationship) MarshalJSON() ([]byte, error)

func (*EntityMentionRelationship) UnmarshalJSON added in v0.35.0

func (s *EntityMentionRelationship) UnmarshalJSON(data []byte) error

type EvaluateAnnotationStoreRequest added in v0.28.0

type EvaluateAnnotationStoreRequest struct {
	// BigqueryDestination: The BigQuery table where the server writes the
	// output. BigQueryDestination requires the `roles/bigquery.dataEditor`
	// and `roles/bigquery.jobUser` Cloud IAM roles.
	BigqueryDestination *GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination `json:"bigqueryDestination,omitempty"`

	// EvalInfoTypeMapping: Optional. InfoType mapping for `eval_store`.
	// Different resources can map to the same infoType. For example,
	// `PERSON_NAME`, `PERSON`, `NAME`, and `HUMAN` are different. To map
	// all of these into a single infoType (such as `PERSON_NAME`), specify
	// the following mapping: “` info_type_mapping["PERSON"] =
	// "PERSON_NAME" info_type_mapping["NAME"] = "PERSON_NAME"
	// info_type_mapping["HUMAN"] = "PERSON_NAME" “` Unmentioned infoTypes,
	// such as `DATE`, are treated as identity mapping. For example: “`
	// info_type_mapping["DATE"] = "DATE" “` InfoTypes are
	// case-insensitive.
	EvalInfoTypeMapping map[string]string `json:"evalInfoTypeMapping,omitempty"`

	// GoldenInfoTypeMapping: Optional. Similar to `eval_info_type_mapping`,
	// infoType mapping for `golden_store`.
	GoldenInfoTypeMapping map[string]string `json:"goldenInfoTypeMapping,omitempty"`

	// GoldenStore: The Annotation store to use as ground truth, in the
	// format of
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/a
	// nnotationStores/{annotation_store_id}`.
	GoldenStore string `json:"goldenStore,omitempty"`

	InfoTypeConfig *InfoTypeConfig `json:"infoTypeConfig,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BigqueryDestination")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BigqueryDestination") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

EvaluateAnnotationStoreRequest: Request to evaluate an Annotation store against a ground truth [Annotation store].

func (*EvaluateAnnotationStoreRequest) MarshalJSON added in v0.28.0

func (s *EvaluateAnnotationStoreRequest) MarshalJSON() ([]byte, error)

type EvaluateAnnotationStoreResponse added in v0.28.0

type EvaluateAnnotationStoreResponse struct {
}

EvaluateAnnotationStoreResponse: Response for successful Annotation store evaluation operations. This structure is included in the response upon operation completion.

type EvaluateUserConsentsRequest added in v0.33.0

type EvaluateUserConsentsRequest struct {
	// ConsentList: Optional. Specific Consents to evaluate the access
	// request against. These Consents must have the same `user_id` as the
	// User data mappings being evalauted, must exist in the current
	// `consent_store`, and must have a `state` of either `ACTIVE` or
	// `DRAFT`. A maximum of 100 Consents can be provided here. If
	// unspecified, all `ACTIVE` unexpired Consents in the current
	// `consent_store` will be evaluated.
	ConsentList *ConsentList `json:"consentList,omitempty"`

	// PageSize: Optional. Limit on the number of User data mappings to
	// return in a single response. If not specified, 100 is used. May not
	// be larger than 1000.
	PageSize int64 `json:"pageSize,omitempty"`

	// PageToken: Optional. Token to retrieve the next page of results, or
	// empty to get the first page.
	PageToken string `json:"pageToken,omitempty"`

	// RequestAttributes: Required. The values of request attributes
	// associated with this access request.
	RequestAttributes map[string]string `json:"requestAttributes,omitempty"`

	// ResourceAttributes: Optional. The values of resource attributes
	// associated with the resources being requested. If no values are
	// specified, then all resources are queried.
	ResourceAttributes map[string]string `json:"resourceAttributes,omitempty"`

	// ResponseView: Optional. The view for EvaluateUserConsentsResponse. If
	// unspecified, defaults to `BASIC` and returns `consented` as `TRUE` or
	// `FALSE`.
	//
	// Possible values:
	//   "RESPONSE_VIEW_UNSPECIFIED" - No response view specified. The API
	// will default to the BASIC view.
	//   "BASIC" - Only the `data_id` and `consented` fields are populated
	// in the response.
	//   "FULL" - All fields within the response are populated. When set to
	// `FULL`, all `ACTIVE` Consents are evaluated even if a matching policy
	// is found during evaluation.
	ResponseView string `json:"responseView,omitempty"`

	// UserId: Required. User ID to evaluate consents for.
	UserId string `json:"userId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ConsentList") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConsentList") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

EvaluateUserConsentsRequest: Evaluate a user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, causing slight delays between the time mappings are created or updated and when they are included in EvaluateUserConsents results.

func (*EvaluateUserConsentsRequest) MarshalJSON added in v0.33.0

func (s *EvaluateUserConsentsRequest) MarshalJSON() ([]byte, error)

type EvaluateUserConsentsResponse added in v0.33.0

type EvaluateUserConsentsResponse struct {
	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results in the list. This token is valid for 72
	// hours after it is created.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Results: The consent evaluation result for each `data_id`.
	Results []*Result `json:"results,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*EvaluateUserConsentsResponse) MarshalJSON added in v0.33.0

func (s *EvaluateUserConsentsResponse) MarshalJSON() ([]byte, error)

type ExportAnnotationsRequest added in v0.28.0

type ExportAnnotationsRequest struct {
	// BigqueryDestination: The BigQuery output destination, which requires
	// two IAM roles: `roles/bigquery.dataEditor` and
	// `roles/bigquery.jobUser`.
	BigqueryDestination *GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination `json:"bigqueryDestination,omitempty"`

	// GcsDestination: The Cloud Storage destination, which requires the
	// `roles/storage.objectAdmin` Cloud IAM role.
	GcsDestination *GoogleCloudHealthcareV1beta1AnnotationGcsDestination `json:"gcsDestination,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BigqueryDestination")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BigqueryDestination") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ExportAnnotationsRequest: Request to export Annotations. The export operation is not atomic. If a failure occurs, any annotations already exported are not removed.

func (*ExportAnnotationsRequest) MarshalJSON added in v0.28.0

func (s *ExportAnnotationsRequest) MarshalJSON() ([]byte, error)

type ExportAnnotationsResponse added in v0.28.0

type ExportAnnotationsResponse struct {
}

ExportAnnotationsResponse: Response for successful annotation export operations. This structure is included in response upon operation completion.

type ExportDicomDataRequest

type ExportDicomDataRequest struct {
	// BigqueryDestination: The BigQuery output destination. You can only
	// export to a BigQuery dataset that's in the same project as the DICOM
	// store you're exporting from. The Cloud Healthcare Service Agent
	// requires two IAM roles on the BigQuery location:
	// `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`.
	BigqueryDestination *GoogleCloudHealthcareV1beta1DicomBigQueryDestination `json:"bigqueryDestination,omitempty"`

	// FilterConfig: Specifies the filter configuration.
	FilterConfig *DicomFilterConfig `json:"filterConfig,omitempty"`

	// GcsDestination: The Cloud Storage output destination. The Cloud
	// Healthcare Service Agent requires the `roles/storage.objectAdmin`
	// Cloud IAM roles on the Cloud Storage location.
	GcsDestination *GoogleCloudHealthcareV1beta1DicomGcsDestination `json:"gcsDestination,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BigqueryDestination")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BigqueryDestination") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ExportDicomDataRequest: Exports data from the specified DICOM store. If a given resource, such as a DICOM object with the same SOPInstance UID, already exists in the output, it is overwritten with the version in the source dataset. Exported DICOM data persists when the DICOM store from which it was exported is deleted.

func (*ExportDicomDataRequest) MarshalJSON

func (s *ExportDicomDataRequest) MarshalJSON() ([]byte, error)

type ExportDicomDataResponse added in v0.22.0

type ExportDicomDataResponse struct {
}

ExportDicomDataResponse: Returns additional information in regards to a completed DICOM store export.

type ExportMessagesRequest added in v0.34.0

type ExportMessagesRequest struct {
	// EndTime: The end of the range in `send_time` (MSH.7,
	// https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm)
	// to process. If not specified, the time when the export is scheduled
	// is used. This value has to come after the `start_time` defined below.
	// Only messages whose `send_time` lies in the range `start_time`
	// (inclusive) to `end_time` (exclusive) are exported.
	EndTime string `json:"endTime,omitempty"`

	// GcsDestination: Export to a Cloud Storage destination.
	GcsDestination *GcsDestination `json:"gcsDestination,omitempty"`

	// StartTime: The start of the range in `send_time` (MSH.7,
	// https://www.hl7.org/documentcenter/public_temp_2E58C1F9-1C23-BA17-0C6126475344DA9D/wg/conf/HL7MSH.htm)
	// to process. If not specified, the UNIX epoch (1970-01-01T00:00:00Z)
	// is used. This value has to come before the `end_time` defined below.
	// Only messages whose `send_time` lies in the range `start_time`
	// (inclusive) to `end_time` (exclusive) are exported.
	StartTime string `json:"startTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EndTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EndTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ExportMessagesRequest: Request to schedule an export.

func (*ExportMessagesRequest) MarshalJSON added in v0.34.0

func (s *ExportMessagesRequest) MarshalJSON() ([]byte, error)

type ExportResourcesRequest

type ExportResourcesRequest struct {
	// Since: If provided, only resources updated after this time are
	// exported. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For
	// example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`.
	// The time must be specified to the second and include a time zone.
	Since string `json:"_since,omitempty"`

	// Type: String of comma-delimited FHIR resource types. If provided,
	// only resources of the specified resource type(s) are exported.
	Type string `json:"_type,omitempty"`

	// BigqueryDestination: The BigQuery output destination. The Cloud
	// Healthcare Service Agent requires two IAM roles on the BigQuery
	// location: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`.
	// The output is one BigQuery table per resource type. Unlike when
	// setting `BigQueryDestination` for `StreamConfig`, `ExportResources`
	// does not create BigQuery views.
	BigqueryDestination *GoogleCloudHealthcareV1beta1FhirBigQueryDestination `json:"bigqueryDestination,omitempty"`

	// GcsDestination: The Cloud Storage output destination. The Cloud
	// Healthcare Service Agent requires the `roles/storage.objectAdmin`
	// Cloud IAM roles on the Cloud Storage location. The exported outputs
	// are organized by FHIR resource types. The server creates one object
	// per resource type. Each object contains newline delimited JSON, and
	// each line is a FHIR resource.
	GcsDestination *GoogleCloudHealthcareV1beta1FhirGcsDestination `json:"gcsDestination,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Since") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Since") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ExportResourcesRequest: Request to export resources.

func (*ExportResourcesRequest) MarshalJSON

func (s *ExportResourcesRequest) MarshalJSON() ([]byte, error)

type Expr

type Expr struct {
	// Description: Optional. Description of the expression. This is a
	// longer text which describes the expression, e.g. when hovered over it
	// in a UI.
	Description string `json:"description,omitempty"`

	// Expression: Textual representation of an expression in Common
	// Expression Language syntax.
	Expression string `json:"expression,omitempty"`

	// Location: Optional. String indicating the location of the expression
	// for error reporting, e.g. a file name and a position in the file.
	Location string `json:"location,omitempty"`

	// Title: Optional. Title for the expression, i.e. a short string
	// describing its purpose. This can be used e.g. in UIs which allow to
	// enter the expression.
	Title string `json:"title,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Description") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Expr: Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

func (*Expr) MarshalJSON

func (s *Expr) MarshalJSON() ([]byte, error)

type Feature added in v0.35.0

type Feature struct {
	// Confidence: The model's confidence in this feature annotation. A
	// number between 0 and 1.
	Confidence float64 `json:"confidence,omitempty"`

	// Value: The value of this feature annotation. Its range depends on the
	// type of the feature.
	Value string `json:"value,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Confidence") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Confidence") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Feature: A feature of an entity mention.

func (*Feature) MarshalJSON added in v0.35.0

func (s *Feature) MarshalJSON() ([]byte, error)

func (*Feature) UnmarshalJSON added in v0.35.0

func (s *Feature) UnmarshalJSON(data []byte) error

type FhirConfig

type FhirConfig struct {
	// FieldMetadataList: Specifies FHIR paths to match and how to transform
	// them. Any field that is not matched by a FieldMetadata is passed
	// through to the output dataset unmodified. All extensions are removed
	// in the output. If a field can be matched by more than one
	// FieldMetadata, the first FieldMetadata.Action is applied.
	FieldMetadataList []*FieldMetadata `json:"fieldMetadataList,omitempty"`

	// ForceSendFields is a list of field names (e.g. "FieldMetadataList")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "FieldMetadataList") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

FhirConfig: Specifies how to handle de-identification of a FHIR store.

func (*FhirConfig) MarshalJSON

func (s *FhirConfig) MarshalJSON() ([]byte, error)

type FhirFilter added in v0.12.0

type FhirFilter struct {
	// Resources: List of resources to include in the output. If this list
	// is empty or not specified, all resources are included in the output.
	Resources *Resources `json:"resources,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Resources") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Resources") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

FhirFilter: Filter configuration.

func (*FhirFilter) MarshalJSON added in v0.12.0

func (s *FhirFilter) MarshalJSON() ([]byte, error)

type FhirStore

type FhirStore struct {
	// DefaultSearchHandlingStrict: If true, overrides the default search
	// behavior for this FHIR store to `handling=strict` which returns an
	// error for unrecognized search parameters. If false, uses the FHIR
	// specification default `handling=lenient` which ignores unrecognized
	// search parameters. The handling can always be changed from the
	// default on an individual API call by setting the HTTP header `Prefer:
	// handling=strict` or `Prefer: handling=lenient`.
	DefaultSearchHandlingStrict bool `json:"defaultSearchHandlingStrict,omitempty"`

	// DisableReferentialIntegrity: Immutable. Whether to disable
	// referential integrity in this FHIR store. This field is immutable
	// after FHIR store creation. The default value is false, meaning that
	// the API enforces referential integrity and fails the requests that
	// result in inconsistent state in the FHIR store. When this field is
	// set to true, the API skips referential integrity checks.
	// Consequently, operations that rely on references, such as
	// GetPatientEverything, do not return all the results if broken
	// references exist.
	DisableReferentialIntegrity bool `json:"disableReferentialIntegrity,omitempty"`

	// DisableResourceVersioning: Immutable. Whether to disable resource
	// versioning for this FHIR store. This field can not be changed after
	// the creation of FHIR store. If set to false, which is the default
	// behavior, all write operations cause historical versions to be
	// recorded automatically. The historical versions can be fetched
	// through the history APIs, but cannot be updated. If set to true, no
	// historical versions are kept. The server sends errors for attempts to
	// read the historical versions.
	DisableResourceVersioning bool `json:"disableResourceVersioning,omitempty"`

	// EnableUpdateCreate: Whether this FHIR store has the updateCreate
	// capability
	// (https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate).
	// This determines if the client can use an Update operation to create a
	// new resource with a client-specified ID. If false, all IDs are
	// server-assigned through the Create operation and attempts to update a
	// non-existent resource return errors. It is strongly advised not to
	// include or encode any sensitive data such as patient identifiers in
	// client-specified resource IDs. Those IDs are part of the FHIR
	// resource path recorded in Cloud audit logs and Pub/Sub notifications.
	// Those IDs can also be contained in reference fields within other
	// resources.
	EnableUpdateCreate bool `json:"enableUpdateCreate,omitempty"`

	// Labels: User-supplied key-value pairs used to organize FHIR stores.
	// Label keys must be between 1 and 63 characters long, have a UTF-8
	// encoding of maximum 128 bytes, and must conform to the following PCRE
	// regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional,
	// must be between 1 and 63 characters long, have a UTF-8 encoding of
	// maximum 128 bytes, and must conform to the following PCRE regular
	// expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be
	// associated with a given store.
	Labels map[string]string `json:"labels,omitempty"`

	// Name: Output only. Resource name of the FHIR store, of the form
	// `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id
	// }`.
	Name string `json:"name,omitempty"`

	// NotificationConfig: If non-empty, publish all resource modifications
	// of this FHIR store to this destination. The Pub/Sub message
	// attributes contain a map with a string describing the action that has
	// triggered the notification. For example, "action":"CreateResource".
	NotificationConfig *NotificationConfig `json:"notificationConfig,omitempty"`

	// SearchConfig: Configuration for how FHIR resource can be searched.
	SearchConfig *SearchConfig `json:"searchConfig,omitempty"`

	// StreamConfigs: A list of streaming configs that configure the
	// destinations of streaming export for every resource mutation in this
	// FHIR store. Each store is allowed to have up to 10 streaming configs.
	// After a new config is added, the next resource mutation is streamed
	// to the new location in addition to the existing ones. When a location
	// is removed from the list, the server stops streaming to that
	// location. Before adding a new config, you must add the required
	// `bigquery.dataEditor`
	// (https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor)
	// role to your project's **Cloud Healthcare Service Agent** service
	// account (https://cloud.google.com/iam/docs/service-accounts). Some
	// lag (typically on the order of dozens of seconds) is expected before
	// the results show up in the streaming destination.
	StreamConfigs []*StreamConfig `json:"streamConfigs,omitempty"`

	// ValidationConfig: Configuration for how to validate incoming FHIR
	// resources against configured profiles.
	ValidationConfig *ValidationConfig `json:"validationConfig,omitempty"`

	// Version: Immutable. The FHIR specification version that this FHIR
	// store supports natively. This field is immutable after store
	// creation. Requests are rejected if they contain FHIR resources of a
	// different version. Version is required for every FHIR store.
	//
	// Possible values:
	//   "VERSION_UNSPECIFIED" - VERSION_UNSPECIFIED is treated as STU3 to
	// accommodate the existing FHIR stores.
	//   "DSTU2" - Draft Standard for Trial Use, [Release
	// 2](https://www.hl7.org/fhir/DSTU2)
	//   "STU3" - Standard for Trial Use, [Release
	// 3](https://www.hl7.org/fhir/STU3)
	//   "R4" - [Release 4](https://www.hl7.org/fhir/R4)
	Version string `json:"version,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g.
	// "DefaultSearchHandlingStrict") to unconditionally include in API
	// requests. By default, fields with empty values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g.
	// "DefaultSearchHandlingStrict") to include in API requests with the
	// JSON null value. By default, fields with empty values are omitted
	// from API requests. However, any field with an empty value appearing
	// in NullFields will be sent to the server as null. It is an error if a
	// field in this list has a non-empty value. This may be used to include
	// null fields in Patch requests.
	NullFields []string `json:"-"`
}

FhirStore: Represents a FHIR store.

func (*FhirStore) MarshalJSON

func (s *FhirStore) MarshalJSON() ([]byte, error)

type Field added in v0.22.0

type Field struct {
	// MaxOccurs: The maximum number of times this field can be repeated. 0
	// or -1 means unbounded.
	MaxOccurs int64 `json:"maxOccurs,omitempty"`

	// MinOccurs: The minimum number of times this field must be
	// present/repeated.
	MinOccurs int64 `json:"minOccurs,omitempty"`

	// Name: The name of the field. For example, "PID-1" or just "1".
	Name string `json:"name,omitempty"`

	// Table: The HL7v2 table this field refers to. For example, PID-15
	// (Patient's Primary Language) usually refers to table "0296".
	Table string `json:"table,omitempty"`

	// Type: The type of this field. A Type with this name must be defined
	// in an Hl7TypesConfig.
	Type string `json:"type,omitempty"`

	// ForceSendFields is a list of field names (e.g. "MaxOccurs") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MaxOccurs") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Field: A (sub) field of a type.

func (*Field) MarshalJSON added in v0.22.0

func (s *Field) MarshalJSON() ([]byte, error)

type FieldMetadata

type FieldMetadata struct {
	// Action: Deidentify action for one field.
	//
	// Possible values:
	//   "ACTION_UNSPECIFIED" - No action specified.
	//   "TRANSFORM" - Transform the entire field based on transformations
	// specified in TextConfig. When the specified transformation cannot be
	// applied to a field, RedactConfig is used. For example, a Crypto Hash
	// transformation can't be applied to a FHIR Date field.
	//   "INSPECT_AND_TRANSFORM" - Inspect and transform any found PHI. When
	// `AnnotationConfig` is provided, annotations of PHI will be generated,
	// except for Date and Datetime.
	//   "DO_NOT_TRANSFORM" - Do not transform.
	Action string `json:"action,omitempty"`

	// Paths: List of paths to FHIR fields to redact. Each path is a
	// period-separated list where each component is either a field name or
	// FHIR type name. All types begin with an upper case letter. For
	// example, the resource field "Patient.Address.city", which uses a
	// string type, can be matched by "Patient.Address.String". Path also
	// supports partial matching. For example, "Patient.Address.city" can be
	// matched by "Address.city" (Patient omitted). Partial matching and
	// type matching can be combined. For example, "Patient.Address.city"
	// can be matched by "Address.String". For "choice" types (those defined
	// in the FHIR spec with the form: field[x]), use two separate
	// components. For example, "deceasedAge.unit" is matched by
	// "Deceased.Age.unit". Supported types are: AdministrativeGenderCode,
	// Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown,
	// Oid, String, Uri, Uuid, Xhtml. The sub-type for HumanName, such as
	// HumanName.given or HumanName.family, can be omitted.
	Paths []string `json:"paths,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Action") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Action") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

FieldMetadata: Specifies FHIR paths to match, and how to handle de-identification of matching fields.

func (*FieldMetadata) MarshalJSON

func (s *FieldMetadata) MarshalJSON() ([]byte, error)

type FilterList added in v0.28.0

type FilterList struct {
	// InfoTypes: These infoTypes are based on after the
	// `eval_info_type_mapping` and `golden_info_type_mapping`.
	InfoTypes []string `json:"infoTypes,omitempty"`

	// ForceSendFields is a list of field names (e.g. "InfoTypes") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "InfoTypes") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

FilterList: List of infoTypes to be filtered.

func (*FilterList) MarshalJSON added in v0.28.0

func (s *FilterList) MarshalJSON() ([]byte, error)

type Finding added in v0.28.0

type Finding struct {
	// End: Zero-based ending index of the found text, exclusively.
	End int64 `json:"end,omitempty,string"`

	// InfoType: The type of information stored in this text range. For
	// example, HumanName, BirthDate, or Address.
	InfoType string `json:"infoType,omitempty"`

	// Quote: The snippet of the sensitive text. This field is only
	// populated during deidentification if `store_quote` is set to true in
	// DeidentifyConfig.
	Quote string `json:"quote,omitempty"`

	// Start: Zero-based starting index of the found text, inclusively.
	Start int64 `json:"start,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "End") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "End") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*Finding) MarshalJSON added in v0.28.0

func (s *Finding) MarshalJSON() ([]byte, error)

type GcsDestination added in v0.34.0

type GcsDestination struct {
	// ContentStructure: The format of the exported HL7v2 message files.
	//
	// Possible values:
	//   "CONTENT_STRUCTURE_UNSPECIFIED" - If the content structure is not
	// specified, the default value `MESSAGE_JSON` will be used.
	//   "MESSAGE_JSON" - Messages are printed using the JSON format
	// returned from the `GetMessage` API. Messages are delimited with
	// newlines.
	ContentStructure string `json:"contentStructure,omitempty"`

	// MessageView: Specifies the parts of the Message resource to include
	// in the export. If not specified, FULL is used.
	//
	// Possible values:
	//   "MESSAGE_VIEW_UNSPECIFIED" - Not specified, equivalent to FULL for
	// getMessage, equivalent to BASIC for listMessages.
	//   "RAW_ONLY" - Server responses include all the message fields except
	// parsed_data, and schematized_data fields.
	//   "PARSED_ONLY" - Server responses include all the message fields
	// except data and schematized_data fields.
	//   "FULL" - Server responses include all the message fields.
	//   "SCHEMATIZED_ONLY" - Server responses include all the message
	// fields except data and parsed_data fields.
	//   "BASIC" - Server responses include only the name field.
	MessageView string `json:"messageView,omitempty"`

	// UriPrefix: URI of an existing Cloud Storage directory where the
	// server writes result files, in the format
	// `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing
	// slash, the service appends one when composing the object path.
	UriPrefix string `json:"uriPrefix,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ContentStructure") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ContentStructure") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GcsDestination: The Cloud Storage output destination. The Cloud Healthcare Service Agent requires the `roles/storage.objectAdmin` Cloud IAM roles on the Cloud Storage location.

func (*GcsDestination) MarshalJSON added in v0.34.0

func (s *GcsDestination) MarshalJSON() ([]byte, error)

type GcsSource added in v0.30.0

type GcsSource struct {
	// Uri: Points to a Cloud Storage URI containing file(s) to import. The
	// URI must be in the following format: `gs://{bucket_id}/{object_id}`.
	// The URI can include wildcards in `object_id` and thus identify
	// multiple files. Supported wildcards: * `*` to match 0 or more
	// non-separator characters * `**` to match 0 or more characters
	// (including separators). Must be used at the end of a path and with no
	// other wildcards in the path. Can also be used with a file extension
	// (such as .ndjson), which imports all files with the extension in the
	// specified directory and its sub-directories. For example,
	// `gs://my-bucket/my-directory/**.ndjson` imports all files with
	// `.ndjson` extensions in `my-directory/` and its sub-directories. *
	// `?` to match 1 character Files matching the wildcard are expected to
	// contain content only, no metadata.
	Uri string `json:"uri,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Uri") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Uri") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GcsSource: Specifies the configuration for importing data from Cloud Storage.

func (*GcsSource) MarshalJSON added in v0.30.0

func (s *GcsSource) MarshalJSON() ([]byte, error)

type GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination added in v0.28.0

type GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination struct {
	// Force: Use `write_disposition` instead. If `write_disposition` is
	// specified, this parameter is ignored. force=false is equivalent to
	// write_disposition=WRITE_EMPTY and force=true is equivalent to
	// write_disposition=WRITE_TRUNCATE.
	Force bool `json:"force,omitempty"`

	// SchemaType: Specifies the schema format to export.
	//
	// Possible values:
	//   "SCHEMA_TYPE_UNSPECIFIED" - Same as SIMPLE.
	//   "SIMPLE" - A flatterned version of Annotation.
	SchemaType string `json:"schemaType,omitempty"`

	// TableUri: BigQuery URI to a table, up to 2000 characters long, must
	// be of the form bq://projectId.bqDatasetId.tableId.
	TableUri string `json:"tableUri,omitempty"`

	// WriteDisposition: Determines if existing data in the destination
	// dataset is overwritten, appended to, or not written if the tables
	// contain data. If a write_disposition is specified, the `force`
	// parameter is ignored.
	//
	// Possible values:
	//   "WRITE_DISPOSITION_UNSPECIFIED" - Default behavior is the same as
	// WRITE_EMPTY.
	//   "WRITE_EMPTY" - Only export data if the destination table is empty.
	//   "WRITE_TRUNCATE" - Erase all existing data in a table before
	// writing the instances.
	//   "WRITE_APPEND" - Append data to the existing table.
	WriteDisposition string `json:"writeDisposition,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Force") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Force") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination: The BigQuery table for export.

func (*GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination) MarshalJSON added in v0.28.0

type GoogleCloudHealthcareV1beta1AnnotationGcsDestination added in v0.28.0

type GoogleCloudHealthcareV1beta1AnnotationGcsDestination struct {
	// UriPrefix: The Cloud Storage destination to export to. URI for a
	// Cloud Storage directory where the server writes result files, in the
	// format `gs://{bucket-id}/{path/to/destination/dir}`. If there is no
	// trailing slash, the service appends one when composing the object
	// path. The user is responsible for creating the Cloud Storage bucket
	// referenced in `uri_prefix`.
	UriPrefix string `json:"uriPrefix,omitempty"`

	// ForceSendFields is a list of field names (e.g. "UriPrefix") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "UriPrefix") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1beta1AnnotationGcsDestination: The Cloud Storage location for export.

func (*GoogleCloudHealthcareV1beta1AnnotationGcsDestination) MarshalJSON added in v0.28.0

type GoogleCloudHealthcareV1beta1AnnotationGcsSource added in v0.28.0

type GoogleCloudHealthcareV1beta1AnnotationGcsSource struct {
	// Uri: Points to a Cloud Storage URI containing file(s) with content
	// only. The URI must be in the following format:
	// `gs://{bucket_id}/{object_id}`. The URI can include wildcards in
	// `object_id` and thus identify multiple files. Supported wildcards:
	// '*' to match 0 or more non-separator characters '**' to match 0 or
	// more characters (including separators). Must be used at the end of a
	// path and with no other wildcards in the path. Can also be used with a
	// file extension (such as .dcm), which imports all files with the
	// extension in the specified directory and its sub-directories. For
	// example, `gs://my-bucket/my-directory/**.json` imports all files with
	// .json extensions in `my-directory/` and its sub-directories. '?' to
	// match 1 character All other URI formats are invalid. Files matching
	// the wildcard are expected to contain content only, no metadata.
	Uri string `json:"uri,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Uri") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Uri") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1beta1AnnotationGcsSource: Specifies the configuration for importing data from Cloud Storage.

func (*GoogleCloudHealthcareV1beta1AnnotationGcsSource) MarshalJSON added in v0.28.0

type GoogleCloudHealthcareV1beta1ConsentGcsDestination added in v0.33.0

type GoogleCloudHealthcareV1beta1ConsentGcsDestination struct {
	// UriPrefix: URI for a Cloud Storage directory where the server writes
	// result files, in the format
	// `gs://{bucket-id}/{path/to/destination/dir}`. If there is no trailing
	// slash, the service appends one when composing the object path. The
	// user is responsible for creating the Cloud Storage bucket and
	// directory referenced in `uri_prefix`.
	UriPrefix string `json:"uriPrefix,omitempty"`

	// ForceSendFields is a list of field names (e.g. "UriPrefix") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "UriPrefix") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1beta1ConsentGcsDestination: The Cloud Storage location for export.

func (*GoogleCloudHealthcareV1beta1ConsentGcsDestination) MarshalJSON added in v0.33.0

type GoogleCloudHealthcareV1beta1ConsentPolicy added in v0.33.0

type GoogleCloudHealthcareV1beta1ConsentPolicy struct {
	// AuthorizationRule: Required. The request conditions to meet to grant
	// access. In addition to any supported comparison operators,
	// authorization rules may have `IN` operator as well as at most 10
	// logical operators that are limited to `AND` (`&&`), `OR` (`||`).
	AuthorizationRule *Expr `json:"authorizationRule,omitempty"`

	// ResourceAttributes: The resources that this policy applies to. A
	// resource is a match if it matches all the attributes listed here. If
	// empty, this policy applies to all User data mappings for the given
	// user.
	ResourceAttributes []*Attribute `json:"resourceAttributes,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AuthorizationRule")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AuthorizationRule") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1beta1ConsentPolicy: Represents a user's consent in terms of the resources that can be accessed and under what conditions.

func (*GoogleCloudHealthcareV1beta1ConsentPolicy) MarshalJSON added in v0.33.0

type GoogleCloudHealthcareV1beta1DeidentifyDeidentifyDicomStoreSummary added in v0.12.0

type GoogleCloudHealthcareV1beta1DeidentifyDeidentifyDicomStoreSummary struct {
}

GoogleCloudHealthcareV1beta1DeidentifyDeidentifyDicomStoreSummary: Contains a summary of the DeidentifyDicomStore operation.

type GoogleCloudHealthcareV1beta1DeidentifyDeidentifyFhirStoreSummary added in v0.12.0

type GoogleCloudHealthcareV1beta1DeidentifyDeidentifyFhirStoreSummary struct {
}

GoogleCloudHealthcareV1beta1DeidentifyDeidentifyFhirStoreSummary: Contains a summary of the DeidentifyFhirStore operation.

type GoogleCloudHealthcareV1beta1DicomBigQueryDestination

type GoogleCloudHealthcareV1beta1DicomBigQueryDestination struct {
	// Force: Use `write_disposition` instead. If `write_disposition` is
	// specified, this parameter is ignored. force=false is equivalent to
	// write_disposition=WRITE_EMPTY and force=true is equivalent to
	// write_disposition=WRITE_TRUNCATE.
	Force bool `json:"force,omitempty"`

	// TableUri: BigQuery URI to a table, up to 2000 characters long, in the
	// format `bq://projectId.bqDatasetId.tableId`
	TableUri string `json:"tableUri,omitempty"`

	// WriteDisposition: Determines whether the existing table in the
	// destination is to be overwritten or appended to. If a
	// write_disposition is specified, the `force` parameter is ignored.
	//
	// Possible values:
	//   "WRITE_DISPOSITION_UNSPECIFIED" - Default behavior is the same as
	// WRITE_EMPTY.
	//   "WRITE_EMPTY" - Only export data if the destination table is empty.
	//   "WRITE_TRUNCATE" - Erase all existing data in a table before
	// writing the instances.
	//   "WRITE_APPEND" - Append data to the existing table.
	WriteDisposition string `json:"writeDisposition,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Force") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Force") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1beta1DicomBigQueryDestination: The BigQuery table where the server writes output.

func (*GoogleCloudHealthcareV1beta1DicomBigQueryDestination) MarshalJSON

type GoogleCloudHealthcareV1beta1DicomGcsDestination

type GoogleCloudHealthcareV1beta1DicomGcsDestination struct {
	// MimeType: MIME types supported by DICOM spec. Each file is written in
	// the following format:
	// `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}
	// ` The frame_number component exists only for multi-frame instances.
	// Supported MIME types are consistent with supported formats in
	// DICOMweb:
	// https://cloud.google.com/healthcare/docs/dicom#retrieve_transaction.
	// Specifically, the following are supported: - application/dicom;
	// transfer-syntax=1.2.840.10008.1.2.1 (uncompressed DICOM) -
	// application/dicom; transfer-syntax=1.2.840.10008.1.2.4.50 (DICOM with
	// embedded JPEG Baseline) - application/dicom;
	// transfer-syntax=1.2.840.10008.1.2.4.90 (DICOM with embedded JPEG 2000
	// Lossless Only) - application/dicom;
	// transfer-syntax=1.2.840.10008.1.2.4.91 (DICOM with embedded JPEG
	// 2000)h - application/dicom; transfer-syntax=* (DICOM with no
	// transcoding) - application/octet-stream;
	// transfer-syntax=1.2.840.10008.1.2.1 (raw uncompressed PixelData) -
	// application/octet-stream; transfer-syntax=* (raw PixelData in
	// whatever format it was uploaded in) - image/jpeg;
	// transfer-syntax=1.2.840.10008.1.2.4.50 (Consumer JPEG) - image/png
	// The following extensions are used for output files: -
	// application/dicom -> .dcm - image/jpeg -> .jpg - image/png -> .png -
	// application/octet-stream -> no extension If unspecified, the
	// instances are exported in the original DICOM format they were
	// uploaded in.
	MimeType string `json:"mimeType,omitempty"`

	// UriPrefix: The Cloud Storage destination to export to. URI for a
	// Cloud Storage directory where the server writes the result files, in
	// the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is
	// no trailing slash, the service appends one when composing the object
	// path. The user is responsible for creating the Cloud Storage bucket
	// referenced in `uri_prefix`.
	UriPrefix string `json:"uriPrefix,omitempty"`

	// ForceSendFields is a list of field names (e.g. "MimeType") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MimeType") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1beta1DicomGcsDestination: The Cloud Storage location where the server writes the output and the export configuration.

func (*GoogleCloudHealthcareV1beta1DicomGcsDestination) MarshalJSON

type GoogleCloudHealthcareV1beta1DicomGcsSource

type GoogleCloudHealthcareV1beta1DicomGcsSource struct {
	// Uri: Points to a Cloud Storage URI containing file(s) with content
	// only. The URI must be in the following format:
	// `gs://{bucket_id}/{object_id}`. The URI can include wildcards in
	// `object_id` and thus identify multiple files. Supported wildcards: *
	// '*' to match 0 or more non-separator characters * '**' to match 0 or
	// more characters (including separators). Must be used at the end of a
	// path and with no other wildcards in the path. Can also be used with a
	// file extension (such as .dcm), which imports all files with the
	// extension in the specified directory and its sub-directories. For
	// example, `gs://my-bucket/my-directory/**.dcm` imports all files with
	// .dcm extensions in `my-directory/` and its sub-directories. * '?' to
	// match 1 character. All other URI formats are invalid. Files matching
	// the wildcard are expected to contain content only, no metadata.
	Uri string `json:"uri,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Uri") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Uri") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1beta1DicomGcsSource: Specifies the configuration for importing data from Cloud Storage.

func (*GoogleCloudHealthcareV1beta1DicomGcsSource) MarshalJSON

type GoogleCloudHealthcareV1beta1DicomStreamConfig added in v0.31.0

type GoogleCloudHealthcareV1beta1DicomStreamConfig struct {
	// BigqueryDestination: Results are appended to this table. The server
	// creates a new table in the given BigQuery dataset if the specified
	// table does not exist. To enable the Cloud Healthcare API to write to
	// your BigQuery table, you must give the Cloud Healthcare API service
	// account the bigquery.dataEditor role. The service account is:
	// `service-{PROJECT_NUMBER}@gcp-sa-healthcare.iam.gserviceaccount.com`.
	// The PROJECT_NUMBER identifies the project that the DICOM store
	// resides in. To get the project number, go to the Cloud Console
	// Dashboard. It is recommended to not have a custom schema in the
	// destination table which could conflict with the schema created by the
	// Cloud Healthcare API. Instance deletions are not applied to the
	// destination table. The destination's table schema will be
	// automatically updated in case a new instance's data is incompatible
	// with the current schema. The schema should not be updated manually as
	// this can cause incompatibilies that cannot be resolved automatically.
	// One resolution in this case is to delete the incompatible table and
	// let the server recreate one, though the newly created table only
	// contains data after the table recreation. BigQuery imposes a 1 MB
	// limit on streaming insert row size, therefore any instance that
	// generates more than 1 MB of BigQuery data will not be streamed. If an
	// instance cannot be streamed to BigQuery, errors will be logged to
	// Cloud Logging (see Viewing error logs in Cloud Logging
	// (https://cloud.google.com/healthcare/docs/how-tos/logging)).
	BigqueryDestination *GoogleCloudHealthcareV1beta1DicomBigQueryDestination `json:"bigqueryDestination,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BigqueryDestination")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BigqueryDestination") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1beta1DicomStreamConfig: StreamConfig specifies configuration for a streaming DICOM export.

func (*GoogleCloudHealthcareV1beta1DicomStreamConfig) MarshalJSON added in v0.31.0

type GoogleCloudHealthcareV1beta1FhirBigQueryDestination

type GoogleCloudHealthcareV1beta1FhirBigQueryDestination struct {
	// DatasetUri: BigQuery URI to an existing dataset, up to 2000
	// characters long, in the format `bq://projectId.bqDatasetId`.
	DatasetUri string `json:"datasetUri,omitempty"`

	// Force: Use `write_disposition` instead. If `write_disposition` is
	// specified, this parameter is ignored. force=false is equivalent to
	// write_disposition=WRITE_EMPTY and force=true is equivalent to
	// write_disposition=WRITE_TRUNCATE.
	Force bool `json:"force,omitempty"`

	// SchemaConfig: The configuration for the exported BigQuery schema.
	SchemaConfig *SchemaConfig `json:"schemaConfig,omitempty"`

	// WriteDisposition: Determines if existing data in the destination
	// dataset is overwritten, appended to, or not written if the tables
	// contain data. If a write_disposition is specified, the `force`
	// parameter is ignored.
	//
	// Possible values:
	//   "WRITE_DISPOSITION_UNSPECIFIED" - Default behavior is the same as
	// WRITE_EMPTY.
	//   "WRITE_EMPTY" - Only export data if the destination tables are
	// empty.
	//   "WRITE_TRUNCATE" - Erase all existing data in the tables before
	// writing the instances.
	//   "WRITE_APPEND" - Append data to the existing tables.
	WriteDisposition string `json:"writeDisposition,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DatasetUri") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DatasetUri") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1beta1FhirBigQueryDestination: The configuration for exporting to BigQuery.

func (*GoogleCloudHealthcareV1beta1FhirBigQueryDestination) MarshalJSON

type GoogleCloudHealthcareV1beta1FhirExportResourcesResponse added in v0.33.0

type GoogleCloudHealthcareV1beta1FhirExportResourcesResponse struct {
}

GoogleCloudHealthcareV1beta1FhirExportResourcesResponse: Response when all resources export successfully. This structure is included in the response to describe the detailed outcome after the operation finishes successfully.

type GoogleCloudHealthcareV1beta1FhirGcsDestination added in v0.33.0

type GoogleCloudHealthcareV1beta1FhirGcsDestination struct {
	// UriPrefix: URI for a Cloud Storage directory where result files
	// should be written (in the format
	// `gs://{bucket-id}/{path/to/destination/dir}`). If there is no
	// trailing slash, the service appends one when composing the object
	// path. The Cloud Storage bucket referenced in `uri_prefix` must exist
	// or an error occurs.
	UriPrefix string `json:"uriPrefix,omitempty"`

	// ForceSendFields is a list of field names (e.g. "UriPrefix") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "UriPrefix") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1beta1FhirGcsDestination: The configuration for exporting to Cloud Storage.

func (*GoogleCloudHealthcareV1beta1FhirGcsDestination) MarshalJSON added in v0.33.0

type GoogleCloudHealthcareV1beta1FhirGcsSource added in v0.33.0

type GoogleCloudHealthcareV1beta1FhirGcsSource struct {
	// Uri: Points to a Cloud Storage URI containing file(s) to import. The
	// URI must be in the following format: `gs://{bucket_id}/{object_id}`.
	// The URI can include wildcards in `object_id` and thus identify
	// multiple files. Supported wildcards: * `*` to match 0 or more
	// non-separator characters * `**` to match 0 or more characters
	// (including separators). Must be used at the end of a path and with no
	// other wildcards in the path. Can also be used with a file extension
	// (such as .ndjson), which imports all files with the extension in the
	// specified directory and its sub-directories. For example,
	// `gs://my-bucket/my-directory/**.ndjson` imports all files with
	// `.ndjson` extensions in `my-directory/` and its sub-directories. *
	// `?` to match 1 character Files matching the wildcard are expected to
	// contain content only, no metadata.
	Uri string `json:"uri,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Uri") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Uri") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudHealthcareV1beta1FhirGcsSource: Specifies the configuration for importing data from Cloud Storage.

func (*GoogleCloudHealthcareV1beta1FhirGcsSource) MarshalJSON added in v0.33.0

type GoogleCloudHealthcareV1beta1FhirImportResourcesResponse added in v0.33.0

type GoogleCloudHealthcareV1beta1FhirImportResourcesResponse struct {
}

GoogleCloudHealthcareV1beta1FhirImportResourcesResponse: Final response of importing resources. This structure is included in the response to describe the detailed outcome after the operation finishes successfully.

type GroupOrSegment added in v0.22.0

type GroupOrSegment struct {
	Group *SchemaGroup `json:"group,omitempty"`

	Segment *SchemaSegment `json:"segment,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Group") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Group") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GroupOrSegment: Construct representing a logical group or a segment.

func (*GroupOrSegment) MarshalJSON added in v0.22.0

func (s *GroupOrSegment) MarshalJSON() ([]byte, error)

type Hl7SchemaConfig added in v0.22.0

type Hl7SchemaConfig struct {
	// MessageSchemaConfigs: Map from each HL7v2 message type and trigger
	// event pair, such as ADT_A04, to its schema configuration root group.
	MessageSchemaConfigs map[string]SchemaGroup `json:"messageSchemaConfigs,omitempty"`

	// Version: Each VersionSource is tested and only if they all match is
	// the schema used for the message.
	Version []*VersionSource `json:"version,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "MessageSchemaConfigs") to unconditionally include in API requests.
	// By default, fields with empty values are omitted from API requests.
	// However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MessageSchemaConfigs") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Hl7SchemaConfig: Root config message for HL7v2 schema. This contains a schema structure of groups and segments, and filters that determine which messages to apply the schema structure to.

func (*Hl7SchemaConfig) MarshalJSON added in v0.22.0

func (s *Hl7SchemaConfig) MarshalJSON() ([]byte, error)

type Hl7TypesConfig added in v0.22.0

type Hl7TypesConfig struct {
	// Type: The HL7v2 type definitions.
	Type []*Type `json:"type,omitempty"`

	// Version: The version selectors that this config applies to. A message
	// must match ALL version sources to apply.
	Version []*VersionSource `json:"version,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Type") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Type") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Hl7TypesConfig: Root config for HL7v2 datatype definitions for a specific HL7v2 version.

func (*Hl7TypesConfig) MarshalJSON added in v0.22.0

func (s *Hl7TypesConfig) MarshalJSON() ([]byte, error)

type Hl7V2NotificationConfig added in v0.22.0

type Hl7V2NotificationConfig struct {
	// Filter: Restricts notifications sent for messages matching a filter.
	// If this is empty, all messages are matched. The following syntax is
	// available: * A string field value can be written as text inside
	// quotation marks, for example "query text". The only valid
	// relational operation for text fields is equality (`=`), where text is
	// searched within the field, rather than having the field be equal to
	// the text. For example, "Comment = great" returns messages with
	// `great` in the comment field. * A number field value can be written
	// as an integer, a decimal, or an exponential. The valid relational
	// operators for number fields are the equality operator (`=`), along
	// with the less than/greater than operators (`<`, `<=`, `>`, `>=`).
	// Note that there is no inequality (`!=`) operator. You can prepend the
	// `NOT` operator to an expression to negate it. * A date field value
	// must be written in `yyyy-mm-dd` form. Fields with date and time use
	// the RFC3339 time format. Leading zeros are required for one-digit
	// months and days. The valid relational operators for date fields are
	// the equality operator (`=`) , along with the less than/greater than
	// operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality
	// (`!=`) operator. You can prepend the `NOT` operator to an expression
	// to negate it. * Multiple field query expressions can be combined in
	// one query by adding `AND` or `OR` operators between the expressions.
	// If a boolean operator appears within a quoted string, it is not
	// treated as special, it's just another part of the character string to
	// be matched. You can prepend the `NOT` operator to an expression to
	// negate it. Fields/functions available for filtering are: *
	// `message_type`, from the MSH-9.1 field. For example, `NOT
	// message_type = "ADT". * `send_date` or `sendDate`, the YYYY-MM-DD
	// date the message was sent in the dataset's time_zone, from the MSH-7
	// segment. For example, `send_date < "2017-01-02". * `send_time`, the
	// timestamp when the message was sent, using the RFC3339 time format
	// for comparisons, from the MSH-7 segment. For example, `send_time <
	// "2017-01-02T00:00:00-05:00". * `create_time`, the timestamp when the
	// message was created in the HL7v2 store. Use the RFC3339 time format
	// for comparisons. For example, `create_time <
	// "2017-01-02T00:00:00-05:00". * `send_facility`, the care center that
	// the message came from, from the MSH-4 segment. For example,
	// `send_facility = "ABC". * `PatientId(value, type)`, which matches if
	// the message lists a patient having an ID of the given value and type
	// in the PID-2, PID-3, or PID-4 segments. For example,
	// `PatientId("123456", "MRN")`. * `labels.x`, a string value of the
	// label with key `x` as set using the Message.labels map. For example,
	// `labels."priority"="high". The operator `:*` can be used to assert
	// the existence of a label. For example, `labels."priority":*`.
	Filter string `json:"filter,omitempty"`

	// PubsubTopic: The Pub/Sub (https://cloud.google.com/pubsub/docs/)
	// topic that notifications of changes are published on. Supplied by the
	// client. The notification is a `PubsubMessage` with the following
	// fields: * `PubsubMessage.Data` contains the resource name. *
	// `PubsubMessage.MessageId` is the ID of this notification. It is
	// guaranteed to be unique within the topic. *
	// `PubsubMessage.PublishTime` is the time when the message was
	// published. Note that notifications are only sent if the topic is
	// non-empty. Topic names
	// (https://cloud.google.com/pubsub/docs/overview#names) must be scoped
	// to a project. Cloud Healthcare API service account must have
	// publisher permissions on the given Pub/Sub topic. Not having adequate
	// permissions causes the calls that send notifications to fail. If a
	// notification can't be published to Pub/Sub, errors are logged to
	// Cloud Logging. For more information, see Viewing error logs in Cloud
	// Logging (https://cloud.google.com/healthcare/docs/how-tos/logging).
	PubsubTopic string `json:"pubsubTopic,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Filter") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Filter") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Hl7V2NotificationConfig: Specifies where and whether to send notifications upon changes to a data store.

func (*Hl7V2NotificationConfig) MarshalJSON added in v0.22.0

func (s *Hl7V2NotificationConfig) MarshalJSON() ([]byte, error)

type Hl7V2Store

type Hl7V2Store struct {
	// Labels: User-supplied key-value pairs used to organize HL7v2 stores.
	// Label keys must be between 1 and 63 characters long, have a UTF-8
	// encoding of maximum 128 bytes, and must conform to the following PCRE
	// regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional,
	// must be between 1 and 63 characters long, have a UTF-8 encoding of
	// maximum 128 bytes, and must conform to the following PCRE regular
	// expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be
	// associated with a given store.
	Labels map[string]string `json:"labels,omitempty"`

	// Name: Resource name of the HL7v2 store, of the form
	// `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_
	// id}`.
	Name string `json:"name,omitempty"`

	// NotificationConfig: The notification destination all messages (both
	// Ingest & Create) are published on. Only the message name is sent as
	// part of the notification. If this is unset, no notifications are
	// sent. Supplied by the client.
	NotificationConfig *NotificationConfig `json:"notificationConfig,omitempty"`

	// NotificationConfigs: A list of notification configs. Each
	// configuration uses a filter to determine whether to publish a message
	// (both Ingest & Create) on the corresponding notification destination.
	// Only the message name is sent as part of the notification. Supplied
	// by the client.
	NotificationConfigs []*Hl7V2NotificationConfig `json:"notificationConfigs,omitempty"`

	// ParserConfig: The configuration for the parser. It determines how the
	// server parses the messages.
	ParserConfig *ParserConfig `json:"parserConfig,omitempty"`

	// RejectDuplicateMessage: Determines whether to reject duplicate
	// messages. A duplicate message is a message with the same raw bytes as
	// a message that has already been ingested/created in this HL7v2 store.
	// The default value is false, meaning that the store accepts the
	// duplicate messages and it also returns the same ACK message in the
	// IngestMessageResponse as has been returned previously. Note that only
	// one resource is created in the store. When this field is set to true,
	// CreateMessage/IngestMessage requests with a duplicate message will be
	// rejected by the store, and IngestMessageErrorDetail returns a NACK
	// message upon rejection.
	RejectDuplicateMessage bool `json:"rejectDuplicateMessage,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Labels") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Labels") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Hl7V2Store: Represents an HL7v2 store.

func (*Hl7V2Store) MarshalJSON

func (s *Hl7V2Store) MarshalJSON() ([]byte, error)

type HttpBody

type HttpBody struct {
	// ContentType: The HTTP Content-Type header value specifying the
	// content type of the body.
	ContentType string `json:"contentType,omitempty"`

	// Data: The HTTP request/response body as raw binary.
	Data string `json:"data,omitempty"`

	// Extensions: Application specific response metadata. Must be set in
	// the first response for streaming APIs.
	Extensions []googleapi.RawMessage `json:"extensions,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ContentType") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ContentType") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

HttpBody: Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

func (*HttpBody) MarshalJSON

func (s *HttpBody) MarshalJSON() ([]byte, error)

type Image added in v0.33.0

type Image struct {
	// GcsUri: Input only. Points to a Cloud Storage URI containing the
	// consent artifact content. The URI must be in the following format:
	// `gs://{bucket_id}/{object_id}`. The Cloud Healthcare API service
	// account must have the `roles/storage.objectViewer` Cloud IAM role for
	// this Cloud Storage location. The consent artifact content at this URI
	// is copied to a Cloud Storage location managed by the Cloud Healthcare
	// API. Responses to fetching requests return the consent artifact
	// content in raw_bytes.
	GcsUri string `json:"gcsUri,omitempty"`

	// RawBytes: Consent artifact content represented as a stream of bytes.
	// This field is populated when returned in GetConsentArtifact response,
	// but not included in CreateConsentArtifact and ListConsentArtifact
	// response.
	RawBytes string `json:"rawBytes,omitempty"`

	// ForceSendFields is a list of field names (e.g. "GcsUri") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "GcsUri") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Image: Raw bytes representing consent artifact content.

func (*Image) MarshalJSON added in v0.33.0

func (s *Image) MarshalJSON() ([]byte, error)

type ImageAnnotation added in v0.28.0

type ImageAnnotation struct {
	// BoundingPolys: The list of polygons outlining the sensitive regions
	// in the image.
	BoundingPolys []*BoundingPoly `json:"boundingPolys,omitempty"`

	// FrameIndex: 0-based index of the image frame. For example, an image
	// frame in a DICOM instance.
	FrameIndex int64 `json:"frameIndex,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BoundingPolys") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BoundingPolys") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ImageAnnotation: Image annotation.

func (*ImageAnnotation) MarshalJSON added in v0.28.0

func (s *ImageAnnotation) MarshalJSON() ([]byte, error)

type ImageConfig

type ImageConfig struct {
	// TextRedactionMode: Determines how to redact text from image.
	//
	// Possible values:
	//   "TEXT_REDACTION_MODE_UNSPECIFIED" - No text redaction specified.
	// Same as REDACT_NO_TEXT.
	//   "REDACT_ALL_TEXT" - Redact all text.
	//   "REDACT_SENSITIVE_TEXT" - Redact sensitive text.
	//   "REDACT_NO_TEXT" - Do not redact text.
	TextRedactionMode string `json:"textRedactionMode,omitempty"`

	// ForceSendFields is a list of field names (e.g. "TextRedactionMode")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "TextRedactionMode") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ImageConfig: Specifies how to handle de-identification of image pixels.

func (*ImageConfig) MarshalJSON

func (s *ImageConfig) MarshalJSON() ([]byte, error)

type ImportAnnotationsRequest added in v0.28.0

type ImportAnnotationsRequest struct {
	GcsSource *GoogleCloudHealthcareV1beta1AnnotationGcsSource `json:"gcsSource,omitempty"`

	// ForceSendFields is a list of field names (e.g. "GcsSource") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "GcsSource") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ImportAnnotationsRequest: Request to import Annotations. The Annotations to be imported must have client-supplied resource names which indicate the annotation resource. The import operation is not atomic. If a failure occurs, any annotations already imported are not removed.

func (*ImportAnnotationsRequest) MarshalJSON added in v0.28.0

func (s *ImportAnnotationsRequest) MarshalJSON() ([]byte, error)

type ImportAnnotationsResponse added in v0.28.0

type ImportAnnotationsResponse struct {
}

ImportAnnotationsResponse: Final response of importing Annotations in successful case. This structure is included in the response. It is only included when the operation finishes.

type ImportDicomDataRequest

type ImportDicomDataRequest struct {
	// GcsSource: Cloud Storage source data location and import
	// configuration. The Cloud Healthcare Service Agent requires the
	// `roles/storage.objectViewer` Cloud IAM roles on the Cloud Storage
	// location.
	GcsSource *GoogleCloudHealthcareV1beta1DicomGcsSource `json:"gcsSource,omitempty"`

	// ForceSendFields is a list of field names (e.g. "GcsSource") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "GcsSource") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ImportDicomDataRequest: Imports data into the specified DICOM store. Returns an error if any of the files to import are not DICOM files. This API accepts duplicate DICOM instances by ignoring the newly-pushed instance. It does not overwrite.

func (*ImportDicomDataRequest) MarshalJSON

func (s *ImportDicomDataRequest) MarshalJSON() ([]byte, error)

type ImportDicomDataResponse added in v0.22.0

type ImportDicomDataResponse struct {
}

ImportDicomDataResponse: Returns additional information in regards to a completed DICOM store import.

type ImportMessagesRequest added in v0.30.0

type ImportMessagesRequest struct {
	// GcsSource: Cloud Storage source data location and import
	// configuration. The Cloud Healthcare Service Agent requires the
	// `roles/storage.objectViewer` Cloud IAM roles on the Cloud Storage
	// location.
	GcsSource *GcsSource `json:"gcsSource,omitempty"`

	// ForceSendFields is a list of field names (e.g. "GcsSource") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "GcsSource") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ImportMessagesRequest: Request to import messages.

func (*ImportMessagesRequest) MarshalJSON added in v0.30.0

func (s *ImportMessagesRequest) MarshalJSON() ([]byte, error)

type ImportMessagesResponse added in v0.30.0

type ImportMessagesResponse struct {
}

ImportMessagesResponse: Final response of importing messages. This structure is included in the response to describe the detailed outcome. It is only included when the operation finishes successfully.

type ImportResourcesRequest

type ImportResourcesRequest struct {
	// ContentStructure: The content structure in the source location. If
	// not specified, the server treats the input source files as BUNDLE.
	//
	// Possible values:
	//   "CONTENT_STRUCTURE_UNSPECIFIED" - If the content structure is not
	// specified, the default value `BUNDLE` is used.
	//   "BUNDLE" - The source file contains one or more lines of
	// newline-delimited JSON (ndjson). Each line is a bundle that contains
	// one or more resources.
	//   "RESOURCE" - The source file contains one or more lines of
	// newline-delimited JSON (ndjson). Each line is a single resource.
	//   "BUNDLE_PRETTY" - The entire file is one JSON bundle. The JSON can
	// span multiple lines.
	//   "RESOURCE_PRETTY" - The entire file is one JSON resource. The JSON
	// can span multiple lines.
	ContentStructure string `json:"contentStructure,omitempty"`

	// GcsSource: Cloud Storage source data location and import
	// configuration. The Cloud Healthcare Service Agent requires the
	// `roles/storage.objectViewer` Cloud IAM roles on the Cloud Storage
	// location. The Healthcare Service Agent Each Cloud Storage object
	// should be a text file that contains the format specified in
	// ContentStructure.
	GcsSource *GoogleCloudHealthcareV1beta1FhirGcsSource `json:"gcsSource,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ContentStructure") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ContentStructure") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ImportResourcesRequest: Request to import resources.

func (*ImportResourcesRequest) MarshalJSON

func (s *ImportResourcesRequest) MarshalJSON() ([]byte, error)

type InfoTypeConfig added in v0.28.0

type InfoTypeConfig struct {
	EvaluateList *FilterList `json:"evaluateList,omitempty"`

	IgnoreList *FilterList `json:"ignoreList,omitempty"`

	// StrictMatching: If `TRUE`, infoTypes described by `filter` are used
	// for evaluation. Otherwise, infoTypes are not considered for
	// evaluation. For example: * Annotated text: "Toronto is a location" *
	// Finding 1: `{"infoType": "PERSON", "quote": "Toronto", "start": 0,
	// "end": 7}` * Finding 2: `{"infoType": "CITY", "quote": "Toronto",
	// "start": 0, "end": 7}` * Finding 3: `{}` * Ground truth:
	// `{"infoType": "LOCATION", "quote": "Toronto", "start": 0, "end": 7}`
	// When `strict_matching` is `TRUE`: * Finding 1: 1 false positive *
	// Finding 2: 1 false positive * Finding 3: 1 false negative When
	// `strict_matching` is `FALSE`: * Finding 1: 1 true positive * Finding
	// 2: 1 true positive * Finding 3: 1 false negative
	StrictMatching bool `json:"strictMatching,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EvaluateList") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EvaluateList") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

InfoTypeConfig: Specifies how to use infoTypes for evaluation. For example, a user might only want to evaluate `PERSON`, `LOCATION`, and `AGE`.

func (*InfoTypeConfig) MarshalJSON added in v0.28.0

func (s *InfoTypeConfig) MarshalJSON() ([]byte, error)

type InfoTypeTransformation

type InfoTypeTransformation struct {
	// CharacterMaskConfig: Config for character mask.
	CharacterMaskConfig *CharacterMaskConfig `json:"characterMaskConfig,omitempty"`

	// CryptoHashConfig: Config for crypto hash.
	CryptoHashConfig *CryptoHashConfig `json:"cryptoHashConfig,omitempty"`

	// DateShiftConfig: Config for date shift.
	DateShiftConfig *DateShiftConfig `json:"dateShiftConfig,omitempty"`

	// InfoTypes: InfoTypes to apply this transformation to. If this is not
	// specified, this transformation becomes the default transformation,
	// and is used for any info_type that is not specified in another
	// transformation.
	InfoTypes []string `json:"infoTypes,omitempty"`

	// RedactConfig: Config for text redaction.
	RedactConfig *RedactConfig `json:"redactConfig,omitempty"`

	// ReplaceWithInfoTypeConfig: Config for replace with InfoType.
	ReplaceWithInfoTypeConfig *ReplaceWithInfoTypeConfig `json:"replaceWithInfoTypeConfig,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CharacterMaskConfig")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CharacterMaskConfig") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

InfoTypeTransformation: A transformation to apply to text that is identified as a specific info_type.

func (*InfoTypeTransformation) MarshalJSON

func (s *InfoTypeTransformation) MarshalJSON() ([]byte, error)

type IngestMessageRequest

type IngestMessageRequest struct {
	// Message: HL7v2 message to ingest.
	Message *Message `json:"message,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Message") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Message") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

IngestMessageRequest: Ingests a message into the specified HL7v2 store.

func (*IngestMessageRequest) MarshalJSON

func (s *IngestMessageRequest) MarshalJSON() ([]byte, error)

type IngestMessageResponse

type IngestMessageResponse struct {
	// Hl7Ack: HL7v2 ACK message.
	Hl7Ack string `json:"hl7Ack,omitempty"`

	// Message: Created message resource.
	Message *Message `json:"message,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Hl7Ack") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Hl7Ack") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

IngestMessageResponse: Acknowledges that a message has been ingested into the specified HL7v2 store.

func (*IngestMessageResponse) MarshalJSON

func (s *IngestMessageResponse) MarshalJSON() ([]byte, error)

type LinkedEntity added in v0.35.0

type LinkedEntity struct {
	// EntityId: entity_id is a concept unique identifier. These are
	// prefixed by a string that identifies the entity coding system,
	// followed by the unique identifier within that system. For example,
	// "UMLS/C0000970". This also supports ad hoc entities, which are formed
	// by normalizing entity mention content.
	EntityId string `json:"entityId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EntityId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EntityId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

LinkedEntity: EntityMentions can be linked to multiple entities using a LinkedEntity message lets us add other fields, e.g. confidence.

func (*LinkedEntity) MarshalJSON added in v0.35.0

func (s *LinkedEntity) MarshalJSON() ([]byte, error)

type ListAnnotationStoresResponse added in v0.28.0

type ListAnnotationStoresResponse struct {
	// AnnotationStores: The returned Annotation stores. Won't be more
	// Annotation stores than the value of page_size in the request.
	AnnotationStores []*AnnotationStore `json:"annotationStores,omitempty"`

	// NextPageToken: Token to retrieve the next page of results or empty if
	// there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AnnotationStores") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AnnotationStores") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ListAnnotationStoresResponse: Lists the Annotation stores in the given dataset.

func (*ListAnnotationStoresResponse) MarshalJSON added in v0.28.0

func (s *ListAnnotationStoresResponse) MarshalJSON() ([]byte, error)

type ListAnnotationsResponse added in v0.28.0

type ListAnnotationsResponse struct {
	// Annotations: The returned Annotations. Won't be more values than the
	// value of page_size in the request. See `AnnotationView` in the
	// request for populated fields.
	Annotations []*Annotation `json:"annotations,omitempty"`

	// NextPageToken: Token to retrieve the next page of results or empty if
	// there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Annotations") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Annotations") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListAnnotationsResponse: Lists the Annotations in the specified Annotation store.

func (*ListAnnotationsResponse) MarshalJSON added in v0.28.0

func (s *ListAnnotationsResponse) MarshalJSON() ([]byte, error)

type ListAttributeDefinitionsResponse added in v0.33.0

type ListAttributeDefinitionsResponse struct {
	// AttributeDefinitions: The returned Attribute definitions. The maximum
	// number of attributes returned is determined by the value of page_size
	// in the ListAttributeDefinitionsRequest.
	AttributeDefinitions []*AttributeDefinition `json:"attributeDefinitions,omitempty"`

	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g.
	// "AttributeDefinitions") to unconditionally include in API requests.
	// By default, fields with empty values are omitted from API requests.
	// However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AttributeDefinitions") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

func (*ListAttributeDefinitionsResponse) MarshalJSON added in v0.33.0

func (s *ListAttributeDefinitionsResponse) MarshalJSON() ([]byte, error)

type ListConsentArtifactsResponse added in v0.33.0

type ListConsentArtifactsResponse struct {
	// ConsentArtifacts: The returned Consent artifacts. The maximum number
	// of artifacts returned is determined by the value of page_size in the
	// ListConsentArtifactsRequest.
	ConsentArtifacts []*ConsentArtifact `json:"consentArtifacts,omitempty"`

	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ConsentArtifacts") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConsentArtifacts") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

func (*ListConsentArtifactsResponse) MarshalJSON added in v0.33.0

func (s *ListConsentArtifactsResponse) MarshalJSON() ([]byte, error)

type ListConsentRevisionsResponse added in v0.33.0

type ListConsentRevisionsResponse struct {
	// Consents: The returned Consent revisions. The maximum number of
	// revisions returned is determined by the value of `page_size` in the
	// ListConsentRevisionsRequest.
	Consents []*Consent `json:"consents,omitempty"`

	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Consents") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Consents") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListConsentRevisionsResponse) MarshalJSON added in v0.33.0

func (s *ListConsentRevisionsResponse) MarshalJSON() ([]byte, error)

type ListConsentStoresResponse added in v0.33.0

type ListConsentStoresResponse struct {
	// ConsentStores: The returned consent stores. The maximum number of
	// stores returned is determined by the value of page_size in the
	// ListConsentStoresRequest.
	ConsentStores []*ConsentStore `json:"consentStores,omitempty"`

	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ConsentStores") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConsentStores") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListConsentStoresResponse) MarshalJSON added in v0.33.0

func (s *ListConsentStoresResponse) MarshalJSON() ([]byte, error)

type ListConsentsResponse added in v0.33.0

type ListConsentsResponse struct {
	// Consents: The returned Consents. The maximum number of Consents
	// returned is determined by the value of page_size in the
	// ListConsentsRequest.
	Consents []*Consent `json:"consents,omitempty"`

	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Consents") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Consents") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListConsentsResponse) MarshalJSON added in v0.33.0

func (s *ListConsentsResponse) MarshalJSON() ([]byte, error)

type ListDatasetsResponse

type ListDatasetsResponse struct {
	// Datasets: The first page of datasets.
	Datasets []*Dataset `json:"datasets,omitempty"`

	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Datasets") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Datasets") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListDatasetsResponse: Lists the available datasets.

func (*ListDatasetsResponse) MarshalJSON

func (s *ListDatasetsResponse) MarshalJSON() ([]byte, error)

type ListDicomStoresResponse

type ListDicomStoresResponse struct {
	// DicomStores: The returned DICOM stores. Won't be more DICOM stores
	// than the value of page_size in the request.
	DicomStores []*DicomStore `json:"dicomStores,omitempty"`

	// NextPageToken: Token to retrieve the next page of results or empty if
	// there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "DicomStores") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DicomStores") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListDicomStoresResponse: Lists the DICOM stores in the given dataset.

func (*ListDicomStoresResponse) MarshalJSON

func (s *ListDicomStoresResponse) MarshalJSON() ([]byte, error)

type ListFhirStoresResponse

type ListFhirStoresResponse struct {
	// FhirStores: The returned FHIR stores. Won't be more FHIR stores than
	// the value of page_size in the request.
	FhirStores []*FhirStore `json:"fhirStores,omitempty"`

	// NextPageToken: Token to retrieve the next page of results or empty if
	// there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "FhirStores") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "FhirStores") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListFhirStoresResponse: Lists the FHIR stores in the given dataset.

func (*ListFhirStoresResponse) MarshalJSON

func (s *ListFhirStoresResponse) MarshalJSON() ([]byte, error)

type ListHl7V2StoresResponse

type ListHl7V2StoresResponse struct {
	// Hl7V2Stores: The returned HL7v2 stores. Won't be more HL7v2 stores
	// than the value of page_size in the request.
	Hl7V2Stores []*Hl7V2Store `json:"hl7V2Stores,omitempty"`

	// NextPageToken: Token to retrieve the next page of results or empty if
	// there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Hl7V2Stores") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Hl7V2Stores") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListHl7V2StoresResponse: Lists the HL7v2 stores in the given dataset.

func (*ListHl7V2StoresResponse) MarshalJSON

func (s *ListHl7V2StoresResponse) MarshalJSON() ([]byte, error)

type ListLocationsResponse

type ListLocationsResponse struct {
	// Locations: A list of locations that matches the specified filter in
	// the request.
	Locations []*Location `json:"locations,omitempty"`

	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Locations") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Locations") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListLocationsResponse: The response message for Locations.ListLocations.

func (*ListLocationsResponse) MarshalJSON

func (s *ListLocationsResponse) MarshalJSON() ([]byte, error)

type ListMessagesResponse

type ListMessagesResponse struct {
	// Hl7V2Messages: The returned Messages. Won't be more Messages than the
	// value of page_size in the request. See view for populated fields.
	Hl7V2Messages []*Message `json:"hl7V2Messages,omitempty"`

	// NextPageToken: Token to retrieve the next page of results or empty if
	// there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Hl7V2Messages") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Hl7V2Messages") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListMessagesResponse: Lists the messages in the specified HL7v2 store.

func (*ListMessagesResponse) MarshalJSON

func (s *ListMessagesResponse) MarshalJSON() ([]byte, error)

type ListOperationsResponse

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Operations: A list of operations that matches the specified filter in
	// the request.
	Operations []*Operation `json:"operations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (*ListOperationsResponse) MarshalJSON

func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)

type ListUserDataMappingsResponse added in v0.33.0

type ListUserDataMappingsResponse struct {
	// NextPageToken: Token to retrieve the next page of results, or empty
	// if there are no more results in the list.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// 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.
	UserDataMappings []*UserDataMapping `json:"userDataMappings,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ListUserDataMappingsResponse) MarshalJSON added in v0.33.0

func (s *ListUserDataMappingsResponse) MarshalJSON() ([]byte, error)

type Location

type Location struct {
	// DisplayName: The friendly name for this location, typically a nearby
	// city name. For example, "Tokyo".
	DisplayName string `json:"displayName,omitempty"`

	// Labels: Cross-service attributes for the location. For example
	// {"cloud.googleapis.com/region": "us-east1"}
	Labels map[string]string `json:"labels,omitempty"`

	// LocationId: The canonical id for this location. For example:
	// "us-east1".
	LocationId string `json:"locationId,omitempty"`

	// Metadata: Service-specific metadata. For example the available
	// capacity at the given location.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`

	// Name: Resource name for the location, which may vary between
	// implementations. For example:
	// "projects/example-project/locations/us-east1"
	Name string `json:"name,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "DisplayName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DisplayName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Location: A resource that represents Google Cloud Platform location.

func (*Location) MarshalJSON

func (s *Location) MarshalJSON() ([]byte, error)

type Message

type Message struct {
	// CreateTime: Output only. The datetime when the message was created.
	// Set by the server.
	CreateTime string `json:"createTime,omitempty"`

	// Data: Raw message bytes.
	Data string `json:"data,omitempty"`

	// Labels: User-supplied key-value pairs used to organize HL7v2 stores.
	// Label keys must be between 1 and 63 characters long, have a UTF-8
	// encoding of maximum 128 bytes, and must conform to the following PCRE
	// regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional,
	// must be between 1 and 63 characters long, have a UTF-8 encoding of
	// maximum 128 bytes, and must conform to the following PCRE regular
	// expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be
	// associated with a given store.
	Labels map[string]string `json:"labels,omitempty"`

	// MessageType: The message type for this message. MSH-9.1.
	MessageType string `json:"messageType,omitempty"`

	// Name: Resource name of the Message, of the form
	// `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store
	// _id}/messages/{message_id}`. Assigned by the server.
	Name string `json:"name,omitempty"`

	// ParsedData: Output only. The parsed version of the raw message data.
	ParsedData *ParsedData `json:"parsedData,omitempty"`

	// PatientIds: All patient IDs listed in the PID-2, PID-3, and PID-4
	// segments of this message.
	PatientIds []*PatientId `json:"patientIds,omitempty"`

	// SchematizedData: The parsed version of the raw message data
	// schematized according to this store's schemas and type definitions.
	SchematizedData *SchematizedData `json:"schematizedData,omitempty"`

	// SendFacility: The hospital that this message came from. MSH-4.
	SendFacility string `json:"sendFacility,omitempty"`

	// SendTime: The datetime the sending application sent this message.
	// MSH-7.
	SendTime string `json:"sendTime,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CreateTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Message: A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7.org/implement/standards/index.cfm?ref=common) for details on the standard.

func (*Message) MarshalJSON

func (s *Message) MarshalJSON() ([]byte, error)

type NotificationConfig

type NotificationConfig struct {
	// PubsubTopic: The Pub/Sub (https://cloud.google.com/pubsub/docs/)
	// topic that notifications of changes are published on. Supplied by the
	// client. PubsubMessage.Data contains the resource name.
	// PubsubMessage.MessageId is the ID of this message. It is guaranteed
	// to be unique within the topic. PubsubMessage.PublishTime is the time
	// at which the message was published. Notifications are only sent if
	// the topic is non-empty. Topic names
	// (https://cloud.google.com/pubsub/docs/overview#names) must be scoped
	// to a project. Cloud Healthcare API service account must have
	// publisher permissions on the given Pub/Sub topic. Not having adequate
	// permissions causes the calls that send notifications to fail. If a
	// notification can't be published to Pub/Sub, errors are logged to
	// Cloud Logging (see Viewing error logs in Cloud Logging
	// (https://cloud.google.com/healthcare/docs/how-tos/logging)). If the
	// number of errors exceeds a certain rate, some aren't submitted. Note
	// that not all operations trigger notifications, see Configuring
	// Pub/Sub notifications
	// (https://cloud.google.com/healthcare/docs/how-tos/pubsub) for
	// specific details.
	PubsubTopic string `json:"pubsubTopic,omitempty"`

	// SendForBulkImport: Indicates whether or not to send Pub/Sub
	// notifications on bulk import. Only supported for DICOM imports.
	SendForBulkImport bool `json:"sendForBulkImport,omitempty"`

	// ForceSendFields is a list of field names (e.g. "PubsubTopic") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "PubsubTopic") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

NotificationConfig: Specifies where to send notifications upon changes to a data store.

func (*NotificationConfig) MarshalJSON

func (s *NotificationConfig) MarshalJSON() ([]byte, error)

type Operation

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in
	// progress. If `true`, the operation is completed, and either `error`
	// or `response` is available.
	Done bool `json:"done,omitempty"`

	// Error: The error result of the operation in case of failure or
	// cancellation.
	Error *Status `json:"error,omitempty"`

	// Metadata: Service-specific metadata associated with the operation. It
	// typically contains progress information and common metadata such as
	// create time. Some services might not provide such metadata. Any
	// method that returns a long-running operation should document the
	// metadata type, if any.
	Metadata googleapi.RawMessage `json:"metadata,omitempty"`

	// Name: The server-assigned name, which is only unique within the same
	// service that originally returns it. If you use the default HTTP
	// mapping, the `name` should be a resource name ending with
	// `operations/{unique_id}`.
	Name string `json:"name,omitempty"`

	// Response: The normal response of the operation in case of success. If
	// the original method returns no data on success, such as `Delete`, the
	// response is `google.protobuf.Empty`. If the original method is
	// standard `Get`/`Create`/`Update`, the response should be the
	// resource. For other methods, the response should have the type
	// `XxxResponse`, where `Xxx` is the original method name. For example,
	// if the original method name is `TakeSnapshot()`, the inferred
	// response type is `TakeSnapshotResponse`.
	Response googleapi.RawMessage `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Done") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Done") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (*Operation) MarshalJSON

func (s *Operation) MarshalJSON() ([]byte, error)

type OperationMetadata

type OperationMetadata struct {
	// ApiMethodName: The name of the API method that initiated the
	// operation.
	ApiMethodName string `json:"apiMethodName,omitempty"`

	// CancelRequested: Specifies if cancellation was requested for the
	// operation.
	CancelRequested bool `json:"cancelRequested,omitempty"`

	Counter *ProgressCounter `json:"counter,omitempty"`

	// CreateTime: The time at which the operation was created by the API.
	CreateTime string `json:"createTime,omitempty"`

	// EndTime: The time at which execution was completed.
	EndTime string `json:"endTime,omitempty"`

	// LogsUrl: A link to audit and error logs in the log viewer. Error logs
	// are generated only by some operations, listed at Viewing error logs
	// in Cloud Logging
	// (https://cloud.google.com/healthcare/docs/how-tos/logging).
	LogsUrl string `json:"logsUrl,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ApiMethodName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ApiMethodName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

OperationMetadata: OperationMetadata provides information about the operation execution. Returned in the long-running operation's metadata field.

func (*OperationMetadata) MarshalJSON

func (s *OperationMetadata) MarshalJSON() ([]byte, error)

type ParsedData

type ParsedData struct {
	Segments []*Segment `json:"segments,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Segments") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Segments") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ParsedData: The content of an HL7v2 message in a structured format.

func (*ParsedData) MarshalJSON

func (s *ParsedData) MarshalJSON() ([]byte, error)

type ParserConfig

type ParserConfig struct {
	// AllowNullHeader: Determines whether messages with no header are
	// allowed.
	AllowNullHeader bool `json:"allowNullHeader,omitempty"`

	// Schema: Schemas used to parse messages in this store, if schematized
	// parsing is desired.
	Schema *SchemaPackage `json:"schema,omitempty"`

	// SegmentTerminator: Byte(s) to use as the segment terminator. If this
	// is unset, '\r' is used as segment terminator, matching the HL7
	// version 2 specification.
	SegmentTerminator string `json:"segmentTerminator,omitempty"`

	// Version: Immutable. Determines the version of the unschematized
	// parser to be used when `schema` is not given. This field is immutable
	// after store creation.
	//
	// Possible values:
	//   "PARSER_VERSION_UNSPECIFIED" - Unspecified parser version,
	// equivalent to V1.
	//   "V1" - The `parsed_data` includes every given non-empty message
	// field except the Field Separator (MSH-1) field. As a result, the
	// parsed MSH segment starts with the MSH-2 field and the field numbers
	// are off-by-one with respect to the HL7 standard.
	//   "V2" - The `parsed_data` includes every given non-empty message
	// field.
	Version string `json:"version,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AllowNullHeader") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AllowNullHeader") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ParserConfig: The configuration for the parser. It determines how the server parses the messages.

func (*ParserConfig) MarshalJSON

func (s *ParserConfig) MarshalJSON() ([]byte, error)

type PatientId

type PatientId struct {
	// Type: ID type. For example, MRN or NHS.
	Type string `json:"type,omitempty"`

	// Value: The patient's unique identifier.
	Value string `json:"value,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Type") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Type") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PatientId: A patient identifier and associated type.

func (*PatientId) MarshalJSON

func (s *PatientId) MarshalJSON() ([]byte, error)

type Policy

type Policy struct {
	// AuditConfigs: Specifies cloud audit logging configuration for this
	// policy.
	AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`

	// Bindings: Associates a list of `members` to a `role`. Optionally, may
	// specify a `condition` that determines how and when the `bindings` are
	// applied. Each of the `bindings` must contain at least one member.
	Bindings []*Binding `json:"bindings,omitempty"`

	// Etag: `etag` is used for optimistic concurrency control as a way to
	// help prevent simultaneous updates of a policy from overwriting each
	// other. It is strongly suggested that systems make use of the `etag`
	// in the read-modify-write cycle to perform policy updates in order to
	// avoid race conditions: An `etag` is returned in the response to
	// `getIamPolicy`, and systems are expected to put that etag in the
	// request to `setIamPolicy` to ensure that their change will be applied
	// to the same version of the policy. **Important:** If you use IAM
	// Conditions, you must include the `etag` field whenever you call
	// `setIamPolicy`. If you omit this field, then IAM allows you to
	// overwrite a version `3` policy with a version `1` policy, and all of
	// the conditions in the version `3` policy are lost.
	Etag string `json:"etag,omitempty"`

	// Version: Specifies the format of the policy. Valid values are `0`,
	// `1`, and `3`. Requests that specify an invalid value are rejected.
	// Any operation that affects conditional role bindings must specify
	// version `3`. This requirement applies to the following operations: *
	// Getting a policy that includes a conditional role binding * Adding a
	// conditional role binding to a policy * Changing a conditional role
	// binding in a policy * Removing any role binding, with or without a
	// condition, from a policy that includes conditions **Important:** If
	// you use IAM Conditions, you must include the `etag` field whenever
	// you call `setIamPolicy`. If you omit this field, then IAM allows you
	// to overwrite a version `3` policy with a version `1` policy, and all
	// of the conditions in the version `3` policy are lost. If a policy
	// does not include any conditions, operations on that policy may
	// specify any valid version or leave the field unset. To learn which
	// resources support conditions in their IAM policies, see the IAM
	// documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Version int64 `json:"version,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AuditConfigs") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AuditConfigs") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Policy: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

func (*Policy) MarshalJSON

func (s *Policy) MarshalJSON() ([]byte, error)

type ProgressCounter

type ProgressCounter struct {
	// Failure: The number of units that failed in the operation.
	Failure int64 `json:"failure,omitempty,string"`

	// Pending: The number of units that are pending in the operation.
	Pending int64 `json:"pending,omitempty,string"`

	// Success: The number of units that succeeded in the operation.
	Success int64 `json:"success,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "Failure") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Failure") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ProgressCounter: ProgressCounter provides counters to describe an operation's progress.

func (*ProgressCounter) MarshalJSON

func (s *ProgressCounter) MarshalJSON() ([]byte, error)

type ProjectsLocationsDatasetsAnnotationStoresAnnotationsCreateCall added in v0.28.0

type ProjectsLocationsDatasetsAnnotationStoresAnnotationsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsCreateCall) Context added in v0.28.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsCreateCall) Do added in v0.28.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.annotations.create" call. Exactly one of *Annotation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Annotation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsCreateCall) Fields added in v0.28.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsCreateCall) Header added in v0.28.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsAnnotationStoresAnnotationsDeleteCall added in v0.28.0

type ProjectsLocationsDatasetsAnnotationStoresAnnotationsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsDeleteCall) Context added in v0.28.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsDeleteCall) Do added in v0.28.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.annotations.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsDeleteCall) Fields added in v0.28.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsDeleteCall) Header added in v0.28.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsAnnotationStoresAnnotationsGetCall added in v0.28.0

type ProjectsLocationsDatasetsAnnotationStoresAnnotationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsGetCall) Context added in v0.28.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsGetCall) Do added in v0.28.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.annotations.get" call. Exactly one of *Annotation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Annotation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsGetCall) Fields added in v0.28.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsGetCall) Header added in v0.28.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsGetCall) IfNoneMatch added in v0.28.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsAnnotationStoresAnnotationsListCall added in v0.28.0

type ProjectsLocationsDatasetsAnnotationStoresAnnotationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsListCall) Context added in v0.28.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsListCall) Do added in v0.28.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.annotations.list" call. Exactly one of *ListAnnotationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListAnnotationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsListCall) Fields added in v0.28.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsListCall) Filter added in v0.28.0

Filter sets the optional parameter "filter": Restricts Annotations returned to those matching a filter. Functions available for filtering are: - `matches("annotation_source.cloud_healthcare_source.name", substring)`. Filter on `cloud_healthcare_source.name`. For example: `matches("annotation_source.cloud_healthcare_source.name", "some source")`. - `matches("annotation", substring)`. Filter on all fields of annotation. For example: `matches("annotation", "some-content")`. - `type("text")`, `type("image")`, `type("resource")`. Filter on the type of annotation `data`.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsListCall) Header added in v0.28.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsListCall) IfNoneMatch added in v0.28.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsListCall) PageSize added in v0.28.0

PageSize sets the optional parameter "pageSize": Limit on the number of Annotations to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsListCall) PageToken added in v0.28.0

PageToken sets the optional parameter "pageToken": The next_page_token value returned from the previous List request, if any.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsListCall) Pages added in v0.28.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsListCall) View added in v0.28.0

View sets the optional parameter "view": Controls which fields are populated in the response.

Possible values:

"ANNOTATION_VIEW_UNSPECIFIED" - Same as BASIC.
"ANNOTATION_VIEW_BASIC" - Only `name`, `annotation_source` and

`custom_data` fields are populated.

"ANNOTATION_VIEW_FULL" - All fields are populated.

type ProjectsLocationsDatasetsAnnotationStoresAnnotationsPatchCall added in v0.28.0

type ProjectsLocationsDatasetsAnnotationStoresAnnotationsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsPatchCall) Context added in v0.28.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsPatchCall) Do added in v0.28.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.annotations.patch" call. Exactly one of *Annotation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Annotation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsPatchCall) Fields added in v0.28.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsPatchCall) Header added in v0.28.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsPatchCall) UpdateMask added in v0.28.0

UpdateMask sets the optional parameter "updateMask": The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

type ProjectsLocationsDatasetsAnnotationStoresAnnotationsService added in v0.28.0

type ProjectsLocationsDatasetsAnnotationStoresAnnotationsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsAnnotationStoresAnnotationsService added in v0.28.0

func NewProjectsLocationsDatasetsAnnotationStoresAnnotationsService(s *Service) *ProjectsLocationsDatasetsAnnotationStoresAnnotationsService

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsService) Create added in v0.28.0

Create: Creates a new Annotation record. It is valid to create Annotation objects for the same source more than once since a unique ID is assigned to each record by this service.

  • parent: The name of the Annotation store this annotation belongs to. For example, `projects/my-project/locations/us-central1/datasets/mydataset/annota tionStores/myannotationstore`.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsService) Delete added in v0.28.0

Delete: Deletes an Annotation or returns NOT_FOUND if it does not exist.

- name: The resource name of the Annotation to delete.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsService) Get added in v0.28.0

Get: Gets an Annotation.

- name: The resource name of the Annotation to retrieve.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsService) List added in v0.28.0

List: Lists the Annotations in the given Annotation store for a source resource.

- parent: Name of the Annotation store to retrieve Annotations from.

func (*ProjectsLocationsDatasetsAnnotationStoresAnnotationsService) Patch added in v0.28.0

Patch: Updates the Annotation.

  • name: Resource name of the Annotation, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /annotationStores/{annotation_store_id}/annotations/{annotation_id}` .

type ProjectsLocationsDatasetsAnnotationStoresCreateCall added in v0.28.0

type ProjectsLocationsDatasetsAnnotationStoresCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresCreateCall) AnnotationStoreId added in v0.28.0

AnnotationStoreId sets the optional parameter "annotationStoreId": The ID of the Annotation store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`.

func (*ProjectsLocationsDatasetsAnnotationStoresCreateCall) Context added in v0.28.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresCreateCall) Do added in v0.28.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.create" call. Exactly one of *AnnotationStore or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AnnotationStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresCreateCall) Fields added in v0.28.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresCreateCall) Header added in v0.28.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsAnnotationStoresDeleteCall added in v0.28.0

type ProjectsLocationsDatasetsAnnotationStoresDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresDeleteCall) Context added in v0.28.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresDeleteCall) Do added in v0.28.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresDeleteCall) Fields added in v0.28.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresDeleteCall) Header added in v0.28.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsAnnotationStoresEvaluateCall added in v0.28.0

type ProjectsLocationsDatasetsAnnotationStoresEvaluateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresEvaluateCall) Context added in v0.28.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresEvaluateCall) Do added in v0.28.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.evaluate" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresEvaluateCall) Fields added in v0.28.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresEvaluateCall) Header added in v0.28.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsAnnotationStoresExportCall added in v0.28.0

type ProjectsLocationsDatasetsAnnotationStoresExportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresExportCall) Context added in v0.28.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresExportCall) Do added in v0.28.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.export" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresExportCall) Fields added in v0.28.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresExportCall) Header added in v0.28.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsAnnotationStoresGetCall added in v0.28.0

type ProjectsLocationsDatasetsAnnotationStoresGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresGetCall) Context added in v0.28.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresGetCall) Do added in v0.28.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.get" call. Exactly one of *AnnotationStore or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AnnotationStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresGetCall) Fields added in v0.28.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresGetCall) Header added in v0.28.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsAnnotationStoresGetCall) IfNoneMatch added in v0.28.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsAnnotationStoresGetIamPolicyCall added in v0.16.0

type ProjectsLocationsDatasetsAnnotationStoresGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresGetIamPolicyCall) Context added in v0.16.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresGetIamPolicyCall) Do added in v0.16.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresGetIamPolicyCall) Fields added in v0.16.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresGetIamPolicyCall) Header added in v0.16.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsAnnotationStoresGetIamPolicyCall) IfNoneMatch added in v0.16.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsAnnotationStoresGetIamPolicyCall) OptionsRequestedPolicyVersion added in v0.16.0

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsLocationsDatasetsAnnotationStoresImportCall added in v0.28.0

type ProjectsLocationsDatasetsAnnotationStoresImportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresImportCall) Context added in v0.28.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresImportCall) Do added in v0.28.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.import" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresImportCall) Fields added in v0.28.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresImportCall) Header added in v0.28.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsAnnotationStoresListCall added in v0.28.0

type ProjectsLocationsDatasetsAnnotationStoresListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresListCall) Context added in v0.28.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresListCall) Do added in v0.28.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.list" call. Exactly one of *ListAnnotationStoresResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListAnnotationStoresResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresListCall) Fields added in v0.28.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresListCall) Filter added in v0.28.0

Filter sets the optional parameter "filter": Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported, for example `labels.key=value`.

func (*ProjectsLocationsDatasetsAnnotationStoresListCall) Header added in v0.28.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsAnnotationStoresListCall) IfNoneMatch added in v0.28.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsAnnotationStoresListCall) PageSize added in v0.28.0

PageSize sets the optional parameter "pageSize": Limit on the number of Annotation stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsAnnotationStoresListCall) PageToken added in v0.28.0

PageToken sets the optional parameter "pageToken": The next_page_token value returned from the previous List request, if any.

func (*ProjectsLocationsDatasetsAnnotationStoresListCall) Pages added in v0.28.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsAnnotationStoresPatchCall added in v0.28.0

type ProjectsLocationsDatasetsAnnotationStoresPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresPatchCall) Context added in v0.28.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresPatchCall) Do added in v0.28.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.patch" call. Exactly one of *AnnotationStore or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AnnotationStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresPatchCall) Fields added in v0.28.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresPatchCall) Header added in v0.28.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsAnnotationStoresPatchCall) UpdateMask added in v0.28.0

UpdateMask sets the optional parameter "updateMask": The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

type ProjectsLocationsDatasetsAnnotationStoresService added in v0.16.0

type ProjectsLocationsDatasetsAnnotationStoresService struct {
	Annotations *ProjectsLocationsDatasetsAnnotationStoresAnnotationsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsAnnotationStoresService added in v0.16.0

func NewProjectsLocationsDatasetsAnnotationStoresService(s *Service) *ProjectsLocationsDatasetsAnnotationStoresService

func (*ProjectsLocationsDatasetsAnnotationStoresService) Create added in v0.28.0

Create: Creates a new Annotation store within the parent dataset.

- parent: The name of the dataset this Annotation store belongs to.

func (*ProjectsLocationsDatasetsAnnotationStoresService) Delete added in v0.28.0

Delete: Deletes the specified Annotation store and removes all annotations that are contained within it.

- name: The resource name of the Annotation store to delete.

func (*ProjectsLocationsDatasetsAnnotationStoresService) Evaluate added in v0.28.0

Evaluate: Evaluate an Annotation store against a ground truth Annotation store. When the operation finishes successfully, a detailed response is returned of type EvaluateAnnotationStoreResponse, contained in the response. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging)).

  • name: The Annotation store to compare against `golden_store`, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /annotationStores/{annotation_store_id}`.

func (*ProjectsLocationsDatasetsAnnotationStoresService) Export added in v0.28.0

Export: Export Annotations from the Annotation store. If the request is successful, a detailed response is returned of type ExportAnnotationsResponse, contained in the response field when the operation finishes. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging)).

  • name: The name of the Annotation store to export annotations to, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /annotationStores/{annotation_store_id}`.

func (*ProjectsLocationsDatasetsAnnotationStoresService) Get added in v0.28.0

Get: Gets the specified Annotation store or returns NOT_FOUND if it does not exist.

- name: The resource name of the Annotation store to get.

func (*ProjectsLocationsDatasetsAnnotationStoresService) GetIamPolicy added in v0.16.0

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • resource: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

func (*ProjectsLocationsDatasetsAnnotationStoresService) Import added in v0.28.0

Import: Import Annotations to the Annotation store by loading data from the specified sources. If the request is successful, a detailed response is returned as of type ImportAnnotationsResponse, contained in the response field when the operation finishes. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging)).

  • name: The name of the Annotation store to which the server imports annotations, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /annotationStores/{annotation_store_id}`.

func (*ProjectsLocationsDatasetsAnnotationStoresService) List added in v0.28.0

List: Lists the Annotation stores in the given dataset for a source store.

- parent: Name of the dataset.

func (*ProjectsLocationsDatasetsAnnotationStoresService) Patch added in v0.28.0

Patch: Updates the specified Annotation store.

  • name: Resource name of the Annotation store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /annotationStores/{annotation_store_id}`.

func (*ProjectsLocationsDatasetsAnnotationStoresService) SetIamPolicy added in v0.16.0

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

  • resource: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

func (*ProjectsLocationsDatasetsAnnotationStoresService) TestIamPermissions added in v0.16.0

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

  • resource: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

type ProjectsLocationsDatasetsAnnotationStoresSetIamPolicyCall added in v0.16.0

type ProjectsLocationsDatasetsAnnotationStoresSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresSetIamPolicyCall) Context added in v0.16.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresSetIamPolicyCall) Do added in v0.16.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresSetIamPolicyCall) Fields added in v0.16.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresSetIamPolicyCall) Header added in v0.16.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsAnnotationStoresTestIamPermissionsCall added in v0.16.0

type ProjectsLocationsDatasetsAnnotationStoresTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsAnnotationStoresTestIamPermissionsCall) Context added in v0.16.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsAnnotationStoresTestIamPermissionsCall) Do added in v0.16.0

Do executes the "healthcare.projects.locations.datasets.annotationStores.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsAnnotationStoresTestIamPermissionsCall) Fields added in v0.16.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsAnnotationStoresTestIamPermissionsCall) Header added in v0.16.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsCreateCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsCreateCall) AttributeDefinitionId added in v0.33.0

AttributeDefinitionId sets the optional parameter "attributeDefinitionId": Required. The ID of the Attribute definition to create. The string must match the following regex: `_a-zA-Z{0,255}` and must not be a reserved keyword within the Common Expression Language as listed on https://github.com/google/cel-spec/blob/master/doc/langdef.md.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsCreateCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsCreateCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.attributeDefinitions.create" call. Exactly one of *AttributeDefinition or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AttributeDefinition.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsCreateCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsCreateCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsDeleteCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsDeleteCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsDeleteCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.attributeDefinitions.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsDeleteCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsDeleteCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsGetCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsGetCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsGetCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.attributeDefinitions.get" call. Exactly one of *AttributeDefinition or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AttributeDefinition.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsGetCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsGetCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsGetCall) IfNoneMatch added in v0.33.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.attributeDefinitions.list" call. Exactly one of *ListAttributeDefinitionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListAttributeDefinitionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) Filter added in v0.33.0

Filter sets the optional parameter "filter": Restricts the attributes returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The only field available for filtering is `category`. For example, `filter=category=\"REQUEST\".

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) IfNoneMatch added in v0.33.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) PageSize added in v0.33.0

PageSize sets the optional parameter "pageSize": Limit on the number of Attribute definitions to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) PageToken added in v0.33.0

PageToken sets the optional parameter "pageToken": Token to retrieve the next page of results or empty to get the first page.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsListCall) Pages added in v0.33.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsPatchCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsPatchCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsPatchCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.attributeDefinitions.patch" call. Exactly one of *AttributeDefinition or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AttributeDefinition.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsPatchCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsPatchCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsPatchCall) UpdateMask added in v0.33.0

UpdateMask sets the optional parameter "updateMask": Required. The update mask that applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. Only the `description`, `allowed_values`, `consent_default_values` and `data_mapping_default_value` fields can be updated. The updated `allowed_values` must contain all values from the previous `allowed_values`.

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService added in v0.33.0

func NewProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService(s *Service) *ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService) Create added in v0.33.0

Create: Creates a new Attribute definition in the parent consent store.

  • parent: The name of the consent store that this Attribute definition belongs to.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService) Delete added in v0.33.0

Delete: Deletes the specified Attribute definition. Fails if the Attribute definition is referenced by any User data mapping, or the latest revision of any Consent.

  • name: 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.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService) Get added in v0.33.0

Get: Gets the specified Attribute definition.

- name: The resource name of the Attribute definition to get.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService) List added in v0.33.0

List: Lists the Attribute definitions in the specified consent store.

  • parent: Name of the consent store to retrieve Attribute definitions from.

func (*ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService) Patch added in v0.33.0

Patch: Updates the specified Attribute definition.

  • name: Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /consentStores/{consent_store_id}/attributeDefinitions/{attribute_de finition_id}`. Cannot be changed after creation.

type ProjectsLocationsDatasetsConsentStoresCheckDataAccessCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresCheckDataAccessCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresCheckDataAccessCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresCheckDataAccessCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.checkDataAccess" call. Exactly one of *CheckDataAccessResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *CheckDataAccessResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresCheckDataAccessCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresCheckDataAccessCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsCreateCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsCreateCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsCreateCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consentArtifacts.create" call. Exactly one of *ConsentArtifact or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ConsentArtifact.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsCreateCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsCreateCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsDeleteCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsDeleteCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsDeleteCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consentArtifacts.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsDeleteCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsDeleteCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsGetCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsGetCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsGetCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consentArtifacts.get" call. Exactly one of *ConsentArtifact or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ConsentArtifact.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsGetCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsGetCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsGetCall) IfNoneMatch added in v0.33.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consentArtifacts.list" call. Exactly one of *ListConsentArtifactsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListConsentArtifactsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) Filter added in v0.33.0

Filter sets the optional parameter "filter": Restricts the artifacts returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - user_id. For example, `filter=user_id=\"user123\". - consent_content_version - metadata. For example, `filter=Metadata(\"testkey\")=\"value\" or `filter=HasMetadata(\"testkey\")`.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) IfNoneMatch added in v0.33.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) PageSize added in v0.33.0

PageSize sets the optional parameter "pageSize": Limit on the number of consent artifacts to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) PageToken added in v0.33.0

PageToken sets the optional parameter "pageToken": The next_page_token value returned from the previous List request, if any.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsListCall) Pages added in v0.33.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsService added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentArtifactsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsConsentStoresConsentArtifactsService added in v0.33.0

func NewProjectsLocationsDatasetsConsentStoresConsentArtifactsService(s *Service) *ProjectsLocationsDatasetsConsentStoresConsentArtifactsService

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsService) Create added in v0.33.0

Create: Creates a new Consent artifact in the parent consent store.

  • parent: The name of the consent store this Consent artifact belongs to.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsService) Delete added in v0.33.0

Delete: Deletes the specified Consent artifact. Fails if the artifact is referenced by the latest revision of any Consent.

  • name: The resource name of the Consent artifact to delete. To preserve referential integrity, Consent artifacts referenced by the latest revision of a Consent cannot be deleted.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsService) Get added in v0.33.0

Get: Gets the specified Consent artifact.

- name: The resource name of the Consent artifact to retrieve.

func (*ProjectsLocationsDatasetsConsentStoresConsentArtifactsService) List added in v0.33.0

List: Lists the Consent artifacts in the specified consent store.

  • parent: Name of the consent store to retrieve consent artifacts from.

type ProjectsLocationsDatasetsConsentStoresConsentsActivateCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentsActivateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsActivateCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresConsentsActivateCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.activate" call. Exactly one of *Consent or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Consent.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsActivateCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresConsentsActivateCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentsCreateCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsCreateCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresConsentsCreateCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.create" call. Exactly one of *Consent or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Consent.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsCreateCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresConsentsCreateCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentsDeleteCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentsDeleteRevisionCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentsDeleteRevisionCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteRevisionCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteRevisionCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.deleteRevision" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteRevisionCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresConsentsDeleteRevisionCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentsGetCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsGetCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresConsentsGetCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.get" call. Exactly one of *Consent or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Consent.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsGetCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresConsentsGetCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresConsentsGetCall) IfNoneMatch added in v0.33.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsConsentStoresConsentsListCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.list" call. Exactly one of *ListConsentsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListConsentsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) Filter added in v0.33.0

Filter sets the optional parameter "filter": Restricts the consents returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - user_id. For example, `filter='user_id="user123"'`. - consent_artifact - state - revision_create_time - metadata. For example, `filter=Metadata(\"testkey\")=\"value\" or `filter=HasMetadata(\"testkey\")`.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) IfNoneMatch added in v0.33.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) PageSize added in v0.33.0

PageSize sets the optional parameter "pageSize": Limit on the number of Consents to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) PageToken added in v0.33.0

PageToken sets the optional parameter "pageToken": The next_page_token value returned from the previous List request, if any.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListCall) Pages added in v0.33.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.listRevisions" call. Exactly one of *ListConsentRevisionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListConsentRevisionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) Filter added in v0.33.0

Filter sets the optional parameter "filter": Restricts the revisions returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Fields/functions available for filtering are: - user_id. For example, `filter='user_id="user123"'`. - consent_artifact - state - revision_create_time - metadata. For example, `filter=Metadata(\"testkey\")=\"value\" or `filter=HasMetadata(\"testkey\")`.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) IfNoneMatch added in v0.33.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) PageSize added in v0.33.0

PageSize sets the optional parameter "pageSize": Limit on the number of revisions to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) PageToken added in v0.33.0

PageToken sets the optional parameter "pageToken": Token to retrieve the next page of results or empty if there are no more results in the list.

func (*ProjectsLocationsDatasetsConsentStoresConsentsListRevisionsCall) Pages added in v0.33.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsConsentStoresConsentsPatchCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsPatchCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresConsentsPatchCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.patch" call. Exactly one of *Consent or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Consent.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsPatchCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresConsentsPatchCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresConsentsPatchCall) UpdateMask added in v0.33.0

UpdateMask sets the optional parameter "updateMask": Required. The update mask to apply to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. Only the `user_id`, `policies`, `consent_artifact`, and `metadata` fields can be updated.

type ProjectsLocationsDatasetsConsentStoresConsentsRejectCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentsRejectCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsRejectCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresConsentsRejectCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.reject" call. Exactly one of *Consent or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Consent.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsRejectCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresConsentsRejectCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentsRevokeCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentsRevokeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresConsentsRevokeCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresConsentsRevokeCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.consents.revoke" call. Exactly one of *Consent or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Consent.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresConsentsRevokeCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresConsentsRevokeCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresConsentsService added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresConsentsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsConsentStoresConsentsService added in v0.33.0

func NewProjectsLocationsDatasetsConsentStoresConsentsService(s *Service) *ProjectsLocationsDatasetsConsentStoresConsentsService

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) Activate added in v0.33.0

Activate: Activates the latest revision of the specified Consent by committing a new revision with `state` updated to `ACTIVE`. If the latest revision of the specified Consent is in the `ACTIVE` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified consent is in the `REJECTED` or `REVOKED` state.

  • name: The resource name of the Consent to activate, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /consentStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) Create added in v0.33.0

Create: Creates a new Consent in the parent consent store.

- parent: Name of the consent store.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) Delete added in v0.33.0

Delete: Deletes the Consent and its revisions. To keep a record of the Consent but mark it inactive, see [RevokeConsent]. To delete a revision of a Consent, see [DeleteConsentRevision]. This operation does not delete the related Consent artifact.

  • name: The resource name of the Consent to delete, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /consentStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) DeleteRevision added in v0.33.0

DeleteRevision: Deletes the specified revision of a Consent. An INVALID_ARGUMENT error occurs if the specified revision is the latest revision.

  • name: The resource name of the Consent revision to delete, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /consentStores/{consent_store_id}/consents/{consent_id}@{revision_id }`. An INVALID_ARGUMENT error occurs if `revision_id` is not specified in the name.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) Get added in v0.33.0

Get: Gets the specified revision of a Consent, or the latest revision if `revision_id` is not specified in the resource name.

  • name: The resource name of the Consent to retrieve, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /consentStores/{consent_store_id}/consents/{consent_id}`. In order to retrieve a previous revision of the Consent, also provide the revision ID: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /consentStores/{consent_store_id}/consents/{consent_id}@{revision_id }`.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) List added in v0.33.0

List: Lists the Consent in the given consent store, returning each Consent's latest revision.

- parent: Name of the consent store to retrieve Consents from.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) ListRevisions added in v0.33.0

ListRevisions: Lists the revisions of the specified Consent in reverse chronological order.

- name: The resource name of the Consent to retrieve revisions for.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) Patch added in v0.33.0

Patch: Updates the latest revision of the specified Consent by committing a new revision with the changes. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the `REJECTED` or `REVOKED` state.

  • name: Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) Reject added in v0.33.0

Reject: Rejects the latest revision of the specified Consent by committing a new revision with `state` updated to `REJECTED`. If the latest revision of the specified Consent is in the `REJECTED` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the specified Consent is in the `ACTIVE` or `REVOKED` state.

  • name: The resource name of the Consent to reject, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /consentStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name.

func (*ProjectsLocationsDatasetsConsentStoresConsentsService) Revoke added in v0.33.0

Revoke: Revokes the latest revision of the specified Consent by committing a new revision with `state` updated to `REVOKED`. If the latest revision of the specified Consent is in the `REVOKED` state, no new revision is committed. A FAILED_PRECONDITION error occurs if the latest revision of the given consent is in `DRAFT` or `REJECTED` state.

  • name: The resource name of the Consent to revoke, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /consentStores/{consent_store_id}/consents/{consent_id}`. An INVALID_ARGUMENT error occurs if `revision_id` is specified in the name.

type ProjectsLocationsDatasetsConsentStoresCreateCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresCreateCall) ConsentStoreId added in v0.33.0

ConsentStoreId sets the optional parameter "consentStoreId": Required. The ID of the consent store to create. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`. Cannot be changed after creation.

func (*ProjectsLocationsDatasetsConsentStoresCreateCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresCreateCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.create" call. Exactly one of *ConsentStore or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ConsentStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresCreateCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresCreateCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresDeleteCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresDeleteCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresDeleteCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresDeleteCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresDeleteCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresEvaluateUserConsentsCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresEvaluateUserConsentsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresEvaluateUserConsentsCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresEvaluateUserConsentsCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.evaluateUserConsents" call. Exactly one of *EvaluateUserConsentsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *EvaluateUserConsentsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresEvaluateUserConsentsCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresEvaluateUserConsentsCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresEvaluateUserConsentsCall) Pages added in v0.33.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsConsentStoresGetCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresGetCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresGetCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.get" call. Exactly one of *ConsentStore or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ConsentStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresGetCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresGetCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresGetCall) IfNoneMatch added in v0.33.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall added in v0.32.0

type ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall) Do added in v0.32.0

Do executes the "healthcare.projects.locations.datasets.consentStores.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall) Header added in v0.32.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall) IfNoneMatch added in v0.32.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall) OptionsRequestedPolicyVersion added in v0.32.0

func (c *ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsDatasetsConsentStoresGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsLocationsDatasetsConsentStoresListCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresListCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresListCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.list" call. Exactly one of *ListConsentStoresResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListConsentStoresResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresListCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresListCall) Filter added in v0.33.0

Filter sets the optional parameter "filter": Restricts the stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported. For example, `filter=labels.key=value`.

func (*ProjectsLocationsDatasetsConsentStoresListCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresListCall) IfNoneMatch added in v0.33.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsConsentStoresListCall) PageSize added in v0.33.0

PageSize sets the optional parameter "pageSize": Limit on the number of consent stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsConsentStoresListCall) PageToken added in v0.33.0

PageToken sets the optional parameter "pageToken": Token to retrieve the next page of results, or empty to get the first page.

func (*ProjectsLocationsDatasetsConsentStoresListCall) Pages added in v0.33.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsConsentStoresPatchCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresPatchCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresPatchCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.patch" call. Exactly one of *ConsentStore or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ConsentStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresPatchCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresPatchCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresPatchCall) UpdateMask added in v0.33.0

UpdateMask sets the optional parameter "updateMask": Required. The update mask that applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. Only the `labels`, `default_consent_ttl`, and `enable_consent_create_on_update` fields are allowed to be updated.

type ProjectsLocationsDatasetsConsentStoresQueryAccessibleDataCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresQueryAccessibleDataCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresQueryAccessibleDataCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresQueryAccessibleDataCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.queryAccessibleData" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresQueryAccessibleDataCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresQueryAccessibleDataCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresService added in v0.32.0

type ProjectsLocationsDatasetsConsentStoresService struct {
	AttributeDefinitions *ProjectsLocationsDatasetsConsentStoresAttributeDefinitionsService

	ConsentArtifacts *ProjectsLocationsDatasetsConsentStoresConsentArtifactsService

	Consents *ProjectsLocationsDatasetsConsentStoresConsentsService

	UserDataMappings *ProjectsLocationsDatasetsConsentStoresUserDataMappingsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsConsentStoresService added in v0.32.0

func NewProjectsLocationsDatasetsConsentStoresService(s *Service) *ProjectsLocationsDatasetsConsentStoresService

func (*ProjectsLocationsDatasetsConsentStoresService) CheckDataAccess added in v0.33.0

CheckDataAccess: Checks if a particular data_id of a User data mapping in the specified consent store is consented for the specified use.

  • consentStore: Name of the consent store where the requested data_id is stored, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /consentStores/{consent_store_id}`.

func (*ProjectsLocationsDatasetsConsentStoresService) Create added in v0.33.0

Create: Creates a new consent store in the parent dataset. Attempting to create a consent store with the same ID as an existing store fails with an ALREADY_EXISTS error.

- parent: The name of the dataset this consent store belongs to.

func (*ProjectsLocationsDatasetsConsentStoresService) Delete added in v0.33.0

Delete: Deletes the specified consent store and removes all the consent store's data.

- name: The resource name of the consent store to delete.

func (*ProjectsLocationsDatasetsConsentStoresService) EvaluateUserConsents added in v0.33.0

EvaluateUserConsents: Evaluates the user's Consents for all matching User data mappings. Note: User data mappings are indexed asynchronously, which can cause a slight delay between the time mappings are created or updated and when they are included in EvaluateUserConsents results.

  • consentStore: Name of the consent store to retrieve User data mappings from.

func (*ProjectsLocationsDatasetsConsentStoresService) Get added in v0.33.0

Get: Gets the specified consent store.

- name: The resource name of the consent store to get.

func (*ProjectsLocationsDatasetsConsentStoresService) GetIamPolicy added in v0.32.0

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • resource: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

func (*ProjectsLocationsDatasetsConsentStoresService) List added in v0.33.0

List: Lists the consent stores in the specified dataset.

- parent: Name of the dataset.

func (*ProjectsLocationsDatasetsConsentStoresService) Patch added in v0.33.0

Patch: Updates the specified consent store.

  • name: Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /consentStores/{consent_store_id}`. Cannot be changed after creation.

func (*ProjectsLocationsDatasetsConsentStoresService) QueryAccessibleData added in v0.33.0

QueryAccessibleData: Queries all data_ids that are consented for a specified use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. If the request is successful, a detailed response is returned of type QueryAccessibleDataResponse, contained in the response field when the operation finishes. The metadata field type is OperationMetadata. Errors are logged to Cloud Logging (see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging)). For example, the following sample log entry shows a `failed to evaluate consent policy` error that occurred during a QueryAccessibleData call to consent store `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/c onsentStores/{consent_store_id}`. ```json jsonPayload: { @type: "type.googleapis.com/google.cloud.healthcare.logging.QueryAccessibleDa taLogEntry" error: { code: 9 message: "failed to evaluate consent policy" } resourceName: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/c onsentStores/{consent_store_id}/consents/{consent_id}" } logName: "projects/{project_id}/logs/healthcare.googleapis.com%2Fquery_accessib le_data" operation: { id: "projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/o perations/{operation_id}" producer: "healthcare.googleapis.com/QueryAccessibleData" } receiveTimestamp: "TIMESTAMP" resource: { labels: { consent_store_id: "{consent_store_id}" dataset_id: "{dataset_id}" location: "{location_id}" project_id: "{project_id}" } type: "healthcare_consent_store" } severity: "ERROR" timestamp: "TIMESTAMP" ```

  • consentStore: Name of the consent store to retrieve User data mappings from.

func (*ProjectsLocationsDatasetsConsentStoresService) SetIamPolicy added in v0.32.0

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

  • resource: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

func (*ProjectsLocationsDatasetsConsentStoresService) TestIamPermissions added in v0.32.0

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

  • resource: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

type ProjectsLocationsDatasetsConsentStoresSetIamPolicyCall added in v0.32.0

type ProjectsLocationsDatasetsConsentStoresSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresSetIamPolicyCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresSetIamPolicyCall) Do added in v0.32.0

Do executes the "healthcare.projects.locations.datasets.consentStores.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresSetIamPolicyCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresSetIamPolicyCall) Header added in v0.32.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresTestIamPermissionsCall added in v0.32.0

type ProjectsLocationsDatasetsConsentStoresTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresTestIamPermissionsCall) Context added in v0.32.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresTestIamPermissionsCall) Do added in v0.32.0

Do executes the "healthcare.projects.locations.datasets.consentStores.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresTestIamPermissionsCall) Fields added in v0.32.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresTestIamPermissionsCall) Header added in v0.32.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsArchiveCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsArchiveCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsArchiveCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsArchiveCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.userDataMappings.archive" call. Exactly one of *ArchiveUserDataMappingResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ArchiveUserDataMappingResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsArchiveCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsArchiveCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsCreateCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsCreateCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsCreateCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.userDataMappings.create" call. Exactly one of *UserDataMapping or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *UserDataMapping.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsCreateCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsCreateCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsDeleteCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsDeleteCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsDeleteCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.userDataMappings.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsDeleteCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsDeleteCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsGetCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsGetCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsGetCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.userDataMappings.get" call. Exactly one of *UserDataMapping or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *UserDataMapping.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsGetCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsGetCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsGetCall) IfNoneMatch added in v0.33.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.userDataMappings.list" call. Exactly one of *ListUserDataMappingsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListUserDataMappingsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) Filter added in v0.33.0

Filter sets the optional parameter "filter": Restricts the user data mappings returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The fields available for filtering are: - data_id - user_id. For example, `filter=user_id=\"user123\". - archived - archive_time

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) IfNoneMatch added in v0.33.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) PageSize added in v0.33.0

PageSize sets the optional parameter "pageSize": Limit on the number of User data mappings to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) PageToken added in v0.33.0

PageToken sets the optional parameter "pageToken": Token to retrieve the next page of results, or empty to get the first page.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsListCall) Pages added in v0.33.0

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsPatchCall added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsPatchCall) Context added in v0.33.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsPatchCall) Do added in v0.33.0

Do executes the "healthcare.projects.locations.datasets.consentStores.userDataMappings.patch" call. Exactly one of *UserDataMapping or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *UserDataMapping.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsPatchCall) Fields added in v0.33.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsPatchCall) Header added in v0.33.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsPatchCall) UpdateMask added in v0.33.0

UpdateMask sets the optional parameter "updateMask": Required. The update mask that applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. Only the `data_id`, `user_id` and `resource_attributes` fields can be updated.

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsService added in v0.33.0

type ProjectsLocationsDatasetsConsentStoresUserDataMappingsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsConsentStoresUserDataMappingsService added in v0.33.0

func NewProjectsLocationsDatasetsConsentStoresUserDataMappingsService(s *Service) *ProjectsLocationsDatasetsConsentStoresUserDataMappingsService

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsService) Archive added in v0.33.0

Archive: Archives the specified User data mapping.

- name: The resource name of the User data mapping to archive.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsService) Create added in v0.33.0

Create: Creates a new User data mapping in the parent consent store.

- parent: Name of the consent store.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsService) Delete added in v0.33.0

Delete: Deletes the specified User data mapping.

- name: The resource name of the User data mapping to delete.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsService) Get added in v0.33.0

Get: Gets the specified User data mapping.

- name: The resource name of the User data mapping to retrieve.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsService) List added in v0.33.0

List: Lists the User data mappings in the specified consent store.

  • parent: Name of the consent store to retrieve User data mappings from.

func (*ProjectsLocationsDatasetsConsentStoresUserDataMappingsService) Patch added in v0.33.0

Patch: Updates the specified User data mapping.

  • name: 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_mappin g_id}`.

type ProjectsLocationsDatasetsCreateCall

type ProjectsLocationsDatasetsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsCreateCall) DatasetId

DatasetId sets the optional parameter "datasetId": The ID of the dataset that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`.

func (*ProjectsLocationsDatasetsCreateCall) Do

Do executes the "healthcare.projects.locations.datasets.create" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsDeidentifyCall

type ProjectsLocationsDatasetsDeidentifyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDeidentifyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDeidentifyCall) Do

Do executes the "healthcare.projects.locations.datasets.deidentify" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDeidentifyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDeidentifyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsDeleteCall

type ProjectsLocationsDatasetsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsDicomStoresCreateCall

type ProjectsLocationsDatasetsDicomStoresCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresCreateCall) DicomStoreId

DicomStoreId sets the optional parameter "dicomStoreId": The ID of the DICOM store that is being created. Any string value up to 256 characters in length.

func (*ProjectsLocationsDatasetsDicomStoresCreateCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.create" call. Exactly one of *DicomStore or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *DicomStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsDicomStoresDeidentifyCall added in v0.12.0

type ProjectsLocationsDatasetsDicomStoresDeidentifyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresDeidentifyCall) Context added in v0.12.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresDeidentifyCall) Do added in v0.12.0

Do executes the "healthcare.projects.locations.datasets.dicomStores.deidentify" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresDeidentifyCall) Fields added in v0.12.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresDeidentifyCall) Header added in v0.12.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsDicomStoresDeleteCall

type ProjectsLocationsDatasetsDicomStoresDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsDicomStoresExportCall

type ProjectsLocationsDatasetsDicomStoresExportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresExportCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresExportCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.export" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresExportCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresExportCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsDicomStoresGetCall

type ProjectsLocationsDatasetsDicomStoresGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresGetCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.get" call. Exactly one of *DicomStore or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *DicomStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall

type ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall) OptionsRequestedPolicyVersion added in v0.8.0

func (c *ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsDatasetsDicomStoresGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsLocationsDatasetsDicomStoresImportCall

type ProjectsLocationsDatasetsDicomStoresImportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresImportCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresImportCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.import" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresImportCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresImportCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsDicomStoresListCall

type ProjectsLocationsDatasetsDicomStoresListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresListCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.list" call. Exactly one of *ListDicomStoresResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListDicomStoresResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresListCall) Filter

Filter sets the optional parameter "filter": Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported. For example, `labels.key=value`.

func (*ProjectsLocationsDatasetsDicomStoresListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsDicomStoresListCall) PageSize

PageSize sets the optional parameter "pageSize": Limit on the number of DICOM stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsDicomStoresListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from the previous List request, if any.

func (*ProjectsLocationsDatasetsDicomStoresListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsDicomStoresPatchCall

type ProjectsLocationsDatasetsDicomStoresPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresPatchCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.patch" call. Exactly one of *DicomStore or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *DicomStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

type ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall

type ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.searchForInstances" call.

func (*ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall

type ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.searchForSeries" call.

func (*ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall

type ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.searchForStudies" call.

func (*ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresService

type ProjectsLocationsDatasetsDicomStoresService struct {
	Studies *ProjectsLocationsDatasetsDicomStoresStudiesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsDicomStoresService

func NewProjectsLocationsDatasetsDicomStoresService(s *Service) *ProjectsLocationsDatasetsDicomStoresService

func (*ProjectsLocationsDatasetsDicomStoresService) Create

Create: Creates a new DICOM store within the parent dataset.

- parent: The name of the dataset this DICOM store belongs to.

func (*ProjectsLocationsDatasetsDicomStoresService) Deidentify added in v0.12.0

Deidentify: De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyDicomStoreSummary. The LRO result may still be successful if de-identification fails for some DICOM instances. The output DICOM store will not contain these failed resources. The number of resources processed are tracked in Operation.metadata. Error details are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging).

  • sourceStore: Source DICOM store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) Delete

Delete: Deletes the specified DICOM store and removes all images that are contained within it.

- name: The resource name of the DICOM store to delete.

func (*ProjectsLocationsDatasetsDicomStoresService) Export

Export: Exports data to the specified destination by copying it from the DICOM store. Errors are also logged to Cloud Logging. For more information, see Viewing errors in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata.

  • name: The DICOM store resource name from which to export the data. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) Get

Get: Gets the specified DICOM store.

- name: The resource name of the DICOM store to get.

func (*ProjectsLocationsDatasetsDicomStoresService) GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • resource: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

func (*ProjectsLocationsDatasetsDicomStoresService) Import

Import: Imports data into the DICOM store by copying it from the specified source. Errors are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata.

  • name: The name of the DICOM store resource into which the data is imported. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) List

List: Lists the DICOM stores in the given dataset.

- parent: Name of the dataset.

func (*ProjectsLocationsDatasetsDicomStoresService) Patch

Patch: Updates the specified DICOM store.

  • name: Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) SearchForInstances

SearchForInstances: SearchForInstances returns a list of matching instances. See RetrieveTransaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see Search transaction (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Searching for studies, series, instances, and frames (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).

  • dicomWebPath: The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) SearchForSeries

SearchForSeries: SearchForSeries returns a list of matching series. See RetrieveTransaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see Search transaction (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Searching for studies, series, instances, and frames (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).

  • dicomWebPath: The path of the SearchForSeries DICOMweb request. For example, `series` or `studies/{study_uid}/series`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) SearchForStudies

SearchForStudies: SearchForStudies returns a list of matching studies. See RetrieveTransaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForStudies, see Search transaction (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see Searching for studies, series, instances, and frames (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).

  • dicomWebPath: The path of the SearchForStudies DICOMweb request. For example, `studies`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

  • resource: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

func (*ProjectsLocationsDatasetsDicomStoresService) StoreInstances

StoreInstances: StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See Store Transaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see Store transaction (https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Storing DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data).

  • dicomWebPath: The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresService) TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

  • resource: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

type ProjectsLocationsDatasetsDicomStoresSetIamPolicyCall

type ProjectsLocationsDatasetsDicomStoresSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresSetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresSetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsDicomStoresStoreInstancesCall

type ProjectsLocationsDatasetsDicomStoresStoreInstancesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStoreInstancesCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStoreInstancesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.storeInstances" call.

func (*ProjectsLocationsDatasetsDicomStoresStoreInstancesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStoreInstancesCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall

type ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.delete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall

type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall

type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall

type ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.searchForInstances" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall

type ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.searchForSeries" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.delete" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFramesCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFramesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFramesCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFramesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFramesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFramesCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFramesCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRenderedCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRenderedCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRenderedCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRenderedCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRenderedCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRenderedCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRenderedCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesService

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesService struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesService) RetrieveFrames

RetrieveFrames: RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See RetrieveTransaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveFrames, see DICOM frames (https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see Retrieving DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data).

  • dicomWebPath: The path of the RetrieveFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/fr ames/{frame_list}`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesService) RetrieveRendered

RetrieveRendered: RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See RetrieveTransaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see Rendered resources (https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see Retrieving consumer image formats (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats).

  • dicomWebPath: The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/fr ames/{frame_list}/rendered`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesService

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesService struct {
	Frames *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesService
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesService) Delete

Delete: DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see Deleting a study, series, or instance (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).

  • dicomWebPath: The path of the DeleteInstance request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesService) RetrieveInstance

RetrieveInstance: RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See RetrieveTransaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see DICOM study/series/instances (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and DICOM instances (https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see Retrieving an instance (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_an_instance).

  • dicomWebPath: The path of the RetrieveInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesService) RetrieveMetadata

RetrieveMetadata: RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See RetrieveTransaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see Metadata resources (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see Retrieving metadata (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).

  • dicomWebPath: The path of the RetrieveInstanceMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/me tadata`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesService) RetrieveRendered

RetrieveRendered: RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See RetrieveTransaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see Rendered resources (https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see Retrieving consumer image formats (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats).

  • dicomWebPath: The path of the RetrieveRenderedInstance DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}/re ndered`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesService

type ProjectsLocationsDatasetsDicomStoresStudiesSeriesService struct {
	Instances *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesService
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesService) Delete

Delete: DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see Deleting a study, series, or instance (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).

  • dicomWebPath: The path of the DeleteSeries request. For example, `studies/{study_uid}/series/{series_uid}`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesService) RetrieveMetadata

RetrieveMetadata: RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See RetrieveTransaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see Metadata resources (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see Retrieving metadata (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).

  • dicomWebPath: The path of the RetrieveSeriesMetadata DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}/metadata`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesService) RetrieveSeries

RetrieveSeries: RetrieveSeries returns all instances within the given study and series. See RetrieveTransaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see DICOM study/series/instances (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see Retrieving DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data).

  • dicomWebPath: The path of the RetrieveSeries DICOMweb request. For example, `studies/{study_uid}/series/{series_uid}`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesSeriesService) SearchForInstances

SearchForInstances: SearchForInstances returns a list of matching instances. See RetrieveTransaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see Search transaction (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Searching for studies, series, instances, and frames (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).

  • dicomWebPath: The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

type ProjectsLocationsDatasetsDicomStoresStudiesService

type ProjectsLocationsDatasetsDicomStoresStudiesService struct {
	Series *ProjectsLocationsDatasetsDicomStoresStudiesSeriesService
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesService) Delete

Delete: DeleteStudy deletes all instances within the given study using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see Deleting a study, series, or instance (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).

  • dicomWebPath: The path of the DeleteStudy request. For example, `studies/{study_uid}`.
  • parent: .

func (*ProjectsLocationsDatasetsDicomStoresStudiesService) RetrieveMetadata

RetrieveMetadata: RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See RetrieveTransaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see Metadata resources (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see Retrieving metadata (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).

  • dicomWebPath: The path of the RetrieveStudyMetadata DICOMweb request. For example, `studies/{study_uid}/metadata`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesService) RetrieveStudy

RetrieveStudy: RetrieveStudy returns all instances within the given study. See RetrieveTransaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see DICOM study/series/instances (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see Retrieving DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data).

  • dicomWebPath: The path of the RetrieveStudy DICOMweb request. For example, `studies/{study_uid}`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesService) SearchForInstances

SearchForInstances: SearchForInstances returns a list of matching instances. See RetrieveTransaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see Search transaction (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see Searching for studies, series, instances, and frames (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).

  • dicomWebPath: The path of the SearchForInstancesRequest DICOMweb request. For example, `instances`, `series/{series_uid}/instances`, or `studies/{study_uid}/instances`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesService) SearchForSeries

SearchForSeries: SearchForSeries returns a list of matching series. See RetrieveTransaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see Search transaction (https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see Searching for studies, series, instances, and frames (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).

  • dicomWebPath: The path of the SearchForSeries DICOMweb request. For example, `series` or `studies/{study_uid}/series`.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

func (*ProjectsLocationsDatasetsDicomStoresStudiesService) StoreInstances

StoreInstances: StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See Store Transaction (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see Store transaction (https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see Storing DICOM data (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data).

  • dicomWebPath: The path of the StoreInstances DICOMweb request. For example, `studies/[{study_uid}]`. Note that the `study_uid` is optional.
  • parent: The name of the DICOM store that is being accessed. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /dicomStores/{dicom_store_id}`.

type ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall

type ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.studies.storeInstances" call.

func (*ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsDicomStoresTestIamPermissionsCall

type ProjectsLocationsDatasetsDicomStoresTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsDicomStoresTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsDicomStoresTestIamPermissionsCall) Do

Do executes the "healthcare.projects.locations.datasets.dicomStores.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsDicomStoresTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsDicomStoresTestIamPermissionsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresConfigureSearchCall added in v0.50.0

type ProjectsLocationsDatasetsFhirStoresConfigureSearchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresConfigureSearchCall) Context added in v0.50.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresConfigureSearchCall) Do added in v0.50.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.configureSearch" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresConfigureSearchCall) Fields added in v0.50.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresConfigureSearchCall) Header added in v0.50.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresCreateCall

type ProjectsLocationsDatasetsFhirStoresCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresCreateCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.create" call. Exactly one of *FhirStore or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *FhirStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresCreateCall) FhirStoreId

FhirStoreId sets the optional parameter "fhirStoreId": The ID of the FHIR store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`.

func (*ProjectsLocationsDatasetsFhirStoresCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresDeidentifyCall added in v0.12.0

type ProjectsLocationsDatasetsFhirStoresDeidentifyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresDeidentifyCall) Context added in v0.12.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresDeidentifyCall) Do added in v0.12.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.deidentify" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresDeidentifyCall) Fields added in v0.12.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresDeidentifyCall) Header added in v0.12.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresDeleteCall

type ProjectsLocationsDatasetsFhirStoresDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresExportCall

type ProjectsLocationsDatasetsFhirStoresExportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresExportCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresExportCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.export" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresExportCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresExportCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirCapabilitiesCall added in v0.5.0

type ProjectsLocationsDatasetsFhirStoresFhirCapabilitiesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirCapabilitiesCall) Context added in v0.5.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirCapabilitiesCall) Do added in v0.5.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.capabilities" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirCapabilitiesCall) Fields added in v0.5.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirCapabilitiesCall) Header added in v0.5.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresFhirCapabilitiesCall) IfNoneMatch added in v0.5.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsFhirStoresFhirConceptMapSearchTranslateCall added in v0.23.0

type ProjectsLocationsDatasetsFhirStoresFhirConceptMapSearchTranslateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapSearchTranslateCall) Code added in v0.23.0

Code sets the optional parameter "code": The code to translate.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapSearchTranslateCall) ConceptMapVersion added in v0.23.0

ConceptMapVersion sets the optional parameter "conceptMapVersion": The version of the concept map to use. If unset, the most current version is used.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapSearchTranslateCall) Context added in v0.23.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapSearchTranslateCall) Do added in v0.23.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.ConceptMap-search-translate" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapSearchTranslateCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapSearchTranslateCall) Header added in v0.23.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapSearchTranslateCall) IfNoneMatch added in v0.23.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapSearchTranslateCall) Source added in v0.23.0

Source sets the optional parameter "source": The source value set of the concept map to be used. If unset, target is used to search for concept maps.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapSearchTranslateCall) System added in v0.23.0

System sets the optional parameter "system": The system for the code to be translated.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapSearchTranslateCall) Target added in v0.23.0

Target sets the optional parameter "target": The target value set of the concept map to be used. If unset, source is used to search for concept maps.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapSearchTranslateCall) Url added in v0.23.0

Url sets the optional parameter "url": The canonical url of the concept map to use. If unset, the source and target is used to search for concept maps.

type ProjectsLocationsDatasetsFhirStoresFhirConceptMapTranslateCall added in v0.23.0

type ProjectsLocationsDatasetsFhirStoresFhirConceptMapTranslateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapTranslateCall) Code added in v0.23.0

Code sets the optional parameter "code": The code to translate.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapTranslateCall) ConceptMapVersion added in v0.23.0

ConceptMapVersion sets the optional parameter "conceptMapVersion": The version of the concept map to use. If unset, the most current version is used.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapTranslateCall) Context added in v0.23.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapTranslateCall) Do added in v0.23.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.ConceptMap-translate" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapTranslateCall) Fields added in v0.23.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapTranslateCall) Header added in v0.23.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapTranslateCall) IfNoneMatch added in v0.23.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsFhirStoresFhirConceptMapTranslateCall) System added in v0.23.0

System sets the optional parameter "system": The system for the code to be translated.

type ProjectsLocationsDatasetsFhirStoresFhirConditionalDeleteCall added in v0.5.0

type ProjectsLocationsDatasetsFhirStoresFhirConditionalDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalDeleteCall) Context added in v0.5.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalDeleteCall) Do added in v0.5.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalDeleteCall) Fields added in v0.5.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalDeleteCall) Header added in v0.5.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirConditionalPatchCall added in v0.5.0

type ProjectsLocationsDatasetsFhirStoresFhirConditionalPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalPatchCall) Context added in v0.5.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalPatchCall) Do added in v0.5.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalPatchCall) Fields added in v0.5.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalPatchCall) Header added in v0.5.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirConditionalUpdateCall added in v0.5.0

type ProjectsLocationsDatasetsFhirStoresFhirConditionalUpdateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalUpdateCall) Context added in v0.5.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalUpdateCall) Do added in v0.5.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalUpdateCall) Fields added in v0.5.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirConditionalUpdateCall) Header added in v0.5.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirCreateCall added in v0.5.0

type ProjectsLocationsDatasetsFhirStoresFhirCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirCreateCall) Context added in v0.5.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirCreateCall) Do added in v0.5.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.create" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirCreateCall) Fields added in v0.5.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirCreateCall) Header added in v0.5.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirDeleteCall

type ProjectsLocationsDatasetsFhirStoresFhirDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.delete" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall added in v0.5.0

type ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall) Context added in v0.5.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall) Do added in v0.5.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall) Fields added in v0.5.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirExecuteBundleCall) Header added in v0.5.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirHistoryCall added in v0.5.0

type ProjectsLocationsDatasetsFhirStoresFhirHistoryCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) At added in v0.5.0

At sets the optional parameter "_at": Only include resource versions that were current at some point during the time period specified in the date time value. The date parameter format is yyyy-mm-ddThh:mm:ss[Z|(+|-)hh:mm] Clients may specify any of the following: * An entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `_at=2019-01-20` * A specific second: `_at=2018-12-31T23:59:58Z`

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) Context added in v0.5.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) Count added in v0.5.0

Count sets the optional parameter "_count": The maximum number of search results on a page. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) Do added in v0.5.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.history" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) Fields added in v0.5.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) Header added in v0.5.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) IfNoneMatch added in v0.5.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) PageToken added in v0.11.0

PageToken sets the optional parameter "_page_token": Used to retrieve the first, previous, next, or last page of resource versions when using pagination. Value should be set to the value of `_page_token` set in next or previous page links' URLs. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made.

func (*ProjectsLocationsDatasetsFhirStoresFhirHistoryCall) Since added in v0.5.0

Since sets the optional parameter "_since": Only include resource versions that were created at or after the given instant in time. The instant in time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz (for example 2015-02-07T13:28:17.239+02:00 or 2017-01-01T00:00:00Z). The time must be specified to the second and include a time zone.

type ProjectsLocationsDatasetsFhirStoresFhirObservationLastnCall added in v0.5.0

type ProjectsLocationsDatasetsFhirStoresFhirObservationLastnCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirObservationLastnCall) Context added in v0.5.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirObservationLastnCall) Do added in v0.5.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.Observation-lastn" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirObservationLastnCall) Fields added in v0.5.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirObservationLastnCall) Header added in v0.5.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresFhirObservationLastnCall) IfNoneMatch added in v0.5.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsFhirStoresFhirPatchCall

type ProjectsLocationsDatasetsFhirStoresFhirPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatchCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.patch" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall added in v0.5.0

type ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Context added in v0.5.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Count added in v0.10.0

Count sets the optional parameter "_count": Maximum number of resources in a page. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Do added in v0.5.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.Patient-everything" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) End added in v0.5.0

End sets the optional parameter "end": The response includes records prior to the end date. If no end date is provided, all records subsequent to the start date are in scope.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Fields added in v0.5.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Header added in v0.5.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) IfNoneMatch added in v0.5.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) PageToken added in v0.10.0

PageToken sets the optional parameter "_page_token": Used to retrieve the next or previous page of results when using pagination. Set `_page_token` to the value of _page_token set in next or previous page links' url. Next and previous page are returned in the response bundle's links field, where `link.relation` is "previous" or "next". Omit `_page_token` if no previous request has been made.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Since added in v0.30.0

Since sets the optional parameter "_since": If provided, only resources updated after this time are returned. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Start added in v0.5.0

Start sets the optional parameter "start": The response includes records subsequent to the start date. If no start date is provided, all records prior to the end date are in scope.

func (*ProjectsLocationsDatasetsFhirStoresFhirPatientEverythingCall) Type added in v0.30.0

Type sets the optional parameter "_type": String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are returned.

type ProjectsLocationsDatasetsFhirStoresFhirReadCall added in v0.5.0

type ProjectsLocationsDatasetsFhirStoresFhirReadCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirReadCall) Context added in v0.5.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirReadCall) Do added in v0.5.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.read" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirReadCall) Fields added in v0.5.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirReadCall) Header added in v0.5.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresFhirReadCall) IfNoneMatch added in v0.5.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsFhirStoresFhirResourcePurgeCall added in v0.5.0

type ProjectsLocationsDatasetsFhirStoresFhirResourcePurgeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirResourcePurgeCall) Context added in v0.5.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirResourcePurgeCall) Do added in v0.5.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-purge" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresFhirResourcePurgeCall) Fields added in v0.5.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirResourcePurgeCall) Header added in v0.5.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirResourceValidateCall added in v0.40.0

type ProjectsLocationsDatasetsFhirStoresFhirResourceValidateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirResourceValidateCall) Context added in v0.40.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirResourceValidateCall) Do added in v0.40.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.Resource-validate" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirResourceValidateCall) Fields added in v0.40.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirResourceValidateCall) Header added in v0.40.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresFhirResourceValidateCall) Profile added in v0.40.0

Profile sets the optional parameter "profile": A profile that this resource should be validated against.

type ProjectsLocationsDatasetsFhirStoresFhirSearchCall

type ProjectsLocationsDatasetsFhirStoresFhirSearchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.search" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall added in v0.38.0

type ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall) Context added in v0.38.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall) Do added in v0.38.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.search-type" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall) Fields added in v0.38.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirSearchTypeCall) Header added in v0.38.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirService

type ProjectsLocationsDatasetsFhirStoresFhirService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsFhirStoresFhirService

func NewProjectsLocationsDatasetsFhirStoresFhirService(s *Service) *ProjectsLocationsDatasetsFhirStoresFhirService

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Capabilities added in v0.5.0

Capabilities: Gets the FHIR capability statement (STU3 (https://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), R4 (https://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the conformance statement (https://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction (STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the conformance interaction (https://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource.

- name: Name of the FHIR store to retrieve the capabilities for.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) ConceptMapSearchTranslate added in v0.23.0

ConceptMapSearchTranslate: Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation (DSTU2 (https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), STU3 (https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), R4 (https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

  • parent: The name for the FHIR store containing the concept map(s) to use for the translation.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) ConceptMapTranslate added in v0.23.0

ConceptMapTranslate: Translates a code from one value set to another using a concept map. You can provide your own concept maps to translate any code system to another code system. Implements the FHIR standard $translate operation (DSTU2 (https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), STU3 (https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), R4 (https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

- name: The URL for the concept map to use for the translation.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) ConditionalDelete added in v0.5.0

ConditionalDelete: Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.12.1), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#3.1.0.7.1)). If multiple resources match, all matching resources are deleted. Search terms are provided as query parameters following the same pattern as the search method. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.delete` permissions on the parent FHIR store. For samples that show how to call `conditionalDelete`, see Conditionally deleting a FHIR resource (/healthcare/docs/how-tos/fhir-resources#conditionally_deleting_a_fhir _resource).

func (*ProjectsLocationsDatasetsFhirStoresFhirService) ConditionalPatch added in v0.5.0

ConditionalPatch: If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a JSON Patch (http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction (STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#patch), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` permission on the parent FHIR store and the `healthcare.fhirResources.patch` permission on the requested FHIR store resource. For samples that show how to call `conditionalPatch`, see Conditionally patching a FHIR resource (/healthcare/docs/how-tos/fhir-resources#conditionally_patching_a_fhir _resource).

func (*ProjectsLocationsDatasetsFhirStoresFhirService) ConditionalUpdate added in v0.5.0

ConditionalUpdate: If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.10.2), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#cond-update), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#cond-update)). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request returns a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource is created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires the`healthcare.fhirStores.searchResources` and `healthcare.fhirResources.update` permissions on the parent FHIR store. For samples that show how to call `conditionalUpdate`, see Conditionally updating a FHIR resource (/healthcare/docs/how-tos/fhir-resources#conditionally_updating_a_fhir _resource).

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Create added in v0.5.0

Create: Creates a FHIR resource. Implements the FHIR standard create interaction (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#create), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#create), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body contains a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `create`, see Creating a FHIR resource (/healthcare/docs/how-tos/fhir-resources#creating_a_fhir_resource).

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Delete

Delete: Deletes a FHIR resource. Implements the FHIR standard delete interaction (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#delete), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources are moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. For samples that show how to call `delete`, see Deleting a FHIR resource (/healthcare/docs/how-tos/fhir-resources#deleting_a_fhir_resource).

- name: The name of the resource to delete.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) ExecuteBundle added in v0.5.0

ExecuteBundle: Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#transaction), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction the response body contains a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body contains a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. This method requires permission for executing the requests in the bundle. The `executeBundle` permission grants permission to execute the request in the bundle but you must grant sufficient permissions to execute the individual requests in the bundle. For example, if the bundle contains a `create` request, you must have permission to execute the `create` request. Logging is available for the `executeBundle` permission. For samples that show how to call `executeBundle`, see Managing FHIR resources using FHIR bundles (/healthcare/docs/how-tos/fhir-bundles).

  • parent: Name of the FHIR store in which this bundle will be executed.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) History

History: Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#history), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#history), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#history)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `history`, see Listing FHIR resource versions (/healthcare/docs/how-tos/fhir-resources#listing_fhir_resource_version s).

- name: The name of the resource to retrieve.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) ObservationLastn added in v0.5.0

ObservationLastn: Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn (STU3 (https://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn), R4 (https://hl7.org/implement/standards/fhir/R4/observation-operations.html#lastn)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

- parent: Name of the FHIR store to retrieve resources from.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Patch

Patch: Updates part of an existing resource by applying the operations specified in a JSON Patch (http://jsonpatch.com/) document. Implements the FHIR standard patch interaction (STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#patch), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `patch`, see Patching a FHIR resource (/healthcare/docs/how-tos/fhir-resources#patching_a_fhir_resource).

- name: The name of the resource to update.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) PatientEverything added in v0.5.0

PatientEverything: Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), STU3 (https://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), R4 (https://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition (DSTU2 (https://hl7.org/fhir/DSTU2/compartment-patient.html), STU3 (http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), R4 (https://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see Getting all patient compartment resources (/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartme nt_resources).

  • name: Name of the `Patient` resource for which the information is required.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Read added in v0.5.0

Read: Gets the contents of a FHIR resource. Implements the FHIR standard read interaction (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#read), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#read), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#read)). Also supports the FHIR standard conditional read interaction (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#cread), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#cread), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `read`, see Getting a FHIR resource (/healthcare/docs/how-tos/fhir-resources#getting_a_fhir_resource).

- name: The name of the resource to retrieve.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) ResourcePurge added in v0.5.0

ResourcePurge: Deletes all the historical versions of a resource (excluding the current version) from the FHIR store. To remove all versions of a resource, first delete the current version and then call this method. This is not a FHIR standard operation. For samples that show how to call `Resource-purge`, see Deleting historical versions of a FHIR resource (/healthcare/docs/how-tos/fhir-resources#deleting_historical_versions_ of_a_fhir_resource).

- name: The name of the resource to purge.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) ResourceValidate added in v0.40.0

ResourceValidate: Validates an input FHIR resource's conformance to its profiles and the profiles configured on the FHIR store. Implements the FHIR extended operation $validate (DSTU2 (http://hl7.org/implement/standards/fhir/DSTU2/resource-operations.html#validate), STU3 (http://hl7.org/implement/standards/fhir/STU3/resource-operations.html#validate), or R4 (http://hl7.org/implement/standards/fhir/R4/resource-operation-validate.html)). The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The `Parameters` input syntax is not supported. The `profile` query parameter can be used to request that the resource only be validated against a specific profile. If a profile with the given URL cannot be found in the FHIR store then an error is returned. Errors generated by validation contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Search

Search: Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#search), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/search.html), STU3 (https://hl7.org/implement/standards/fhir/STU3/search.html), R4 (https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry (STU3 (https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), R4 (https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains pagination links. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see Searching for FHIR resources (/healthcare/docs/how-tos/fhir-search) and Advanced FHIR search features (/healthcare/docs/how-tos/fhir-advanced-search).

- parent: Name of the FHIR store to retrieve resources from.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) SearchType added in v0.38.0

SearchType: Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#search), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#search), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/search.html), STU3 (https://hl7.org/implement/standards/fhir/STU3/search.html), R4 (https://hl7.org/implement/standards/fhir/R4/search.html)). Supports four methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method across all resources. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method for the specified type. The `GET` and `POST` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry (STU3 (https://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), R4 (https://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` contains pagination links. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. For samples and detailed information, see Searching for FHIR resources (/healthcare/docs/how-tos/fhir-search) and Advanced FHIR search features (/healthcare/docs/how-tos/fhir-advanced-search).

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Update

Update: Updates the entire contents of a resource. Implements the FHIR standard update interaction (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#update), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#update), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body contains a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `update`, see Updating a FHIR resource (/healthcare/docs/how-tos/fhir-resources#updating_a_fhir_resource).

- name: The name of the resource to update.

func (*ProjectsLocationsDatasetsFhirStoresFhirService) Vread added in v0.5.0

Vread: Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction (DSTU2 (https://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), STU3 (https://hl7.org/implement/standards/fhir/STU3/http.html#vread), R4 (https://hl7.org/implement/standards/fhir/R4/http.html#vread)). On success, the response body contains a JSON-encoded representation of the resource. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. For samples that show how to call `vread`, see Retrieving a FHIR resource version (/healthcare/docs/how-tos/fhir-resources#retrieving_a_fhir_resource_ve rsion).

- name: The name of the resource version to retrieve.

type ProjectsLocationsDatasetsFhirStoresFhirUpdateCall

type ProjectsLocationsDatasetsFhirStoresFhirUpdateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirUpdateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirUpdateCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.update" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirUpdateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresFhirVreadCall added in v0.5.0

type ProjectsLocationsDatasetsFhirStoresFhirVreadCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresFhirVreadCall) Context added in v0.5.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresFhirVreadCall) Do added in v0.5.0

Do executes the "healthcare.projects.locations.datasets.fhirStores.fhir.vread" call.

func (*ProjectsLocationsDatasetsFhirStoresFhirVreadCall) Fields added in v0.5.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresFhirVreadCall) Header added in v0.5.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresFhirVreadCall) IfNoneMatch added in v0.5.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsFhirStoresGetCall

type ProjectsLocationsDatasetsFhirStoresGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresGetCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.get" call. Exactly one of *FhirStore or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *FhirStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall

type ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall) OptionsRequestedPolicyVersion added in v0.8.0

func (c *ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsDatasetsFhirStoresGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsLocationsDatasetsFhirStoresImportCall

type ProjectsLocationsDatasetsFhirStoresImportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresImportCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresImportCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.import" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresImportCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresImportCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresListCall

type ProjectsLocationsDatasetsFhirStoresListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresListCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.list" call. Exactly one of *ListFhirStoresResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListFhirStoresResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresListCall) Filter

Filter sets the optional parameter "filter": Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported, for example `labels.key=value`.

func (*ProjectsLocationsDatasetsFhirStoresListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsFhirStoresListCall) PageSize

PageSize sets the optional parameter "pageSize": Limit on the number of FHIR stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsFhirStoresListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from the previous List request, if any.

func (*ProjectsLocationsDatasetsFhirStoresListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsFhirStoresPatchCall

type ProjectsLocationsDatasetsFhirStoresPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresPatchCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.patch" call. Exactly one of *FhirStore or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *FhirStore.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsFhirStoresPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

type ProjectsLocationsDatasetsFhirStoresService

type ProjectsLocationsDatasetsFhirStoresService struct {
	Fhir *ProjectsLocationsDatasetsFhirStoresFhirService
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsFhirStoresService

func NewProjectsLocationsDatasetsFhirStoresService(s *Service) *ProjectsLocationsDatasetsFhirStoresService

func (*ProjectsLocationsDatasetsFhirStoresService) ConfigureSearch added in v0.50.0

ConfigureSearch: Configure the search parameters for the FHIR store and reindex resources in the FHIR store according to the defined search parameters. The search parameters provided in this request will replace any previous search configuration. The target SearchParameter resources need to exist in the store before calling ConfigureSearch, otherwise an error will occur. This method returns an Operation that can be used to track the progress of the reindexing by calling GetOperation.

  • name: The name of the FHIR store to configure, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /fhirStores/{fhir_store_id}`.

func (*ProjectsLocationsDatasetsFhirStoresService) Create

Create: Creates a new FHIR store within the parent dataset.

- parent: The name of the dataset this FHIR store belongs to.

func (*ProjectsLocationsDatasetsFhirStoresService) Deidentify added in v0.12.0

Deidentify: De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirStoreSummary. The number of resources processed are tracked in Operation.metadata. Error details are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging).

  • sourceStore: Source FHIR store resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /fhirStores/{fhir_store_id}`.

func (*ProjectsLocationsDatasetsFhirStoresService) Delete

Delete: Deletes the specified FHIR store and removes all resources within it.

- name: The resource name of the FHIR store to delete.

func (*ProjectsLocationsDatasetsFhirStoresService) Export

Export: Export resources from the FHIR store to the specified destination. This method returns an Operation that can be used to track the status of the export by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

  • name: The name of the FHIR store to export resource from, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /fhirStores/{fhir_store_id}`.

func (*ProjectsLocationsDatasetsFhirStoresService) Get

Get: Gets the configuration of the specified FHIR store.

- name: The resource name of the FHIR store to get.

func (*ProjectsLocationsDatasetsFhirStoresService) GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • resource: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

func (*ProjectsLocationsDatasetsFhirStoresService) Import

Import: Import resources to the FHIR store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some FHIR store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty FHIR store that is not being used by other clients. In cases where this method is not appropriate, consider using ExecuteBundle to load data. Every resource in the input must contain a client-supplied ID. Each resource is stored using the supplied ID regardless of the enable_update_create setting on the FHIR store. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Cloud Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. The import process does not enforce referential integrity, regardless of the disable_referential_integrity setting on the FHIR store. This allows the import of resources with arbitrary interdependencies without considering grouping or ordering, but if the input data contains invalid references or if some resources fail to be imported, the FHIR store might be left in a state that violates referential integrity. The import process does not trigger Pub/Sub notification or BigQuery streaming update, regardless of how those are configured on the FHIR store. If a resource with the specified ID already exists, the most recent version of the resource is overwritten without creating a new historical version, regardless of the disable_resource_versioning setting on the FHIR store. If transient failures occur during the import, it is possible that successfully imported resources will be overwritten more than once. The import operation is idempotent unless the input data contains multiple valid resources with the same ID but different contents. In that case, after the import completes, the store contains exactly one resource with that ID but there is no ordering guarantee on which version of the contents it will have. The operation result counters do not count duplicate IDs as an error and count one success for each resource in the input, which might result in a success count larger than the number of resources in the FHIR store. This often occurs when importing data organized in bundles produced by Patient-everything where each bundle contains its own copy of a resource such as Practitioner that might be referred to by many patients. If some resources fail to import, for example due to parsing errors, successfully imported resources are not rolled back. The location and format of the input data are specified by the parameters in ImportResourcesRequest. Note that if no format is specified, this method assumes the `BUNDLE` format. When using the `BUNDLE` format this method ignores the `Bundle.type` field, except that `history` bundles are rejected, and does not apply any of the bundle processing semantics for batch or transaction bundles. Unlike in ExecuteBundle, transaction bundles are not executed as a single transaction and bundle-internal references are not rewritten. The bundle is treated as a collection of resources to be written as provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As an example, this allows the import of `searchset` bundles produced by a FHIR search or Patient-everything operation. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ImportResourcesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

  • name: The name of the FHIR store to import FHIR resources to, in the format of `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /fhirStores/{fhir_store_id}`.

func (*ProjectsLocationsDatasetsFhirStoresService) List

List: Lists the FHIR stores in the given dataset.

- parent: Name of the dataset.

func (*ProjectsLocationsDatasetsFhirStoresService) Patch

Patch: Updates the configuration of the specified FHIR store.

  • name: Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_ id}`.

func (*ProjectsLocationsDatasetsFhirStoresService) SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

  • resource: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

func (*ProjectsLocationsDatasetsFhirStoresService) TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

  • resource: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

type ProjectsLocationsDatasetsFhirStoresSetIamPolicyCall

type ProjectsLocationsDatasetsFhirStoresSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresSetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresSetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsFhirStoresTestIamPermissionsCall

type ProjectsLocationsDatasetsFhirStoresTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsFhirStoresTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsFhirStoresTestIamPermissionsCall) Do

Do executes the "healthcare.projects.locations.datasets.fhirStores.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsFhirStoresTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsFhirStoresTestIamPermissionsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsGetCall

type ProjectsLocationsDatasetsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsGetCall) Do

Do executes the "healthcare.projects.locations.datasets.get" call. Exactly one of *Dataset or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Dataset.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsGetIamPolicyCall

type ProjectsLocationsDatasetsGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsGetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsGetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsGetIamPolicyCall) OptionsRequestedPolicyVersion added in v0.8.0

func (c *ProjectsLocationsDatasetsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsDatasetsGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsLocationsDatasetsHl7V2StoresCreateCall

type ProjectsLocationsDatasetsHl7V2StoresCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresCreateCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.create" call. Exactly one of *Hl7V2Store or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Hl7V2Store.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresCreateCall) Hl7V2StoreId

Hl7V2StoreId sets the optional parameter "hl7V2StoreId": The ID of the HL7v2 store that is being created. The string must match the following regex: `[\p{L}\p{N}_\-\.]{1,256}`.

type ProjectsLocationsDatasetsHl7V2StoresDeleteCall

type ProjectsLocationsDatasetsHl7V2StoresDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsHl7V2StoresExportCall added in v0.34.0

type ProjectsLocationsDatasetsHl7V2StoresExportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresExportCall) Context added in v0.34.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresExportCall) Do added in v0.34.0

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.export" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresExportCall) Fields added in v0.34.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresExportCall) Header added in v0.34.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsHl7V2StoresGetCall

type ProjectsLocationsDatasetsHl7V2StoresGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresGetCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.get" call. Exactly one of *Hl7V2Store or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Hl7V2Store.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall

type ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall) OptionsRequestedPolicyVersion added in v0.8.0

func (c *ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsLocationsDatasetsHl7V2StoresGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

type ProjectsLocationsDatasetsHl7V2StoresImportCall added in v0.30.0

type ProjectsLocationsDatasetsHl7V2StoresImportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresImportCall) Context added in v0.30.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresImportCall) Do added in v0.30.0

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.import" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresImportCall) Fields added in v0.30.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresImportCall) Header added in v0.30.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsHl7V2StoresListCall

type ProjectsLocationsDatasetsHl7V2StoresListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.list" call. Exactly one of *ListHl7V2StoresResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListHl7V2StoresResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) Filter

Filter sets the optional parameter "filter": Restricts stores returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Only filtering on labels is supported. For example, `labels.key=value`.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) PageSize

PageSize sets the optional parameter "pageSize": Limit on the number of HL7v2 stores to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from the previous List request, if any.

func (*ProjectsLocationsDatasetsHl7V2StoresListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsHl7V2StoresMessagesBatchGetCall added in v0.40.0

type ProjectsLocationsDatasetsHl7V2StoresMessagesBatchGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesBatchGetCall) Context added in v0.40.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesBatchGetCall) Do added in v0.40.0

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.messages.batchGet" call. Exactly one of *BatchGetMessagesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BatchGetMessagesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesBatchGetCall) Fields added in v0.40.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesBatchGetCall) Header added in v0.40.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesBatchGetCall) Ids added in v0.40.0

Ids sets the optional parameter "ids": The resource id of the HL7v2 messages to retrieve in the format: `{message_id}`, where the full resource name is `{parent}/messages/{message_id}` A maximum of 100 messages can be retrieved in a batch. All 'ids' have to be under parent.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesBatchGetCall) IfNoneMatch added in v0.40.0

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesBatchGetCall) View added in v0.40.0

View sets the optional parameter "view": Specifies the parts of the Messages resource to return in the response. When unspecified, equivalent to BASIC.

Possible values:

"MESSAGE_VIEW_UNSPECIFIED" - Not specified, equivalent to FULL for

getMessage, equivalent to BASIC for listMessages.

"RAW_ONLY" - Server responses include all the message fields except

parsed_data, and schematized_data fields.

"PARSED_ONLY" - Server responses include all the message fields

except data and schematized_data fields.

"FULL" - Server responses include all the message fields.
"SCHEMATIZED_ONLY" - Server responses include all the message

fields except data and parsed_data fields.

"BASIC" - Server responses include only the name field.

type ProjectsLocationsDatasetsHl7V2StoresMessagesCreateCall

type ProjectsLocationsDatasetsHl7V2StoresMessagesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesCreateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesCreateCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.messages.create" call. Exactly one of *Message or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Message.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesCreateCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsHl7V2StoresMessagesDeleteCall

type ProjectsLocationsDatasetsHl7V2StoresMessagesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesDeleteCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.messages.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesDeleteCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall

type ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.messages.get" call. Exactly one of *Message or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Message.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesGetCall) View

View sets the optional parameter "view": Specifies which parts of the Message resource to return in the response. When unspecified, equivalent to FULL.

Possible values:

"MESSAGE_VIEW_UNSPECIFIED" - Not specified, equivalent to FULL for

getMessage, equivalent to BASIC for listMessages.

"RAW_ONLY" - Server responses include all the message fields except

parsed_data, and schematized_data fields.

"PARSED_ONLY" - Server responses include all the message fields

except data and schematized_data fields.

"FULL" - Server responses include all the message fields.
"SCHEMATIZED_ONLY" - Server responses include all the message

fields except data and parsed_data fields.

"BASIC" - Server responses include only the name field.

type ProjectsLocationsDatasetsHl7V2StoresMessagesIngestCall

type ProjectsLocationsDatasetsHl7V2StoresMessagesIngestCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesIngestCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesIngestCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.messages.ingest" call. Exactly one of *IngestMessageResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *IngestMessageResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesIngestCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesIngestCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsHl7V2StoresMessagesListCall

type ProjectsLocationsDatasetsHl7V2StoresMessagesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.messages.list" call. Exactly one of *ListMessagesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListMessagesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) Filter

Filter sets the optional parameter "filter": Restricts messages returned to those matching a filter. The following syntax is available: * A string field value can be written as text inside quotation marks, for example "query text". The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, "Comment = great" returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. Fields/functions available for filtering are: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = "ADT". * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < "2017-01-02". * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:00:00-05:00". * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00". * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = "ABC". * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId("123456", "MRN")`. * `labels.x`, a string value of the label with key `x` as set using the Message.labels map. For example, `labels."priority"="high". The operator `:*` can be used to assert the existence of a label. For example, `labels."priority":*`.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) OrderBy

OrderBy sets the optional parameter "orderBy": Orders messages returned by the specified order_by clause. Syntax: https://cloud.google.com/apis/design/design_patterns#sorting_order Fields available for ordering are: * `send_time`

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) PageSize

PageSize sets the optional parameter "pageSize": Limit on the number of messages to return in a single response. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from the previous List request, if any.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesListCall) View added in v0.18.0

View sets the optional parameter "view": Specifies the parts of the Message to return in the response. When unspecified, equivalent to BASIC. Setting this to anything other than BASIC with a `page_size` larger than the default can generate a large response, which impacts the performance of this method.

Possible values:

"MESSAGE_VIEW_UNSPECIFIED" - Not specified, equivalent to FULL for

getMessage, equivalent to BASIC for listMessages.

"RAW_ONLY" - Server responses include all the message fields except

parsed_data, and schematized_data fields.

"PARSED_ONLY" - Server responses include all the message fields

except data and schematized_data fields.

"FULL" - Server responses include all the message fields.
"SCHEMATIZED_ONLY" - Server responses include all the message

fields except data and parsed_data fields.

"BASIC" - Server responses include only the name field.

type ProjectsLocationsDatasetsHl7V2StoresMessagesPatchCall

type ProjectsLocationsDatasetsHl7V2StoresMessagesPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesPatchCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.messages.patch" call. Exactly one of *Message or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Message.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

type ProjectsLocationsDatasetsHl7V2StoresMessagesService

type ProjectsLocationsDatasetsHl7V2StoresMessagesService struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesService) BatchGet added in v0.40.0

BatchGet: Gets multiple messages in the given HL7v2 store.

  • parent: Name of the HL7v2 store to retrieve messages from, in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /hl7v2Stores/{hl7v2_store_id}`.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesService) Create

Create: Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received.

- parent: The name of the dataset this message belongs to.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesService) Delete

Delete: Deletes an HL7v2 message.

- name: The resource name of the HL7v2 message to delete.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesService) Get

Get: Gets an HL7v2 message.

- name: The resource name of the HL7v2 message to retrieve.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesService) Ingest

Ingest: Parses and stores an HL7v2 message. This method triggers an asynchronous notification to any Pub/Sub topic configured in Hl7V2Store.Hl7V2NotificationConfig, if the filtering matches the message. If an MLLP adapter is configured to listen to a Pub/Sub topic, the adapter transmits the message when a notification is received. If the method is successful, it generates a response containing an HL7v2 acknowledgment (`ACK`) message. If the method encounters an error, it returns a negative acknowledgment (`NACK`) message. This behavior is suitable for replying to HL7v2 interface systems that expect these acknowledgments.

- parent: The name of the HL7v2 store this message belongs to.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesService) List

List: Lists all the messages in the given HL7v2 store with support for filtering. Note: HL7v2 messages are indexed asynchronously, so there might be a slight delay between the time a message is created and when it can be found through a filter.

- parent: Name of the HL7v2 store to retrieve messages from.

func (*ProjectsLocationsDatasetsHl7V2StoresMessagesService) Patch

Patch: Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time can't be altered. Only the Message.labels field is allowed to be updated. The labels in the request are merged with the existing set of labels. Existing labels with the same keys are updated.

  • name: Resource name of the Message, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_sto re_id}/messages/{message_id}`. Assigned by the server.

type ProjectsLocationsDatasetsHl7V2StoresPatchCall

type ProjectsLocationsDatasetsHl7V2StoresPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresPatchCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.patch" call. Exactly one of *Hl7V2Store or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Hl7V2Store.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsHl7V2StoresPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

type ProjectsLocationsDatasetsHl7V2StoresService

type ProjectsLocationsDatasetsHl7V2StoresService struct {
	Messages *ProjectsLocationsDatasetsHl7V2StoresMessagesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsHl7V2StoresService

func NewProjectsLocationsDatasetsHl7V2StoresService(s *Service) *ProjectsLocationsDatasetsHl7V2StoresService

func (*ProjectsLocationsDatasetsHl7V2StoresService) Create

Create: Creates a new HL7v2 store within the parent dataset.

- parent: The name of the dataset this HL7v2 store belongs to.

func (*ProjectsLocationsDatasetsHl7V2StoresService) Delete

Delete: Deletes the specified HL7v2 store and removes all messages that it contains.

- name: The resource name of the HL7v2 store to delete.

func (*ProjectsLocationsDatasetsHl7V2StoresService) Export added in v0.34.0

Export: Exports the messages to a destination. To filter messages to be exported, define a filter using the start and end time, relative to the message generation time (MSH.7). This API returns an Operation that can be used to track the status of the job by calling GetOperation. Immediate fatal errors appear in the error field. Otherwise, when the operation finishes, a detailed response of type ExportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

  • name: The name of the source HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /hl7v2Stores/{hl7v2_store_id}`.

func (*ProjectsLocationsDatasetsHl7V2StoresService) Get

Get: Gets the specified HL7v2 store.

- name: The resource name of the HL7v2 store to get.

func (*ProjectsLocationsDatasetsHl7V2StoresService) GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • resource: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

func (*ProjectsLocationsDatasetsHl7V2StoresService) Import added in v0.30.0

Import: Import messages to the HL7v2 store by loading data from the specified sources. This method is optimized to load large quantities of data using import semantics that ignore some HL7v2 store configuration options and are not suitable for all use cases. It is primarily intended to load data into an empty HL7v2 store that is not being used by other clients. An existing message will be overwritten if a duplicate message is imported. A duplicate message is a message with the same raw bytes as a message that already exists in this HL7v2 store. When a message is overwritten, its labels will also be overwritten. The import operation is idempotent unless the input data contains multiple valid messages with the same raw bytes but different labels. In that case, after the import completes, the store contains exactly one message with those raw bytes but there is no ordering guarantee on which version of the labels it has. The operation result counters do not count duplicated raw bytes as an error and count one success for each message in the input, which might result in a success count larger than the number of messages in the HL7v2 store. If some messages fail to import, for example due to parsing errors, successfully imported messages are not rolled back. This method returns an Operation that can be used to track the status of the import by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a response of type ImportMessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

  • name: The name of the target HL7v2 store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /hl7v2Stores/{hl7v2_store_id}`.

func (*ProjectsLocationsDatasetsHl7V2StoresService) List

List: Lists the HL7v2 stores in the given dataset.

- parent: Name of the dataset.

func (*ProjectsLocationsDatasetsHl7V2StoresService) Patch

Patch: Updates the HL7v2 store.

  • name: Resource name of the HL7v2 store, of the form `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_stor e_id}`.

func (*ProjectsLocationsDatasetsHl7V2StoresService) SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

  • resource: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

func (*ProjectsLocationsDatasetsHl7V2StoresService) TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

  • resource: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

type ProjectsLocationsDatasetsHl7V2StoresSetIamPolicyCall

type ProjectsLocationsDatasetsHl7V2StoresSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresSetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresSetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsHl7V2StoresTestIamPermissionsCall

type ProjectsLocationsDatasetsHl7V2StoresTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsHl7V2StoresTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsHl7V2StoresTestIamPermissionsCall) Do

Do executes the "healthcare.projects.locations.datasets.hl7V2Stores.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsHl7V2StoresTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsHl7V2StoresTestIamPermissionsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsListCall

type ProjectsLocationsDatasetsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsListCall) Do

Do executes the "healthcare.projects.locations.datasets.list" call. Exactly one of *ListDatasetsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListDatasetsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of items to return. If not specified, 100 is used. May not be larger than 1000.

func (*ProjectsLocationsDatasetsListCall) PageToken

PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.

func (*ProjectsLocationsDatasetsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsOperationsCancelCall added in v0.22.0

type ProjectsLocationsDatasetsOperationsCancelCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsOperationsCancelCall) Context added in v0.22.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsOperationsCancelCall) Do added in v0.22.0

Do executes the "healthcare.projects.locations.datasets.operations.cancel" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsOperationsCancelCall) Fields added in v0.22.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsOperationsCancelCall) Header added in v0.22.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsOperationsGetCall

type ProjectsLocationsDatasetsOperationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsOperationsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsOperationsGetCall) Do

Do executes the "healthcare.projects.locations.datasets.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsOperationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsOperationsGetCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsOperationsGetCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsDatasetsOperationsListCall

type ProjectsLocationsDatasetsOperationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsOperationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsOperationsListCall) Do

Do executes the "healthcare.projects.locations.datasets.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsOperationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsOperationsListCall) Filter

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsLocationsDatasetsOperationsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsOperationsListCall) IfNoneMatch

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsDatasetsOperationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsLocationsDatasetsOperationsListCall) PageToken

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsLocationsDatasetsOperationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDatasetsOperationsService

type ProjectsLocationsDatasetsOperationsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsOperationsService

func NewProjectsLocationsDatasetsOperationsService(s *Service) *ProjectsLocationsDatasetsOperationsService

func (*ProjectsLocationsDatasetsOperationsService) Cancel added in v0.22.0

Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

- name: The name of the operation resource to be cancelled.

func (*ProjectsLocationsDatasetsOperationsService) Get

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

- name: The name of the operation resource.

func (*ProjectsLocationsDatasetsOperationsService) List

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

- name: The name of the operation's parent resource.

type ProjectsLocationsDatasetsPatchCall

type ProjectsLocationsDatasetsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsPatchCall) Do

Do executes the "healthcare.projects.locations.datasets.patch" call. Exactly one of *Dataset or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Dataset.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsPatchCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsDatasetsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

type ProjectsLocationsDatasetsService

type ProjectsLocationsDatasetsService struct {
	AnnotationStores *ProjectsLocationsDatasetsAnnotationStoresService

	ConsentStores *ProjectsLocationsDatasetsConsentStoresService

	DicomStores *ProjectsLocationsDatasetsDicomStoresService

	FhirStores *ProjectsLocationsDatasetsFhirStoresService

	Hl7V2Stores *ProjectsLocationsDatasetsHl7V2StoresService

	Operations *ProjectsLocationsDatasetsOperationsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsDatasetsService

func NewProjectsLocationsDatasetsService(s *Service) *ProjectsLocationsDatasetsService

func (*ProjectsLocationsDatasetsService) Create

Create: Creates a new health dataset. Results are returned through the Operation interface which returns either an `Operation.response` which contains a Dataset or `Operation.error`. The metadata field type is OperationMetadata.

  • parent: The name of the project where the server creates the dataset. For example, `projects/{project_id}/locations/{location_id}`.

func (*ProjectsLocationsDatasetsService) Deidentify

func (r *ProjectsLocationsDatasetsService) Deidentify(sourceDataset string, deidentifydatasetrequest *DeidentifyDatasetRequest) *ProjectsLocationsDatasetsDeidentifyCall

Deidentify: Creates a new dataset containing de-identified data from the source dataset. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifySummary. The LRO result may still be successful if de-identification fails for some resources. The new de-identified dataset will not contain these failed resources. The number of resources processed are tracked in Operation.metadata. Error details are logged to Cloud Logging. For more information, see Viewing error logs in Cloud Logging (https://cloud.google.com/healthcare/docs/how-tos/logging).

  • sourceDataset: Source dataset resource name. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} `.

func (*ProjectsLocationsDatasetsService) Delete

Delete: Deletes the specified health dataset and all data contained in the dataset. Deleting a dataset does not affect the sources from which the dataset was imported (if any).

  • name: The name of the dataset to delete. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} `.

func (*ProjectsLocationsDatasetsService) Get

Get: Gets any metadata associated with a dataset.

  • name: The name of the dataset to read. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} `.

func (*ProjectsLocationsDatasetsService) GetIamPolicy

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • resource: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

func (*ProjectsLocationsDatasetsService) List

List: Lists the health datasets in the current project.

  • parent: The name of the project whose datasets should be listed. For example, `projects/{project_id}/locations/{location_id}`.

func (*ProjectsLocationsDatasetsService) Patch

Patch: Updates dataset metadata.

  • name: Resource name of the dataset, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id} `.

func (*ProjectsLocationsDatasetsService) SetIamPolicy

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

  • resource: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

func (*ProjectsLocationsDatasetsService) TestIamPermissions

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

  • resource: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

type ProjectsLocationsDatasetsSetIamPolicyCall

type ProjectsLocationsDatasetsSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsSetIamPolicyCall) Do

Do executes the "healthcare.projects.locations.datasets.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsSetIamPolicyCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsDatasetsTestIamPermissionsCall

type ProjectsLocationsDatasetsTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDatasetsTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsDatasetsTestIamPermissionsCall) Do

Do executes the "healthcare.projects.locations.datasets.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDatasetsTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsDatasetsTestIamPermissionsCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsGetCall

type ProjectsLocationsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsGetCall) Do

Do executes the "healthcare.projects.locations.get" call. Exactly one of *Location or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Location.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsGetCall) Header

func (c *ProjectsLocationsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsGetCall) IfNoneMatch

func (c *ProjectsLocationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsLocationsListCall

type ProjectsLocationsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsListCall) Do

Do executes the "healthcare.projects.locations.list" call. Exactly one of *ListLocationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListLocationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsListCall) Filter

Filter sets the optional parameter "filter": A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).

func (*ProjectsLocationsListCall) Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsLocationsListCall) IfNoneMatch

func (c *ProjectsLocationsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsLocationsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of results to return. If not set, the service selects a default.

func (*ProjectsLocationsListCall) PageToken

PageToken sets the optional parameter "pageToken": A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

func (*ProjectsLocationsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	Datasets *ProjectsLocationsDatasetsService

	Services *ProjectsLocationsServicesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

func (*ProjectsLocationsService) Get

Get: Gets information about a location.

- name: Resource name for the location.

func (*ProjectsLocationsService) List

List: Lists information about the supported locations for this service.

  • name: The resource that owns the locations collection, if applicable.

type ProjectsLocationsServicesNlpAnalyzeEntitiesCall added in v0.35.0

type ProjectsLocationsServicesNlpAnalyzeEntitiesCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsServicesNlpAnalyzeEntitiesCall) Context added in v0.35.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsLocationsServicesNlpAnalyzeEntitiesCall) Do added in v0.35.0

Do executes the "healthcare.projects.locations.services.nlp.analyzeEntities" call. Exactly one of *AnalyzeEntitiesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *AnalyzeEntitiesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsServicesNlpAnalyzeEntitiesCall) Fields added in v0.35.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsLocationsServicesNlpAnalyzeEntitiesCall) Header added in v0.35.0

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsLocationsServicesNlpService added in v0.35.0

type ProjectsLocationsServicesNlpService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsServicesNlpService added in v0.35.0

func NewProjectsLocationsServicesNlpService(s *Service) *ProjectsLocationsServicesNlpService

func (*ProjectsLocationsServicesNlpService) AnalyzeEntities added in v0.35.0

AnalyzeEntities: Analyze heathcare entity in a document. Its response includes the recognized entity mentions and the relationships between them. AnalyzeEntities uses context aware models to detect entities.

  • nlpService: The resource name of the service of the form: "projects/{project_id}/locations/{location_id}/services/nlp".

type ProjectsLocationsServicesService added in v0.35.0

type ProjectsLocationsServicesService struct {
	Nlp *ProjectsLocationsServicesNlpService
	// contains filtered or unexported fields
}

func NewProjectsLocationsServicesService added in v0.35.0

func NewProjectsLocationsServicesService(s *Service) *ProjectsLocationsServicesService

type ProjectsService

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type QueryAccessibleDataRequest added in v0.33.0

type QueryAccessibleDataRequest struct {
	// GcsDestination: The Cloud Storage destination. The Cloud Healthcare
	// API service account must have the `roles/storage.objectAdmin` Cloud
	// IAM role for this Cloud Storage location. The object name is in the
	// following format: query-accessible-data-result-{operation_id}.txt
	// where each line contains a single data_id.
	GcsDestination *GoogleCloudHealthcareV1beta1ConsentGcsDestination `json:"gcsDestination,omitempty"`

	// RequestAttributes: The values of request attributes associated with
	// this access request.
	RequestAttributes map[string]string `json:"requestAttributes,omitempty"`

	// ResourceAttributes: Optional. The values of resource attributes
	// associated with the type of resources being requested. If no values
	// are specified, then all resource types are included in the output.
	ResourceAttributes map[string]string `json:"resourceAttributes,omitempty"`

	// ForceSendFields is a list of field names (e.g. "GcsDestination") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "GcsDestination") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

QueryAccessibleDataRequest: Queries all data_ids that are consented for a given use in the given consent store and writes them to a specified destination. The returned Operation includes a progress counter for the number of User data mappings processed. Errors are logged to Cloud Logging (see [Viewing error logs in Cloud Logging] (https://cloud.google.com/healthcare/docs/how-tos/logging) and [QueryAccessibleData] for a sample log entry).

func (*QueryAccessibleDataRequest) MarshalJSON added in v0.33.0

func (s *QueryAccessibleDataRequest) MarshalJSON() ([]byte, error)

type QueryAccessibleDataResponse added in v0.48.0

type QueryAccessibleDataResponse struct {
	// GcsUris: List of files, each of which contains a list of data_id(s)
	// that are consented for a specified use in the request.
	GcsUris []string `json:"gcsUris,omitempty"`

	// ForceSendFields is a list of field names (e.g. "GcsUris") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "GcsUris") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

QueryAccessibleDataResponse: Response for successful QueryAccessibleData operations. This structure is included in the response upon operation completion.

func (*QueryAccessibleDataResponse) MarshalJSON added in v0.49.0

func (s *QueryAccessibleDataResponse) MarshalJSON() ([]byte, error)

type RedactConfig

type RedactConfig struct {
}

RedactConfig: Define how to redact sensitive values. Default behaviour is erase. For example, "My name is Jane." becomes "My name is ."

type RejectConsentRequest added in v0.33.0

type RejectConsentRequest struct {
	// ConsentArtifact: Optional. The resource name of the Consent artifact
	// that contains documentation of the user's rejection of the draft
	// Consent, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/c
	// onsentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}
	// `. If the draft Consent had a Consent artifact, this Consent artifact
	// overwrites it.
	ConsentArtifact string `json:"consentArtifact,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ConsentArtifact") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConsentArtifact") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

RejectConsentRequest: Rejects the latest revision of the specified Consent by committing a new revision with `state` updated to `REJECTED`. If the latest revision of the given Consent is in the `REJECTED` state, no new revision is committed.

func (*RejectConsentRequest) MarshalJSON added in v0.33.0

func (s *RejectConsentRequest) MarshalJSON() ([]byte, error)

type ReplaceWithInfoTypeConfig

type ReplaceWithInfoTypeConfig struct {
}

ReplaceWithInfoTypeConfig: When using the INSPECT_AND_TRANSFORM action, each match is replaced with the name of the info_type. For example, "My name is Jane" becomes "My name is [PERSON_NAME]." The TRANSFORM action is equivalent to redacting.

type ResourceAnnotation added in v0.28.0

type ResourceAnnotation struct {
	// Label: A description of the annotation record.
	Label string `json:"label,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Label") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Label") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ResourceAnnotation: Resource level annotation.

func (*ResourceAnnotation) MarshalJSON added in v0.28.0

func (s *ResourceAnnotation) MarshalJSON() ([]byte, error)

type Resources added in v0.12.0

type Resources struct {
	// Resources: List of resources IDs. For example, "Patient/1234".
	Resources []string `json:"resources,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Resources") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Resources") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Resources: A list of FHIR resources.

func (*Resources) MarshalJSON added in v0.12.0

func (s *Resources) MarshalJSON() ([]byte, error)

type Result added in v0.33.0

type Result struct {
	// ConsentDetails: The resource names of all evaluated Consents mapped
	// to their evaluation.
	ConsentDetails map[string]ConsentEvaluation `json:"consentDetails,omitempty"`

	// Consented: Whether the resource is consented for the given use.
	Consented bool `json:"consented,omitempty"`

	// DataId: The unique identifier of the evaluated resource.
	DataId string `json:"dataId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ConsentDetails") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConsentDetails") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Result: The consent evaluation result for a single `data_id`.

func (*Result) MarshalJSON added in v0.33.0

func (s *Result) MarshalJSON() ([]byte, error)

type RevokeConsentRequest added in v0.33.0

type RevokeConsentRequest struct {
	// ConsentArtifact: Optional. The resource name of the Consent artifact
	// that contains proof of the user's revocation of the Consent, of the
	// form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/c
	// onsentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}
	// `.
	ConsentArtifact string `json:"consentArtifact,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ConsentArtifact") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConsentArtifact") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

RevokeConsentRequest: Revokes the latest revision of the specified Consent by committing a new revision with `state` updated to `REVOKED`. If the latest revision of the given Consent is in the `REVOKED` state, no new revision is committed.

func (*RevokeConsentRequest) MarshalJSON added in v0.33.0

func (s *RevokeConsentRequest) MarshalJSON() ([]byte, error)

type SchemaConfig

type SchemaConfig struct {
	// RecursiveStructureDepth: The depth for all recursive structures in
	// the output analytics schema. For example, `concept` in the CodeSystem
	// resource is a recursive structure; when the depth is 2, the
	// CodeSystem table will have a column called `concept.concept` but not
	// `concept.concept.concept`. If not specified or set to 0, the server
	// will use the default value 2. The maximum depth allowed is 5.
	RecursiveStructureDepth int64 `json:"recursiveStructureDepth,omitempty,string"`

	// SchemaType: Specifies the output schema type. Schema type is
	// required.
	//
	// Possible values:
	//   "SCHEMA_TYPE_UNSPECIFIED" - No schema type specified. This type is
	// unsupported.
	//   "LOSSLESS" - A data-driven schema generated from the fields present
	// in the FHIR data being exported, with no additional simplification.
	//   "ANALYTICS" - Analytics schema defined by the FHIR community. See
	// https://github.com/FHIR/sql-on-fhir/blob/master/sql-on-fhir.md.
	// BigQuery only allows a maximum of 10,000 columns per table. Due to
	// this limitation, the server will not generate schemas for fields of
	// type `Resource`, which can hold any resource type. The affected
	// fields are `Parameters.parameter.resource`, `Bundle.entry.resource`,
	// and `Bundle.entry.response.outcome`.
	SchemaType string `json:"schemaType,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "RecursiveStructureDepth") to unconditionally include in API
	// requests. By default, fields with empty values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "RecursiveStructureDepth")
	// to include in API requests with the JSON null value. By default,
	// fields with empty values are omitted from API requests. However, any
	// field with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

SchemaConfig: Configuration for the FHIR BigQuery schema. Determines how the server generates the schema.

func (*SchemaConfig) MarshalJSON

func (s *SchemaConfig) MarshalJSON() ([]byte, error)

type SchemaGroup added in v0.22.0

type SchemaGroup struct {
	// Choice: True indicates that this is a choice group, meaning that only
	// one of its segments can exist in a given message.
	Choice bool `json:"choice,omitempty"`

	// MaxOccurs: The maximum number of times this group can be repeated. 0
	// or -1 means unbounded.
	MaxOccurs int64 `json:"maxOccurs,omitempty"`

	// Members: Nested groups and/or segments.
	Members []*GroupOrSegment `json:"members,omitempty"`

	// MinOccurs: The minimum number of times this group must be
	// present/repeated.
	MinOccurs int64 `json:"minOccurs,omitempty"`

	// Name: The name of this group. For example, "ORDER_DETAIL".
	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Choice") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Choice") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SchemaGroup: An HL7v2 logical group construct.

func (*SchemaGroup) MarshalJSON added in v0.22.0

func (s *SchemaGroup) MarshalJSON() ([]byte, error)

type SchemaPackage added in v0.22.0

type SchemaPackage struct {
	// IgnoreMinOccurs: Flag to ignore all min_occurs restrictions in the
	// schema. This means that incoming messages can omit any group,
	// segment, field, component, or subcomponent.
	IgnoreMinOccurs bool `json:"ignoreMinOccurs,omitempty"`

	// Schemas: Schema configs that are layered based on their
	// VersionSources that match the incoming message. Schema configs
	// present in higher indices override those in lower indices with the
	// same message type and trigger event if their VersionSources all match
	// an incoming message.
	Schemas []*Hl7SchemaConfig `json:"schemas,omitempty"`

	// SchematizedParsingType: Determines how messages that fail to parse
	// are handled.
	//
	// Possible values:
	//   "SCHEMATIZED_PARSING_TYPE_UNSPECIFIED" - Unspecified schematized
	// parsing type, equivalent to `SOFT_FAIL`.
	//   "SOFT_FAIL" - Messages that fail to parse are still stored and
	// ACKed but a parser error is stored in place of the schematized data.
	//   "HARD_FAIL" - Messages that fail to parse are rejected from
	// ingestion/insertion and return an error code.
	SchematizedParsingType string `json:"schematizedParsingType,omitempty"`

	// Types: Schema type definitions that are layered based on their
	// VersionSources that match the incoming message. Type definitions
	// present in higher indices override those in lower indices with the
	// same type name if their VersionSources all match an incoming message.
	Types []*Hl7TypesConfig `json:"types,omitempty"`

	// UnexpectedSegmentHandling: Determines how unexpected segments
	// (segments not matched to the schema) are handled.
	//
	// Possible values:
	//   "UNEXPECTED_SEGMENT_HANDLING_MODE_UNSPECIFIED" - Unspecified
	// handling mode, equivalent to FAIL.
	//   "FAIL" - Unexpected segments fail to parse and return an error.
	//   "SKIP" - Unexpected segments do not fail, but are omitted from the
	// output.
	//   "PARSE" - Unexpected segments do not fail, but are parsed in place
	// and added to the current group. If a segment has a type definition,
	// it is used, otherwise it is parsed as VARIES.
	UnexpectedSegmentHandling string `json:"unexpectedSegmentHandling,omitempty"`

	// ForceSendFields is a list of field names (e.g. "IgnoreMinOccurs") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "IgnoreMinOccurs") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

SchemaPackage: A schema package contains a set of schemas and type definitions.

func (*SchemaPackage) MarshalJSON added in v0.22.0

func (s *SchemaPackage) MarshalJSON() ([]byte, error)

type SchemaSegment added in v0.22.0

type SchemaSegment struct {
	// MaxOccurs: The maximum number of times this segment can be present in
	// this group. 0 or -1 means unbounded.
	MaxOccurs int64 `json:"maxOccurs,omitempty"`

	// MinOccurs: The minimum number of times this segment can be present in
	// this group.
	MinOccurs int64 `json:"minOccurs,omitempty"`

	// Type: The Segment type. For example, "PID".
	Type string `json:"type,omitempty"`

	// ForceSendFields is a list of field names (e.g. "MaxOccurs") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MaxOccurs") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SchemaSegment: An HL7v2 Segment.

func (*SchemaSegment) MarshalJSON added in v0.22.0

func (s *SchemaSegment) MarshalJSON() ([]byte, error)

type SchematizedData added in v0.22.0

type SchematizedData struct {
	// Data: JSON output of the parser.
	Data string `json:"data,omitempty"`

	// Error: The error output of the parser.
	Error string `json:"error,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Data") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Data") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SchematizedData: The content of an HL7v2 message in a structured format as specified by a schema.

func (*SchematizedData) MarshalJSON added in v0.22.0

func (s *SchematizedData) MarshalJSON() ([]byte, error)

type SearchConfig added in v0.50.0

type SearchConfig struct {
	// SearchParameters: A list of search parameters in this FHIR store that
	// are used to configure this FHIR store.
	SearchParameters []*SearchParameter `json:"searchParameters,omitempty"`

	// ForceSendFields is a list of field names (e.g. "SearchParameters") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "SearchParameters") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

SearchConfig: Contains the configuration for FHIR search.

func (*SearchConfig) MarshalJSON added in v0.50.0

func (s *SearchConfig) MarshalJSON() ([]byte, error)

type SearchParameter added in v0.50.0

type SearchParameter struct {
	// CanonicalUrl: The canonical url of the search parameter resource.
	CanonicalUrl string `json:"canonicalUrl,omitempty"`

	// Parameter: The versioned name of the search parameter resource. The
	// format is
	// projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirS
	// tores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/_history/{vers
	// ion-id} For fhir stores with disable_resource_versioning=true, the
	// format is
	// projects/{project-id}/locations/{location}/datasets/{dataset-id}/fhirS
	// tores/{fhirStore-id}/fhir/SearchParameter/{resource-id}/
	Parameter string `json:"parameter,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CanonicalUrl") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CanonicalUrl") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SearchParameter: Contains the versioned name and the URL for one SearchParameter.

func (*SearchParameter) MarshalJSON added in v0.50.0

func (s *SearchParameter) MarshalJSON() ([]byte, error)

type SearchResourcesRequest

type SearchResourcesRequest struct {
	// ResourceType: The FHIR resource type to search, such as Patient or
	// Observation. For a complete list, see the FHIR Resource Index (DSTU2
	// (https://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html),
	// STU3
	// (https://hl7.org/implement/standards/fhir/STU3/resourcelist.html), R4
	// (https://hl7.org/implement/standards/fhir/R4/resourcelist.html)).
	ResourceType string `json:"resourceType,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ResourceType") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ResourceType") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SearchResourcesRequest: Request to search the resources in the specified FHIR store.

func (*SearchResourcesRequest) MarshalJSON

func (s *SearchResourcesRequest) MarshalJSON() ([]byte, error)

type Segment

type Segment struct {
	// Fields: A mapping from the positional location to the value. The key
	// string uses zero-based indexes separated by dots to identify Fields,
	// components and sub-components. A bracket notation is also used to
	// identify different instances of a repeated field. Regex for key:
	// (\d+)(\[\d+\])?(.\d+)?(.\d+)? Examples of (key, value) pairs: * (0.1,
	// "hemoglobin") denotes that the first component of Field 0 has the
	// value "hemoglobin". * (1.1.2, "CBC") denotes that the second
	// sub-component of the first component of Field 1 has the value "CBC".
	// * (1[0].1, "HbA1c") denotes that the first component of the first
	// Instance of Field 1, which is repeated, has the value "HbA1c".
	Fields map[string]string `json:"fields,omitempty"`

	// SegmentId: A string that indicates the type of segment. For example,
	// EVN or PID.
	SegmentId string `json:"segmentId,omitempty"`

	// SetId: Set ID for segments that can be in a set. This can be empty if
	// it's missing or isn't applicable.
	SetId string `json:"setId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Fields") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Fields") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Segment: A segment in a structured format.

func (*Segment) MarshalJSON

func (s *Segment) MarshalJSON() ([]byte, error)

type SensitiveTextAnnotation added in v0.28.0

type SensitiveTextAnnotation struct {
	// Details: Maps from a resource slice. For example, FHIR resource field
	// path to a set of sensitive text findings. For example,
	// Appointment.Narrative text1 --> {findings_1, findings_2, findings_3}
	Details map[string]Detail `json:"details,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Details") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Details") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SensitiveTextAnnotation: A TextAnnotation specifies a text range that includes sensitive information.

func (*SensitiveTextAnnotation) MarshalJSON added in v0.28.0

func (s *SensitiveTextAnnotation) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type SetIamPolicyRequest

type SetIamPolicyRequest struct {
	// Policy: REQUIRED: The complete policy to be applied to the
	// `resource`. The size of the policy is limited to a few 10s of KB. An
	// empty policy is a valid policy but certain Cloud Platform services
	// (such as Projects) might reject them.
	Policy *Policy `json:"policy,omitempty"`

	// UpdateMask: OPTIONAL: A FieldMask specifying which fields of the
	// policy to modify. Only the fields in the mask will be modified. If no
	// mask is provided, the following default mask is used: `paths:
	// "bindings, etag"
	UpdateMask string `json:"updateMask,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Policy") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Policy") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (*SetIamPolicyRequest) MarshalJSON

func (s *SetIamPolicyRequest) MarshalJSON() ([]byte, error)

type Signature added in v0.33.0

type Signature struct {
	// Image: Optional. An image of the user's signature.
	Image *Image `json:"image,omitempty"`

	// Metadata: Optional. Metadata associated with the user's signature.
	// For example, the user's name or the user's title.
	Metadata map[string]string `json:"metadata,omitempty"`

	// SignatureTime: Optional. Timestamp of the signature.
	SignatureTime string `json:"signatureTime,omitempty"`

	// UserId: Required. User's UUID provided by the client.
	UserId string `json:"userId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Image") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Image") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Signature: User signature.

func (*Signature) MarshalJSON added in v0.33.0

func (s *Signature) MarshalJSON() ([]byte, error)

type Status

type Status struct {
	// Code: The status code, which should be an enum value of
	// google.rpc.Code.
	Code int64 `json:"code,omitempty"`

	// Details: A list of messages that carry the error details. There is a
	// common set of message types for APIs to use.
	Details []googleapi.RawMessage `json:"details,omitempty"`

	// Message: A developer-facing error message, which should be in
	// English. Any user-facing error message should be localized and sent
	// in the google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Code") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Code") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).

func (*Status) MarshalJSON

func (s *Status) MarshalJSON() ([]byte, error)

type StreamConfig added in v0.22.0

type StreamConfig struct {
	// BigqueryDestination: The destination BigQuery structure that contains
	// both the dataset location and corresponding schema config. The output
	// is organized in one table per resource type. The server reuses the
	// existing tables (if any) that are named after the resource types,
	// e.g. "Patient", "Observation". When there is no existing table for a
	// given resource type, the server attempts to create one. When a table
	// schema doesn't align with the schema config, either because of
	// existing incompatible schema or out of band incompatible
	// modification, the server does not stream in new data. One resolution
	// in this case is to delete the incompatible table and let the server
	// recreate one, though the newly created table only contains data after
	// the table recreation. BigQuery imposes a 1 MB limit on streaming
	// insert row size, therefore any resource mutation that generates more
	// than 1 MB of BigQuery data will not be streamed. Results are appended
	// to the corresponding BigQuery tables. Different versions of the same
	// resource are distinguishable by the meta.versionId and
	// meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that
	// results in the new version is recorded in the meta.tag. The tables
	// contain all historical resource versions since streaming was enabled.
	// For query convenience, the server also creates one view per table of
	// the same name containing only the current resource version. The
	// streamed data in the BigQuery dataset is not guaranteed to be
	// completely unique. The combination of the id and meta.versionId
	// columns should ideally identify a single unique row. But in rare
	// cases, duplicates may exist. At query time, users may use the SQL
	// select statement to keep only one of the duplicate rows given an id
	// and meta.versionId pair. Alternatively, the server created view
	// mentioned above also filters out duplicates. If a resource mutation
	// cannot be streamed to BigQuery, errors will be logged to Cloud
	// Logging (see Viewing error logs in Cloud Logging
	// (https://cloud.google.com/healthcare/docs/how-tos/logging)).
	BigqueryDestination *GoogleCloudHealthcareV1beta1FhirBigQueryDestination `json:"bigqueryDestination,omitempty"`

	// ResourceTypes: Supply a FHIR resource type (such as "Patient" or
	// "Observation"). See
	// https://www.hl7.org/fhir/valueset-resource-types.html for a list of
	// all FHIR resource types. The server treats an empty list as an intent
	// to stream all the supported resource types in this FHIR store.
	ResourceTypes []string `json:"resourceTypes,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BigqueryDestination")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BigqueryDestination") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

StreamConfig: Contains configuration for streaming FHIR export.

func (*StreamConfig) MarshalJSON added in v0.22.0

func (s *StreamConfig) MarshalJSON() ([]byte, error)

type TagFilterList

type TagFilterList struct {
	// Tags: Tags to be filtered. Tags must be DICOM Data Elements, File
	// Meta Elements, or Directory Structuring Elements, as defined at:
	// http://dicom.nema.org/medical/dicom/current/output/html/part06.html#table_6-1,.
	// They may be provided by "Keyword" or "Tag". For example, "PatientID",
	// "00100010".
	Tags []string `json:"tags,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Tags") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Tags") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

TagFilterList: List of tags to be filtered.

func (*TagFilterList) MarshalJSON

func (s *TagFilterList) MarshalJSON() ([]byte, error)

type TestIamPermissionsRequest

type TestIamPermissionsRequest struct {
	// Permissions: The set of permissions to check for the `resource`.
	// Permissions with wildcards (such as '*' or 'storage.*') are not
	// allowed. For more information see IAM Overview
	// (https://cloud.google.com/iam/docs/overview#permissions).
	Permissions []string `json:"permissions,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Permissions") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Permissions") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

func (*TestIamPermissionsRequest) MarshalJSON

func (s *TestIamPermissionsRequest) MarshalJSON() ([]byte, error)

type TestIamPermissionsResponse

type TestIamPermissionsResponse struct {
	// Permissions: A subset of `TestPermissionsRequest.permissions` that
	// the caller is allowed.
	Permissions []string `json:"permissions,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Permissions") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Permissions") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

func (*TestIamPermissionsResponse) MarshalJSON

func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error)

type TextConfig

type TextConfig struct {
	// Transformations: The transformations to apply to the detected data.
	Transformations []*InfoTypeTransformation `json:"transformations,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Transformations") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Transformations") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

func (*TextConfig) MarshalJSON

func (s *TextConfig) MarshalJSON() ([]byte, error)

type TextSpan added in v0.35.0

type TextSpan struct {
	// BeginOffset: The unicode codepoint index of the beginning of this
	// span.
	BeginOffset int64 `json:"beginOffset,omitempty"`

	// Content: The original text contained in this span.
	Content string `json:"content,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BeginOffset") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BeginOffset") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

TextSpan: A span of text in the provided document.

func (*TextSpan) MarshalJSON added in v0.35.0

func (s *TextSpan) MarshalJSON() ([]byte, error)

type Type added in v0.22.0

type Type struct {
	// Fields: The (sub) fields this type has (if not primitive).
	Fields []*Field `json:"fields,omitempty"`

	// Name: The name of this type. This would be the segment or datatype
	// name. For example, "PID" or "XPN".
	Name string `json:"name,omitempty"`

	// Primitive: If this is a primitive type then this field is the type of
	// the primitive For example, STRING. Leave unspecified for composite
	// types.
	//
	// Possible values:
	//   "PRIMITIVE_UNSPECIFIED" - Not a primitive.
	//   "STRING" - String primitive.
	//   "VARIES" - Element that can have unschematized children.
	//   "UNESCAPED_STRING" - Like STRING, but all delimiters below this
	// element are ignored.
	Primitive string `json:"primitive,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Fields") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Fields") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Type: A type definition for some HL7v2 type (incl. Segments and Datatypes).

func (*Type) MarshalJSON added in v0.22.0

func (s *Type) MarshalJSON() ([]byte, error)

type UserDataMapping added in v0.33.0

type UserDataMapping struct {
	// ArchiveTime: Output only. Indicates the time when this mapping was
	// archived.
	ArchiveTime string `json:"archiveTime,omitempty"`

	// Archived: Output only. Indicates whether this mapping is archived.
	Archived bool `json:"archived,omitempty"`

	// DataId: Required. A unique identifier for the mapped resource.
	DataId string `json:"dataId,omitempty"`

	// Name: Resource name of the User data mapping, of the form
	// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/c
	// onsentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id
	// }`.
	Name string `json:"name,omitempty"`

	// ResourceAttributes: Attributes of the resource. 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.
	ResourceAttributes []*Attribute `json:"resourceAttributes,omitempty"`

	// UserId: Required. User's UUID provided by the client.
	UserId string `json:"userId,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ArchiveTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ArchiveTime") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

UserDataMapping: Maps a resource to the associated user and Attributes.

func (*UserDataMapping) MarshalJSON added in v0.33.0

func (s *UserDataMapping) MarshalJSON() ([]byte, error)

type ValidationConfig added in v0.40.0

type ValidationConfig struct {
	// DisableProfileValidation: Whether to disable profile validation for
	// this FHIR store. Set this to true to disable checking incoming
	// resources for conformance against StructureDefinitions in this FHIR
	// store.
	DisableProfileValidation bool `json:"disableProfileValidation,omitempty"`

	// EnabledImplementationGuides: A list of ImplementationGuide URLs in
	// this FHIR store that are used to configure the profiles to use for
	// validation. For example, to use the US Core profiles for validation,
	// set `enabled_implementation_guides` to
	// `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If
	// `enabled_implementation_guides` is empty or omitted, then incoming
	// resources are only required to conform to the base FHIR profiles.
	// Otherwise, a resource must conform to at least one profile listed in
	// the `global` property of one of the enabled ImplementationGuides. The
	// Cloud Healthcare API does not currently enforce all of the rules in a
	// StructureDefinition. The following rules are supported: - min/max -
	// minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on
	// simple types - slicing, when using "value" as the discriminator type
	// When a URL cannot be resolved (for example, in a type assertion), the
	// server does not return an error.
	EnabledImplementationGuides []string `json:"enabledImplementationGuides,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "DisableProfileValidation") to unconditionally include in API
	// requests. By default, fields with empty values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DisableProfileValidation")
	// to include in API requests with the JSON null value. By default,
	// fields with empty values are omitted from API requests. However, any
	// field with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ValidationConfig: Contains the configuration for FHIR profiles and validation.

func (*ValidationConfig) MarshalJSON added in v0.40.0

func (s *ValidationConfig) MarshalJSON() ([]byte, error)

type VersionSource added in v0.22.0

type VersionSource struct {
	// MshField: The field to extract from the MSH segment. For example,
	// "3.1" or "18[1].1".
	MshField string `json:"mshField,omitempty"`

	// Value: The value to match with the field. For example, "My
	// Application Name" or "2.3".
	Value string `json:"value,omitempty"`

	// ForceSendFields is a list of field names (e.g. "MshField") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "MshField") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

VersionSource: Describes a selector for extracting and matching an MSH field to a value.

func (*VersionSource) MarshalJSON added in v0.22.0

func (s *VersionSource) MarshalJSON() ([]byte, error)

type Vertex added in v0.28.0

type Vertex struct {
	// X: X coordinate.
	X float64 `json:"x,omitempty"`

	// Y: Y coordinate.
	Y float64 `json:"y,omitempty"`

	// ForceSendFields is a list of field names (e.g. "X") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "X") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Vertex: A 2D coordinate in an image. The origin is the top-left.

func (*Vertex) MarshalJSON added in v0.28.0

func (s *Vertex) MarshalJSON() ([]byte, error)

func (*Vertex) UnmarshalJSON added in v0.28.0

func (s *Vertex) UnmarshalJSON(data []byte) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL