diff --git a/api_names_out.yaml b/api_names_out.yaml index f4b679a0f..ed329d17b 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -23772,6 +23772,10 @@ "/cloudsearch:v1/ListItemsResponse/items": items "/cloudsearch:v1/ListItemsResponse/items/item": item "/cloudsearch:v1/ListItemsResponse/nextPageToken": next_page_token +"/cloudsearch:v1/ListOperationsResponse": list_operations_response +"/cloudsearch:v1/ListOperationsResponse/nextPageToken": next_page_token +"/cloudsearch:v1/ListOperationsResponse/operations": operations +"/cloudsearch:v1/ListOperationsResponse/operations/operation": operation "/cloudsearch:v1/ListQuerySourcesResponse": list_query_sources_response "/cloudsearch:v1/ListQuerySourcesResponse/nextPageToken": next_page_token "/cloudsearch:v1/ListQuerySourcesResponse/sources": sources @@ -24221,6 +24225,11 @@ "/cloudsearch:v1/cloudsearch.media.upload/resourceName": resource_name "/cloudsearch:v1/cloudsearch.operations.get": get_operation "/cloudsearch:v1/cloudsearch.operations.get/name": name +"/cloudsearch:v1/cloudsearch.operations.lro.list": list_operation_lros +"/cloudsearch:v1/cloudsearch.operations.lro.list/filter": filter +"/cloudsearch:v1/cloudsearch.operations.lro.list/name": name +"/cloudsearch:v1/cloudsearch.operations.lro.list/pageSize": page_size +"/cloudsearch:v1/cloudsearch.operations.lro.list/pageToken": page_token "/cloudsearch:v1/cloudsearch.query.search": search_query "/cloudsearch:v1/cloudsearch.query.sources.list": list_query_sources "/cloudsearch:v1/cloudsearch.query.sources.list/pageToken": page_token @@ -79133,6 +79142,7 @@ "/dfareporting:v3.4/Conversion/childDirectedTreatment": child_directed_treatment "/dfareporting:v3.4/Conversion/customVariables": custom_variables "/dfareporting:v3.4/Conversion/customVariables/custom_variable": custom_variable +"/dfareporting:v3.4/Conversion/dclid": dclid "/dfareporting:v3.4/Conversion/encryptedUserId": encrypted_user_id "/dfareporting:v3.4/Conversion/encryptedUserIdCandidates": encrypted_user_id_candidates "/dfareporting:v3.4/Conversion/encryptedUserIdCandidates/encrypted_user_id_candidate": encrypted_user_id_candidate @@ -102673,6 +102683,7 @@ "/healthcare:v1beta1/EvaluateAnnotationStoreRequest/goldenInfoTypeMapping/golden_info_type_mapping": golden_info_type_mapping "/healthcare:v1beta1/EvaluateAnnotationStoreRequest/goldenStore": golden_store "/healthcare:v1beta1/EvaluateAnnotationStoreRequest/infoTypeConfig": info_type_config +"/healthcare:v1beta1/EvaluateAnnotationStoreRequest/name": name "/healthcare:v1beta1/EvaluateAnnotationStoreResponse": evaluate_annotation_store_response "/healthcare:v1beta1/EvaluateAnnotationStoreResponse/evalStore": eval_store "/healthcare:v1beta1/EvaluateAnnotationStoreResponse/goldenCount": golden_count @@ -102685,6 +102696,7 @@ "/healthcare:v1beta1/ExportAnnotationsRequest": export_annotations_request "/healthcare:v1beta1/ExportAnnotationsRequest/bigqueryDestination": bigquery_destination "/healthcare:v1beta1/ExportAnnotationsRequest/gcsDestination": gcs_destination +"/healthcare:v1beta1/ExportAnnotationsRequest/name": name "/healthcare:v1beta1/ExportAnnotationsResponse": export_annotations_response "/healthcare:v1beta1/ExportAnnotationsResponse/annotationStore": annotation_store "/healthcare:v1beta1/ExportAnnotationsResponse/successCount": success_count @@ -102828,6 +102840,7 @@ "/healthcare:v1beta1/ImportAnnotationsErrorDetails/successCount": success_count "/healthcare:v1beta1/ImportAnnotationsRequest": import_annotations_request "/healthcare:v1beta1/ImportAnnotationsRequest/gcsSource": gcs_source +"/healthcare:v1beta1/ImportAnnotationsRequest/name": name "/healthcare:v1beta1/ImportAnnotationsResponse": import_annotations_response "/healthcare:v1beta1/ImportAnnotationsResponse/annotationStore": annotation_store "/healthcare:v1beta1/ImportAnnotationsResponse/successCount": success_count @@ -102981,6 +102994,7 @@ "/healthcare:v1beta1/SchemaPackage/schematizedParsingType": schematized_parsing_type "/healthcare:v1beta1/SchemaPackage/types": types "/healthcare:v1beta1/SchemaPackage/types/type": type +"/healthcare:v1beta1/SchemaPackage/unexpectedSegmentHandling": unexpected_segment_handling "/healthcare:v1beta1/SchemaSegment": schema_segment "/healthcare:v1beta1/SchemaSegment/maxOccurs": max_occurs "/healthcare:v1beta1/SchemaSegment/minOccurs": min_occurs @@ -106313,6 +106327,83 @@ "/lifesciences:v2beta/lifesciences.projects.locations.pipelines.run": run_pipeline "/lifesciences:v2beta/lifesciences.projects.locations.pipelines.run/parent": parent "/lifesciences:v2beta/quotaUser": quota_user +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport": google_ads_homeservices_localservices_v1_account_report +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport/accountId": account_id +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport/averageFiveStarRating": average_five_star_rating +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport/averageWeeklyBudget": average_weekly_budget +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport/businessName": business_name +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport/currencyCode": currency_code +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport/currentPeriodChargedLeads": current_period_charged_leads +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport/currentPeriodConnectedPhoneCalls": current_period_connected_phone_calls +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport/currentPeriodPhoneCalls": current_period_phone_calls +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport/currentPeriodTotalCost": current_period_total_cost +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport/phoneLeadResponsiveness": phone_lead_responsiveness +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport/previousPeriodChargedLeads": previous_period_charged_leads +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport/previousPeriodConnectedPhoneCalls": previous_period_connected_phone_calls +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport/previousPeriodPhoneCalls": previous_period_phone_calls +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport/previousPeriodTotalCost": previous_period_total_cost +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AccountReport/totalReview": total_review +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AggregatorInfo": google_ads_homeservices_localservices_v1_aggregator_info +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1AggregatorInfo/aggregatorProviderId": aggregator_provider_id +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport": google_ads_homeservices_localservices_v1_detailed_lead_report +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport/accountId": account_id +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport/aggregatorInfo": aggregator_info +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport/businessName": business_name +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport/chargeStatus": charge_status +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport/currencyCode": currency_code +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport/disputeStatus": dispute_status +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport/geo": geo +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport/leadCategory": lead_category +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport/leadCreationTimestamp": lead_creation_timestamp +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport/leadId": lead_id +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport/leadPrice": lead_price +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport/leadType": lead_type +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport/messageLead": message_lead +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport/phoneLead": phone_lead +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport/timezone": timezone +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1MessageLead": google_ads_homeservices_localservices_v1_message_lead +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1MessageLead/consumerPhoneNumber": consumer_phone_number +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1MessageLead/customerName": customer_name +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1MessageLead/jobType": job_type +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1MessageLead/postalCode": postal_code +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1PhoneLead": google_ads_homeservices_localservices_v1_phone_lead +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1PhoneLead/chargedCallTimestamp": charged_call_timestamp +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1PhoneLead/chargedConnectedCallDurationSeconds": charged_connected_call_duration_seconds +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1PhoneLead/consumerPhoneNumber": consumer_phone_number +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse": google_ads_homeservices_localservices_v1_search_account_reports_response +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse/accountReports": account_reports +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse/accountReports/account_report": account_report +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse/nextPageToken": next_page_token +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse": google_ads_homeservices_localservices_v1_search_detailed_lead_reports_response +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse/detailedLeadReports": detailed_lead_reports +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse/detailedLeadReports/detailed_lead_report": detailed_lead_report +"/localservices:v1/GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse/nextPageToken": next_page_token +"/localservices:v1/GoogleTypeTimeZone": google_type_time_zone +"/localservices:v1/GoogleTypeTimeZone/id": id +"/localservices:v1/GoogleTypeTimeZone/version": version +"/localservices:v1/fields": fields +"/localservices:v1/key": key +"/localservices:v1/localservices.accountReports.search": search_account_reports +"/localservices:v1/localservices.accountReports.search/endDate.day": end_date_day +"/localservices:v1/localservices.accountReports.search/endDate.month": end_date_month +"/localservices:v1/localservices.accountReports.search/endDate.year": end_date_year +"/localservices:v1/localservices.accountReports.search/pageSize": page_size +"/localservices:v1/localservices.accountReports.search/pageToken": page_token +"/localservices:v1/localservices.accountReports.search/query": query +"/localservices:v1/localservices.accountReports.search/startDate.day": start_date_day +"/localservices:v1/localservices.accountReports.search/startDate.month": start_date_month +"/localservices:v1/localservices.accountReports.search/startDate.year": start_date_year +"/localservices:v1/localservices.detailedLeadReports.search": search_detailed_lead_reports +"/localservices:v1/localservices.detailedLeadReports.search/endDate.day": end_date_day +"/localservices:v1/localservices.detailedLeadReports.search/endDate.month": end_date_month +"/localservices:v1/localservices.detailedLeadReports.search/endDate.year": end_date_year +"/localservices:v1/localservices.detailedLeadReports.search/pageSize": page_size +"/localservices:v1/localservices.detailedLeadReports.search/pageToken": page_token +"/localservices:v1/localservices.detailedLeadReports.search/query": query +"/localservices:v1/localservices.detailedLeadReports.search/startDate.day": start_date_day +"/localservices:v1/localservices.detailedLeadReports.search/startDate.month": start_date_month +"/localservices:v1/localservices.detailedLeadReports.search/startDate.year": start_date_year +"/localservices:v1/quotaUser": quota_user "/logging:v1beta3/logging.projects.logServices.indexes.list": list_log_service_indexes "/logging:v1beta3/logging.projects.logServices.list": list_log_services "/logging:v1beta3/logging.projects.logServices.sinks.create": create_log_service_sink @@ -136827,6 +136918,8 @@ "/testing:v1/IosTestLoop/scenarios": scenarios "/testing:v1/IosTestLoop/scenarios/scenario": scenario "/testing:v1/IosTestSetup": ios_test_setup +"/testing:v1/IosTestSetup/additionalIpas": additional_ipas +"/testing:v1/IosTestSetup/additionalIpas/additional_ipa": additional_ipa "/testing:v1/IosTestSetup/networkProfile": network_profile "/testing:v1/IosVersion": ios_version "/testing:v1/IosVersion/id": id diff --git a/generated/google/apis/alertcenter_v1beta1.rb b/generated/google/apis/alertcenter_v1beta1.rb index e301b1c90..aa5976850 100644 --- a/generated/google/apis/alertcenter_v1beta1.rb +++ b/generated/google/apis/alertcenter_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/admin-sdk/alertcenter/ module AlertcenterV1beta1 VERSION = 'V1beta1' - REVISION = '20200801' + REVISION = '20200821' # See and delete your domain's G Suite alerts, and send alert feedback AUTH_APPS_ALERTS = 'https://www.googleapis.com/auth/apps.alerts' diff --git a/generated/google/apis/billingbudgets_v1beta1.rb b/generated/google/apis/billingbudgets_v1beta1.rb index 4e611686a..c62d0f28d 100644 --- a/generated/google/apis/billingbudgets_v1beta1.rb +++ b/generated/google/apis/billingbudgets_v1beta1.rb @@ -26,7 +26,10 @@ module Google # @see https://cloud.google.com/billing/docs/how-to/budget-api-overview module BillingbudgetsV1beta1 VERSION = 'V1beta1' - REVISION = '20200801' + REVISION = '20200821' + + # View and manage your Google Cloud Platform billing accounts + AUTH_CLOUD_BILLING = 'https://www.googleapis.com/auth/cloud-billing' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/cloudsearch_v1.rb b/generated/google/apis/cloudsearch_v1.rb index ff9f5c358..333b7f4fd 100644 --- a/generated/google/apis/cloudsearch_v1.rb +++ b/generated/google/apis/cloudsearch_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/cloud-search/docs/guides/ module CloudsearchV1 VERSION = 'V1' - REVISION = '20200803' + REVISION = '20200819' # Index and serve your organization's data with Cloud Search AUTH_CLOUD_SEARCH = 'https://www.googleapis.com/auth/cloud_search' diff --git a/generated/google/apis/cloudsearch_v1/classes.rb b/generated/google/apis/cloudsearch_v1/classes.rb index 4b3d418f4..95b095189 100644 --- a/generated/google/apis/cloudsearch_v1/classes.rb +++ b/generated/google/apis/cloudsearch_v1/classes.rb @@ -2103,6 +2103,31 @@ module Google end end + # The response message for Operations.ListOperations. + class ListOperationsResponse + include Google::Apis::Core::Hashable + + # The standard List next-page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # A list of operations that matches the specified filter in the request. + # Corresponds to the JSON property `operations` + # @return [Array] + attr_accessor :operations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @operations = args[:operations] if args.key?(:operations) + end + end + # List sources response. class ListQuerySourcesResponse include Google::Apis::Core::Hashable diff --git a/generated/google/apis/cloudsearch_v1/representations.rb b/generated/google/apis/cloudsearch_v1/representations.rb index 0f1993208..b63b9d54e 100644 --- a/generated/google/apis/cloudsearch_v1/representations.rb +++ b/generated/google/apis/cloudsearch_v1/representations.rb @@ -424,6 +424,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ListOperationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ListQuerySourcesResponse class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1540,6 +1546,15 @@ module Google end end + class ListOperationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::CloudsearchV1::Operation, decorator: Google::Apis::CloudsearchV1::Operation::Representation + + end + end + class ListQuerySourcesResponse # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/cloudsearch_v1/service.rb b/generated/google/apis/cloudsearch_v1/service.rb index a9ba25216..de64debef 100644 --- a/generated/google/apis/cloudsearch_v1/service.rb +++ b/generated/google/apis/cloudsearch_v1/service.rb @@ -737,15 +737,15 @@ module Google # upload protocols and is intended for large items that can not be [inlined # during index requests](https://developers.google.com/cloud-search/docs/ # reference/rest/v1/indexing.datasources.items#itemcontent). To index large - # content: 1. Call indexing.datasources.items.upload with the resource name to - # begin an upload session and retrieve the UploadItemRef. 1. Call media.upload - # to upload the content using the same resource name from step 1. 1. Call - # indexing.datasources.items.index to index the item. Populate the [ItemContent]( - # /cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent) - # with the UploadItemRef from step 1. For additional information, see [Create a - # content connector using the REST API](https://developers.google.com/cloud- - # search/docs/guides/content-connector#rest). **Note:** This API requires a - # service account to execute. + # content: 1. Call indexing.datasources.items.upload with the item name to begin + # an upload session and retrieve the UploadItemRef. 1. Call media.upload to + # upload the content, as a streaming request, using the same resource name from + # the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to + # index the item. Populate the [ItemContent](/cloud-search/docs/reference/rest/ + # v1/indexing.datasources.items#ItemContent) with the UploadItemRef from step 1. + # For additional information, see [Create a content connector using the REST API] + # (https://developers.google.com/cloud-search/docs/guides/content-connector#rest) + # . **Note:** This API requires a service account to execute. # @param [String] resource_name # Name of the media that is being downloaded. See ReadRequest.resource_name. # @param [Google::Apis::CloudsearchV1::Media] media_object @@ -819,6 +819,52 @@ module Google execute_or_queue_command(command, &block) end + # 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. + # @param [String] name + # The name of the operation's parent resource. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::CloudsearchV1::ListOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::CloudsearchV1::ListOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_operation_lros(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/{+name}/lro', options) + command.response_representation = Google::Apis::CloudsearchV1::ListOperationsResponse::Representation + command.response_class = Google::Apis::CloudsearchV1::ListOperationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # The Cloud Search Query API provides the search method, which returns the most # relevant results from a user query. The results can come from G Suite Apps, # such as Gmail or Google Drive, or they can come from data that you have diff --git a/generated/google/apis/dfareporting_v3_3.rb b/generated/google/apis/dfareporting_v3_3.rb index 50d70b987..c4889375d 100644 --- a/generated/google/apis/dfareporting_v3_3.rb +++ b/generated/google/apis/dfareporting_v3_3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/doubleclick-advertisers/ module DfareportingV3_3 VERSION = 'V3_3' - REVISION = '20200804' + REVISION = '20200825' # Manage DoubleClick Digital Marketing conversions AUTH_DDMCONVERSIONS = 'https://www.googleapis.com/auth/ddmconversions' diff --git a/generated/google/apis/dfareporting_v3_3/classes.rb b/generated/google/apis/dfareporting_v3_3/classes.rb index 4cb3aac8f..3060f79a3 100644 --- a/generated/google/apis/dfareporting_v3_3/classes.rb +++ b/generated/google/apis/dfareporting_v3_3/classes.rb @@ -70,11 +70,11 @@ module Google # for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for # IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD # - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - " - # 26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" - # for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for - # GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - # - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - " - # 48" for HRK - "49" for MXN - "50" for NGN - "51" for EGP + # 26" for PTE - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" + # for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for + # PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON + # - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - " + # 49" for MXN - "50" for NGN - "51" for EGP # Corresponds to the JSON property `currencyId` # @return [Fixnum] attr_accessor :currency_id diff --git a/generated/google/apis/dfareporting_v3_4.rb b/generated/google/apis/dfareporting_v3_4.rb index 6da4975e8..d0de1f2ce 100644 --- a/generated/google/apis/dfareporting_v3_4.rb +++ b/generated/google/apis/dfareporting_v3_4.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/doubleclick-advertisers/ module DfareportingV3_4 VERSION = 'V3_4' - REVISION = '20200804' + REVISION = '20200825' # Manage DoubleClick Digital Marketing conversions AUTH_DDMCONVERSIONS = 'https://www.googleapis.com/auth/ddmconversions' diff --git a/generated/google/apis/dfareporting_v3_4/classes.rb b/generated/google/apis/dfareporting_v3_4/classes.rb index 09f2a4772..1482ebef6 100644 --- a/generated/google/apis/dfareporting_v3_4/classes.rb +++ b/generated/google/apis/dfareporting_v3_4/classes.rb @@ -70,11 +70,11 @@ module Google # for ITL - "11" for DKK - "12" for NOK - "13" for FIM - "14" for ZAR - "15" for # IEP - "16" for NLG - "17" for EUR - "18" for KRW - "19" for TWD - "20" for SGD # - "21" for CNY - "22" for HKD - "23" for NZD - "24" for MYR - "25" for BRL - " - # 26" for PTE - "27" for MXP - "28" for CLP - "29" for TRY - "30" for ARS - "31" - # for PEN - "32" for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for - # GTQ - "37" for PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - # - "43" for RON - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - " - # 48" for HRK - "49" for MXN - "50" for NGN - "51" for EGP + # 26" for PTE - "28" for CLP - "29" for TRY - "30" for ARS - "31" for PEN - "32" + # for ILS - "33" for CHF - "34" for VEF - "35" for COP - "36" for GTQ - "37" for + # PLN - "39" for INR - "40" for THB - "41" for IDR - "42" for CZK - "43" for RON + # - "44" for HUF - "45" for RUB - "46" for AED - "47" for BGN - "48" for HRK - " + # 49" for MXN - "50" for NGN - "51" for EGP # Corresponds to the JSON property `currencyId` # @return [Fixnum] attr_accessor :currency_id @@ -2427,10 +2427,18 @@ module Google # @return [Array] attr_accessor :custom_variables + # The display click ID. This field is mutually exclusive with encryptedUserId, + # encryptedUserIdCandidates[], matchId, mobileDeviceId and gclid. This or + # encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or + # gclid is a required field. + # Corresponds to the JSON property `dclid` + # @return [String] + attr_accessor :dclid + # The alphanumeric encrypted user ID. When set, encryptionInfo should also be # specified. This field is mutually exclusive with encryptedUserIdCandidates[], - # matchId, mobileDeviceId and gclid. This or encryptedUserIdCandidates[] or - # matchId or mobileDeviceId or gclid is a required field. + # matchId, mobileDeviceId, gclid and dclid. This or encryptedUserIdCandidates[] + # or matchId or mobileDeviceId or gclid or dclid is a required field. # Corresponds to the JSON property `encryptedUserId` # @return [String] attr_accessor :encrypted_user_id @@ -2441,8 +2449,8 @@ module Google # INVALID_ARGUMENT error. When set, encryptionInfo should also be specified. # This field may only be used when calling batchinsert; it is not supported by # batchupdate. This field is mutually exclusive with encryptedUserId, matchId, - # mobileDeviceId and gclid. This or encryptedUserId or matchId or mobileDeviceId - # or gclid is a required field. + # mobileDeviceId, gclid and dclid. This or encryptedUserId or matchId or + # mobileDeviceId or gclid or dclid is a required field. # Corresponds to the JSON property `encryptedUserIdCandidates` # @return [Array] attr_accessor :encrypted_user_id_candidates @@ -2458,9 +2466,9 @@ module Google attr_accessor :floodlight_configuration_id # The Google click ID. This field is mutually exclusive with encryptedUserId, - # encryptedUserIdCandidates[], matchId and mobileDeviceId. This or - # encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId is - # a required field. + # encryptedUserIdCandidates[], matchId, mobileDeviceId and dclid. This or + # encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or + # dclid is a required field. # Corresponds to the JSON property `gclid` # @return [String] attr_accessor :gclid @@ -2481,15 +2489,17 @@ module Google # The match ID field. A match ID is your own first-party identifier that has # been synced with Google using the match ID feature in Floodlight. This field # is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], - # mobileDeviceId and gclid. This or encryptedUserId or encryptedUserIdCandidates[ - # ] or mobileDeviceId or gclid is a required field. + # mobileDeviceId, gclid and dclid. This or encryptedUserId or + # encryptedUserIdCandidates[] or mobileDeviceId or gclid or dclid is a required + # field. # Corresponds to the JSON property `matchId` # @return [String] attr_accessor :match_id # The mobile device ID. This field is mutually exclusive with encryptedUserId, - # encryptedUserIdCandidates[], matchId and gclid. This or encryptedUserId or - # encryptedUserIdCandidates[] or matchId or gclid is a required field. + # encryptedUserIdCandidates[], matchId, gclid and dclid. This or encryptedUserId + # or encryptedUserIdCandidates[] or matchId or gclid or dclid is a required + # field. # Corresponds to the JSON property `mobileDeviceId` # @return [String] attr_accessor :mobile_device_id @@ -2537,6 +2547,7 @@ module Google def update!(**args) @child_directed_treatment = args[:child_directed_treatment] if args.key?(:child_directed_treatment) @custom_variables = args[:custom_variables] if args.key?(:custom_variables) + @dclid = args[:dclid] if args.key?(:dclid) @encrypted_user_id = args[:encrypted_user_id] if args.key?(:encrypted_user_id) @encrypted_user_id_candidates = args[:encrypted_user_id_candidates] if args.key?(:encrypted_user_id_candidates) @floodlight_activity_id = args[:floodlight_activity_id] if args.key?(:floodlight_activity_id) diff --git a/generated/google/apis/dfareporting_v3_4/representations.rb b/generated/google/apis/dfareporting_v3_4/representations.rb index 88296b8ff..0994a8c78 100644 --- a/generated/google/apis/dfareporting_v3_4/representations.rb +++ b/generated/google/apis/dfareporting_v3_4/representations.rb @@ -2128,6 +2128,7 @@ module Google property :child_directed_treatment, as: 'childDirectedTreatment' collection :custom_variables, as: 'customVariables', class: Google::Apis::DfareportingV3_4::CustomFloodlightVariable, decorator: Google::Apis::DfareportingV3_4::CustomFloodlightVariable::Representation + property :dclid, as: 'dclid' property :encrypted_user_id, as: 'encryptedUserId' collection :encrypted_user_id_candidates, as: 'encryptedUserIdCandidates' property :floodlight_activity_id, :numeric_string => true, as: 'floodlightActivityId' diff --git a/generated/google/apis/firebase_v1beta1.rb b/generated/google/apis/firebase_v1beta1.rb index b74f32b13..b1ac6773d 100644 --- a/generated/google/apis/firebase_v1beta1.rb +++ b/generated/google/apis/firebase_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://firebase.google.com module FirebaseV1beta1 VERSION = 'V1beta1' - REVISION = '20200819' + REVISION = '20200822' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firestore_v1.rb b/generated/google/apis/firestore_v1.rb index a584507e6..d075d912a 100644 --- a/generated/google/apis/firestore_v1.rb +++ b/generated/google/apis/firestore_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/firestore module FirestoreV1 VERSION = 'V1' - REVISION = '20200801' + REVISION = '20200818' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firestore_v1beta1.rb b/generated/google/apis/firestore_v1beta1.rb index e193de536..73a04d8e2 100644 --- a/generated/google/apis/firestore_v1beta1.rb +++ b/generated/google/apis/firestore_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/firestore module FirestoreV1beta1 VERSION = 'V1beta1' - REVISION = '20200801' + REVISION = '20200818' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/fitness_v1.rb b/generated/google/apis/fitness_v1.rb index 0ae8f9321..0396bb984 100644 --- a/generated/google/apis/fitness_v1.rb +++ b/generated/google/apis/fitness_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/fit/rest/v1/get-started module FitnessV1 VERSION = 'V1' - REVISION = '20200818' + REVISION = '20200820' # Use Google Fit to see and store your physical activity data AUTH_FITNESS_ACTIVITY_READ = 'https://www.googleapis.com/auth/fitness.activity.read' diff --git a/generated/google/apis/fitness_v1/service.rb b/generated/google/apis/fitness_v1/service.rb index 02d7a379f..d8c6e9b16 100644 --- a/generated/google/apis/fitness_v1/service.rb +++ b/generated/google/apis/fitness_v1/service.rb @@ -43,8 +43,8 @@ module Google attr_accessor :quota_user def initialize - super('https://www.googleapis.com/', 'fitness/v1/users/') - @batch_path = 'batch/fitness/v1' + super('https://fitness.googleapis.com/', 'fitness/v1/users/') + @batch_path = 'batch' end # Creates a new data source that is unique across all data sources belonging to diff --git a/generated/google/apis/gmail_v1.rb b/generated/google/apis/gmail_v1.rb index ea5be53a2..1c630968c 100644 --- a/generated/google/apis/gmail_v1.rb +++ b/generated/google/apis/gmail_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/gmail/api/ module GmailV1 VERSION = 'V1' - REVISION = '20200817' + REVISION = '20200824' # Read, compose, send, and permanently delete all your email from Gmail AUTH_SCOPE = 'https://mail.google.com/' diff --git a/generated/google/apis/gmail_v1/service.rb b/generated/google/apis/gmail_v1/service.rb index d3a500499..85a408795 100644 --- a/generated/google/apis/gmail_v1/service.rb +++ b/generated/google/apis/gmail_v1/service.rb @@ -795,7 +795,8 @@ module Google # Imports a message into only this user's mailbox, with standard email delivery # scanning and classification similar to receiving via SMTP. Does not send a - # message. + # message. Note: This function doesn't trigger forwarding rules or filters set + # up by the user. # @param [String] user_id # The user's email address. The special value `me` can be used to indicate the # authenticated user. diff --git a/generated/google/apis/healthcare_v1.rb b/generated/google/apis/healthcare_v1.rb index f7460f210..9086f64a5 100644 --- a/generated/google/apis/healthcare_v1.rb +++ b/generated/google/apis/healthcare_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/healthcare module HealthcareV1 VERSION = 'V1' - REVISION = '20200813' + REVISION = '20200819' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1/classes.rb b/generated/google/apis/healthcare_v1/classes.rb index 57f0feba2..66eb9f258 100644 --- a/generated/google/apis/healthcare_v1/classes.rb +++ b/generated/google/apis/healthcare_v1/classes.rb @@ -22,53 +22,21 @@ module Google module Apis module HealthcareV1 - # 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. + # 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. class AuditConfig include Google::Apis::Core::Hashable @@ -77,9 +45,9 @@ module Google # @return [Array] attr_accessor :audit_log_configs - # 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. + # 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. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service @@ -95,28 +63,15 @@ module Google end end - # 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. + # 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. class AuditLogConfig include Google::Apis::Core::Hashable - # Specifies the identities that do not cause logging for this type of - # permission. + # Specifies the identities that do not cause logging for this type of permission. # Follows the same format of Binding.members. # Corresponds to the JSON property `exemptedMembers` # @return [Array] @@ -142,69 +97,57 @@ module Google class Binding include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `condition` # @return [Google::Apis::HealthcareV1::Expr] attr_accessor :condition - # 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`. + # 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`. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members - # Role that is assigned to `members`. - # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor` + # , or `roles/owner`. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -257,10 +200,8 @@ module Google class CreateMessageRequest include Google::Apis::Core::Hashable - # A complete HL7v2 message. - # See [Introduction to HL7 Standards] - # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for - # details on the standard. + # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7. + # org/implement/standards/index.cfm?ref=common) for details on the standard. # Corresponds to the JSON property `message` # @return [Google::Apis::HealthcareV1::Message] attr_accessor :message @@ -276,15 +217,14 @@ module Google end # Pseudonymization method that generates surrogates via cryptographic hashing. - # Uses SHA-256. - # Outputs a base64-encoded representation of the hashed output - # (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). + # Uses SHA-256. Outputs a base64-encoded representation of the hashed output ( + # for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). class CryptoHashConfig include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `cryptoKey` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -300,23 +240,23 @@ module Google end end - # 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. + # 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. class Dataset include Google::Apis::Core::Hashable - # Resource name of the dataset, of the form - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # Resource name of the dataset, of the form `projects/`project_id`/locations/` + # location_id`/datasets/`dataset_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # 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. + # 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. # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone @@ -337,9 +277,9 @@ module Google class DateShiftConfig include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `cryptoKey` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -355,10 +295,9 @@ module Google end end - # 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. + # 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. class DeidentifyConfig include Google::Apis::Core::Hashable @@ -400,19 +339,17 @@ module Google class DeidentifyDatasetRequest include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `config` # @return [Google::Apis::HealthcareV1::DeidentifyConfig] attr_accessor :config - # 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 project and location as the - # source dataset. De-identifying data across multiple projects or locations - # is not supported. + # 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 project and location as the source dataset. De-identifying data + # across multiple projects or locations is not supported. # Corresponds to the JSON property `destinationDataset` # @return [String] attr_accessor :destination_dataset @@ -432,24 +369,20 @@ module Google class DeidentifyDicomStoreRequest include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `config` # @return [Google::Apis::HealthcareV1::DeidentifyConfig] attr_accessor :config - # 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`/ - # dicomStores/`dicom_store_id``. - # * The destination dataset must exist. - # * The source dataset and destination dataset must both reside in the same - # project. De-identifying data across multiple projects is not supported. - # * The destination DICOM store must not exist. - # * The caller must have the necessary permissions to create the destination - # DICOM store. + # 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`/ + # dicomStores/`dicom_store_id``. * The destination dataset must exist. * The + # source dataset and destination dataset must both reside in the same project. + # De-identifying data across multiple projects is not supported. * The + # destination DICOM store must not exist. * The caller must have the necessary + # permissions to create the destination DICOM store. # Corresponds to the JSON property `destinationStore` # @return [String] attr_accessor :destination_store @@ -475,24 +408,20 @@ module Google class DeidentifyFhirStoreRequest include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `config` # @return [Google::Apis::HealthcareV1::DeidentifyConfig] attr_accessor :config - # 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`/ - # fhirStores/`fhir_store_id``. - # * The destination dataset must exist. - # * The source dataset and destination dataset must both reside in the same - # project. De-identifying data across multiple projects 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. + # 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`/ + # fhirStores/`fhir_store_id``. * The destination dataset must exist. * The + # source dataset and destination dataset must both reside in the same project. + # De-identifying data across multiple projects 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. # Corresponds to the JSON property `destinationStore` # @return [String] attr_accessor :destination_store @@ -546,14 +475,13 @@ module Google # @return [Google::Apis::HealthcareV1::TagFilterList] attr_accessor :remove_list - # 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. + # 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 # Corresponds to the JSON property `skipIdRedaction` # @return [Boolean] @@ -577,15 +505,13 @@ module Google class DicomFilterConfig include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `resourcePathsGcsUri` # @return [String] attr_accessor :resource_paths_gcs_uri @@ -604,22 +530,19 @@ module Google class DicomStore include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Resource name of the DICOM store, of the form - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # dicomStores/`dicom_store_id``. + # Resource name of the DICOM store, of the form `projects/`project_id`/locations/ + # `location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -641,13 +564,11 @@ module Google end end - # 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 ````. + # 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 ````. class Empty include Google::Apis::Core::Hashable @@ -660,12 +581,10 @@ module Google end end - # 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. + # 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. class ExportDicomDataRequest include Google::Apis::Core::Hashable @@ -729,10 +648,9 @@ module Google end end - # Response when all resources export successfully. - # This structure is included in the - # response to describe the detailed - # outcome after the operation finishes successfully. + # Response when all resources export successfully. This structure is included in + # the response to describe the detailed outcome after the operation finishes + # successfully. class ExportResourcesResponse include Google::Apis::Core::Hashable @@ -745,52 +663,43 @@ module Google end end - # 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. + # 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. class Expr include Google::Apis::Core::Hashable - # Optional. Description of the expression. This is a longer text which - # describes the expression, e.g. when hovered over it in a UI. + # Optional. Description of the expression. This is a longer text which describes + # the expression, e.g. when hovered over it in a UI. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Textual representation of an expression in Common Expression Language - # syntax. + # Textual representation of an expression in Common Expression Language syntax. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression - # Optional. String indicating the location of the expression for error - # reporting, e.g. a file name and a position in the file. + # Optional. String indicating the location of the expression for error reporting, + # e.g. a file name and a position in the file. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # 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. + # 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. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -812,9 +721,9 @@ module Google class FhirConfig include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `fieldMetadataList` # @return [Array] attr_accessor :field_metadata_list @@ -853,61 +762,55 @@ module Google include Google::Apis::Core::Hashable # 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. + # 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. # Corresponds to the JSON property `disableReferentialIntegrity` # @return [Boolean] attr_accessor :disable_referential_integrity alias_method :disable_referential_integrity?, :disable_referential_integrity - # 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. + # 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. # Corresponds to the JSON property `disableResourceVersioning` # @return [Boolean] attr_accessor :disable_resource_versioning alias_method :disable_resource_versioning?, :disable_resource_versioning - # 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. Please treat the audit logs with appropriate levels of - # care if client-specified resource IDs contain sensitive data such as - # patient identifiers, those IDs are part of the FHIR resource path - # recorded in Cloud audit logs and Cloud Pub/Sub notifications. + # 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. Please treat the audit logs with appropriate levels of + # care if client-specified resource IDs contain sensitive data such as patient + # identifiers, those IDs are part of the FHIR resource path recorded in Cloud + # audit logs and Cloud Pub/Sub notifications. # Corresponds to the JSON property `enableUpdateCreate` # @return [Boolean] attr_accessor :enable_update_create alias_method :enable_update_create?, :enable_update_create - # 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. + # 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. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Output only. Resource name of the FHIR store, of the form - # `projects/`project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. + # Output only. Resource name of the FHIR store, of the form `projects/` + # project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -918,26 +821,24 @@ module Google attr_accessor :notification_config # 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. + # 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. # Corresponds to the JSON property `streamConfigs` # @return [Array] attr_accessor :stream_configs # 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. + # 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. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -959,8 +860,8 @@ module Google end end - # Specifies FHIR paths to match, and how to handle de-identification of - # matching fields. + # Specifies FHIR paths to match, and how to handle de-identification of matching + # fields. class FieldMetadata include Google::Apis::Core::Hashable @@ -969,17 +870,14 @@ module Google # @return [String] attr_accessor :action - # List of paths to FHIR fields to be redacted. Each path is a - # period-separated list where each component is either a field name or - # FHIR type name, for example: Patient, HumanName. - # For "choice" types (those defined in the FHIR spec with the form: - # field[x]) we 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. - # Base64Binary is also supported, but may only be kept as-is or have all - # the content removed. + # List of paths to FHIR fields to be redacted. Each path is a period-separated + # list where each component is either a field name or FHIR type name, for + # example: Patient, HumanName. For "choice" types (those defined in the FHIR + # spec with the form: field[x]) we 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. Base64Binary is also + # supported, but may only be kept as-is or have all the content removed. # Corresponds to the JSON property `paths` # @return [Array] attr_accessor :paths @@ -1025,17 +923,16 @@ module Google class GoogleCloudHealthcareV1DicomBigQueryDestination include Google::Apis::Core::Hashable - # If the destination table already exists and this flag is `TRUE`, the table - # is overwritten by the contents of the DICOM store. If the flag is not - # set and the destination table already exists, the export call returns an - # error. + # If the destination table already exists and this flag is `TRUE`, the table is + # overwritten by the contents of the DICOM store. If the flag is not set and the + # destination table already exists, the export call returns an error. # Corresponds to the JSON property `force` # @return [Boolean] attr_accessor :force alias_method :force?, :force - # BigQuery URI to a table, up to 2000 characters long, in the format - # `bq://projectId.bqDatasetId.tableId` + # BigQuery URI to a table, up to 2000 characters long, in the format `bq:// + # projectId.bqDatasetId.tableId` # Corresponds to the JSON property `tableUri` # @return [String] attr_accessor :table_uri @@ -1056,47 +953,33 @@ module Google class GoogleCloudHealthcareV1DicomGcsDestination include Google::Apis::Core::Hashable - # 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) - # - 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. + # 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) - 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. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type - # 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`. + # 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`. # Corresponds to the JSON property `uriPrefix` # @return [String] attr_accessor :uri_prefix @@ -1116,22 +999,17 @@ module Google class GoogleCloudHealthcareV1DicomGcsSource include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1150,15 +1028,15 @@ module Google class GoogleCloudHealthcareV1FhirBigQueryDestination include Google::Apis::Core::Hashable - # BigQuery URI to an existing dataset, up to 2000 characters long, in the - # format `bq://projectId.bqDatasetId`. + # BigQuery URI to an existing dataset, up to 2000 characters long, in the format + # `bq://projectId.bqDatasetId`. # Corresponds to the JSON property `datasetUri` # @return [String] attr_accessor :dataset_uri - # If this flag is `TRUE`, all tables are deleted from the dataset before - # the new exported tables are written. If the flag is not set and the - # destination dataset contains tables, the export call returns an error. + # If this flag is `TRUE`, all tables are deleted from the dataset before the new + # exported tables are written. If the flag is not set and the destination + # dataset contains tables, the export call returns an error. # Corresponds to the JSON property `force` # @return [Boolean] attr_accessor :force @@ -1186,11 +1064,11 @@ module Google class GoogleCloudHealthcareV1FhirGcsDestination include Google::Apis::Core::Hashable - # URI for a Cloud Storage directory where result files should be written, in - # the format of `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`. + # URI for a Cloud Storage directory where result files should be written, in the + # format of `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`. # Corresponds to the JSON property `uriPrefix` # @return [String] attr_accessor :uri_prefix @@ -1209,21 +1087,17 @@ module Google class GoogleCloudHealthcareV1FhirGcsSource include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1238,56 +1112,45 @@ module Google end end - # Specifies where and whether to send notifications upon changes to a - # data store. + # Specifies where and whether to send notifications upon changes to a data store. class Hl7V2NotificationConfig include Google::Apis::Core::Hashable - # Restricts notifications sent for messages matching a filter. If this is - # empty, all messages are matched. Syntax: - # https://cloud.google.com/appengine/docs/standard/python/search/query_strings - # The following fields and functions are available for filtering: - # * `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"`. - # * `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":*`. + # Restricts notifications sent for messages matching a filter. If this is empty, + # all messages are matched. Syntax: https://cloud.google.com/appengine/docs/ + # standard/python/search/query_strings The following fields and functions are + # available for filtering: * `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"`. * ` + # 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":*`. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter # The [Cloud 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's - # 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. - # The Cloud Healthcare API service account, - # service-PROJECT_NUMBER@gcp-sa-healthcare.iam.gserviceaccount.com, - # 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 cannot be published to Cloud Pub/Sub, errors are - # logged to Cloud Logging. For more information, see - # [Viewing error logs in Cloud Logging](/healthcare/docs/how-tos/logging)). + # 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's 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. The Cloud Healthcare API service account, service-PROJECT_NUMBER@gcp- + # sa-healthcare.iam.gserviceaccount.com, 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 cannot be published to Cloud Pub/ + # Sub, errors are logged to Cloud Logging. For more information, see [Viewing + # error logs in Cloud Logging](/healthcare/docs/how-tos/logging)). # Corresponds to the JSON property `pubsubTopic` # @return [String] attr_accessor :pubsub_topic @@ -1307,29 +1170,27 @@ module Google class Hl7V2Store include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Resource name of the HL7v2 store, of the form - # `projects/`project_id`/datasets/`dataset_id`/hl7V2Stores/`hl7v2_store_id``. + # Resource name of the HL7v2 store, of the form `projects/`project_id`/datasets/` + # dataset_id`/hl7V2Stores/`hl7v2_store_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # 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. + # 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. # Corresponds to the JSON property `notificationConfigs` # @return [Array] attr_accessor :notification_configs @@ -1340,17 +1201,15 @@ module Google # @return [Google::Apis::HealthcareV1::ParserConfig] attr_accessor :parser_config - # 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. + # 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. # Corresponds to the JSON property `rejectDuplicateMessage` # @return [Boolean] attr_accessor :reject_duplicate_message @@ -1371,34 +1230,21 @@ module Google end # 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. + # 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. class HttpBody include Google::Apis::Core::Hashable @@ -1413,8 +1259,8 @@ module Google # @return [String] attr_accessor :data - # Application specific response metadata. Must be set in the first response - # for streaming APIs. + # Application specific response metadata. Must be set in the first response for + # streaming APIs. # Corresponds to the JSON property `extensions` # @return [Array>] attr_accessor :extensions @@ -1450,10 +1296,9 @@ module Google end end - # 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. + # 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. class ImportDicomDataRequest include Google::Apis::Core::Hashable @@ -1511,10 +1356,9 @@ module Google end end - # Final response of importing resources. - # This structure is included in the - # response to describe the detailed - # outcome after the operation finishes successfully. + # Final response of importing resources. This structure is included in the + # response to describe the detailed outcome after the operation finishes + # successfully. class ImportResourcesResponse include Google::Apis::Core::Hashable @@ -1527,8 +1371,7 @@ module Google end end - # A transformation to apply to text that is identified as a specific - # info_type. + # A transformation to apply to text that is identified as a specific info_type. class InfoTypeTransformation include Google::Apis::Core::Hashable @@ -1538,9 +1381,8 @@ module Google attr_accessor :character_mask_config # Pseudonymization method that generates surrogates via cryptographic hashing. - # Uses SHA-256. - # Outputs a base64-encoded representation of the hashed output - # (for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). + # Uses SHA-256. Outputs a base64-encoded representation of the hashed output ( + # for example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`). # Corresponds to the JSON property `cryptoHashConfig` # @return [Google::Apis::HealthcareV1::CryptoHashConfig] attr_accessor :crypto_hash_config @@ -1557,18 +1399,15 @@ module Google # @return [Array] attr_accessor :info_types - # Define how to redact sensitive values. Default behaviour is erase. - # For example, "My name is Jane." becomes "My name is ." + # Define how to redact sensitive values. Default behaviour is erase. For example, + # "My name is Jane." becomes "My name is ." # Corresponds to the JSON property `redactConfig` # @return [Google::Apis::HealthcareV1::RedactConfig] attr_accessor :redact_config - # 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. + # 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. # Corresponds to the JSON property `replaceWithInfoTypeConfig` # @return [Google::Apis::HealthcareV1::ReplaceWithInfoTypeConfig] attr_accessor :replace_with_info_type_config @@ -1592,10 +1431,8 @@ module Google class IngestMessageRequest include Google::Apis::Core::Hashable - # A complete HL7v2 message. - # See [Introduction to HL7 Standards] - # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for - # details on the standard. + # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7. + # org/implement/standards/index.cfm?ref=common) for details on the standard. # Corresponds to the JSON property `message` # @return [Google::Apis::HealthcareV1::Message] attr_accessor :message @@ -1610,8 +1447,7 @@ module Google end end - # Acknowledges that a message has been ingested into the specified - # HL7v2 store. + # Acknowledges that a message has been ingested into the specified HL7v2 store. class IngestMessageResponse include Google::Apis::Core::Hashable @@ -1621,10 +1457,8 @@ module Google # @return [String] attr_accessor :hl7_ack - # A complete HL7v2 message. - # See [Introduction to HL7 Standards] - # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for - # details on the standard. + # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7. + # org/implement/standards/index.cfm?ref=common) for details on the standard. # Corresponds to the JSON property `message` # @return [Google::Apis::HealthcareV1::Message] attr_accessor :message @@ -1649,8 +1483,8 @@ module Google # @return [Array] attr_accessor :datasets - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1751,10 +1585,8 @@ module Google class ListMessagesResponse include Google::Apis::Core::Hashable - # The returned Messages. Won't be more Messages than the value of - # page_size in the request. See - # view for - # populated fields. + # The returned Messages. Won't be more Messages than the value of page_size in + # the request. See view for populated fields. # Corresponds to the JSON property `hl7V2Messages` # @return [Array] attr_accessor :hl7_v2_messages @@ -1801,10 +1633,8 @@ module Google end end - # A complete HL7v2 message. - # See [Introduction to HL7 Standards] - # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for - # details on the standard. + # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7. + # org/implement/standards/index.cfm?ref=common) for details on the standard. class Message include Google::Apis::Core::Hashable @@ -1819,15 +1649,13 @@ module Google # @return [String] attr_accessor :data - # 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. + # 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. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -1837,10 +1665,9 @@ module Google # @return [String] attr_accessor :message_type - # 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. + # 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. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1850,8 +1677,7 @@ module Google # @return [Google::Apis::HealthcareV1::ParsedData] attr_accessor :parsed_data - # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this - # message. + # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. # Corresponds to the JSON property `patientIds` # @return [Array] attr_accessor :patient_ids @@ -1890,20 +1716,17 @@ module Google # The [Cloud 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.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 Cloud Pub/Sub topic. Not having adequate - # permissions causes the calls that send notifications to fail. - # If a notification can't be published to Cloud Pub/Sub, errors are logged to - # Cloud Logging (see [Viewing - # logs](/healthcare/docs/how-tos/logging)). If the number of - # errors exceeds a certain rate, some aren't submitted. + # 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 Cloud Pub/Sub topic. Not having adequate permissions causes the calls + # that send notifications to fail. If a notification can't be published to Cloud + # Pub/Sub, errors are logged to Cloud Logging (see [Viewing logs](/healthcare/ + # docs/how-tos/logging)). If the number of errors exceeds a certain rate, some + # aren't submitted. # Corresponds to the JSON property `pubsubTopic` # @return [String] attr_accessor :pubsub_topic @@ -1923,47 +1746,45 @@ module Google class Operation include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done - # 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). + # 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). # Corresponds to the JSON property `error` # @return [Google::Apis::HealthcareV1::Status] attr_accessor :error - # 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. + # 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. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # 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``. + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # 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`. + # 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`. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response @@ -1982,8 +1803,8 @@ module Google end end - # OperationMetadata provides information about the operation execution. - # Returned in the long-running operation's metadata field. + # OperationMetadata provides information about the operation execution. Returned + # in the long-running operation's metadata field. class OperationMetadata include Google::Apis::Core::Hashable @@ -2014,8 +1835,8 @@ module Google attr_accessor :end_time # A link to audit and error logs in the log viewer. Error logs are generated - # only by some operations, listed at - # [Viewing logs](/healthcare/docs/how-tos/logging). + # only by some operations, listed at [Viewing logs](/healthcare/docs/how-tos/ + # logging). # Corresponds to the JSON property `logsUrl` # @return [String] attr_accessor :logs_url @@ -2065,8 +1886,8 @@ module Google attr_accessor :allow_null_header alias_method :allow_null_header?, :allow_null_header - # Byte(s) to use as the segment terminator. If this is unset, '\r' is - # used as segment terminator. + # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as + # segment terminator. # Corresponds to the JSON property `segmentTerminator` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2109,66 +1930,32 @@ module Google end # 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/). + # 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/). class Policy include Google::Apis::Core::Hashable @@ -2177,48 +1964,44 @@ module Google # @return [Array] attr_accessor :audit_configs - # 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. + # 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. # Corresponds to the JSON property `bindings` # @return [Array] attr_accessor :bindings - # `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` 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. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag - # 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). + # 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). # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -2267,8 +2050,8 @@ module Google end end - # Define how to redact sensitive values. Default behaviour is erase. - # For example, "My name is Jane." becomes "My name is ." + # Define how to redact sensitive values. Default behaviour is erase. For example, + # "My name is Jane." becomes "My name is ." class RedactConfig include Google::Apis::Core::Hashable @@ -2281,12 +2064,9 @@ module Google end end - # 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. + # 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. class ReplaceWithInfoTypeConfig include Google::Apis::Core::Hashable @@ -2323,17 +2103,16 @@ module Google class SchemaConfig include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `recursiveStructureDepth` # @return [Fixnum] attr_accessor :recursive_structure_depth - # Specifies the output schema type. + # Specifies the output schema type. Schema type is required. # Corresponds to the JSON property `schemaType` # @return [String] attr_accessor :schema_type @@ -2354,10 +2133,10 @@ module Google include Google::Apis::Core::Hashable # The FHIR resource type to search, such as Patient or Observation. For a - # complete list, see the FHIR Resource Index - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). + # complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/ + # standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/ + # standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/ + # standards/fhir/R4/resourcelist.html)). # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -2376,18 +2155,15 @@ module Google class Segment include Google::Apis::Core::Hashable - # 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". + # 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". # Corresponds to the JSON property `fields` # @return [Hash] attr_accessor :fields @@ -2397,8 +2173,8 @@ module Google # @return [String] attr_accessor :segment_id - # Set ID for segments that can be in a set. This can be empty if it's - # missing or isn't applicable. + # Set ID for segments that can be in a set. This can be empty if it's missing or + # isn't applicable. # Corresponds to the JSON property `setId` # @return [String] attr_accessor :set_id @@ -2420,74 +2196,39 @@ module Google include Google::Apis::Core::Hashable # 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/). + # 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/). # Corresponds to the JSON property `policy` # @return [Google::Apis::HealthcareV1::Policy] attr_accessor :policy # 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"` + # the fields in the mask will be modified. If no mask is provided, the following + # default mask is used: `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -2503,12 +2244,12 @@ module Google end end - # 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). + # 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). class Status include Google::Apis::Core::Hashable @@ -2517,15 +2258,15 @@ module Google # @return [Fixnum] attr_accessor :code - # A list of messages that carry the error details. There is a common set of + # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details - # 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. + # 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. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -2551,10 +2292,9 @@ module Google # @return [Google::Apis::HealthcareV1::GoogleCloudHealthcareV1FhirBigQueryDestination] attr_accessor :bigquery_destination - # 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 + # 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. # Corresponds to the JSON property `resourceTypes` # @return [Array] @@ -2575,11 +2315,10 @@ module Google class TagFilterList include Google::Apis::Core::Hashable - # 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 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". # Corresponds to the JSON property `tags` # @return [Array] attr_accessor :tags @@ -2598,10 +2337,9 @@ module Google class TestIamPermissionsRequest include Google::Apis::Core::Hashable - # 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). + # 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). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -2620,8 +2358,7 @@ module Google class TestIamPermissionsResponse include Google::Apis::Core::Hashable - # A subset of `TestPermissionsRequest.permissions` that the caller is - # allowed. + # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions diff --git a/generated/google/apis/healthcare_v1/service.rb b/generated/google/apis/healthcare_v1/service.rb index a70b67fd1..177a8d89b 100644 --- a/generated/google/apis/healthcare_v1/service.rb +++ b/generated/google/apis/healthcare_v1/service.rb @@ -47,20 +47,18 @@ module Google @batch_path = 'batch' end - # 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. - # A Google Cloud Platform project can contain up to 500 datasets across all + # 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. A + # Google Cloud Platform project can contain up to 500 datasets across all # regions. # @param [String] parent - # The name of the project where the server creates the dataset. For - # example, `projects/`project_id`/locations/`location_id``. + # The name of the project where the server creates the dataset. For example, ` + # projects/`project_id`/locations/`location_id``. # @param [Google::Apis::HealthcareV1::Dataset] dataset_object # @param [String] dataset_id - # The ID of the dataset that is being created. - # The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``. + # The ID of the dataset that is being created. The string must match the + # following regex: `[\p`L`\p`N`_\-\.]`1,256``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -91,22 +89,17 @@ module Google execute_or_queue_command(command, &block) end - # 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. - # If errors occur, error is set. + # 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. If errors occur, error is set. # The LRO result may still be successful if de-identification fails for some - # DICOM instances. The new de-identified dataset will not contain these - # failed resources. Failed resource totals are tracked in - # Operation.metadata. - # Error details are also logged to Cloud Logging. For more information, - # see [Viewing logs](/healthcare/docs/how-tos/logging). + # DICOM instances. The new de-identified dataset will not contain these failed + # resources. Failed resource totals are tracked in Operation.metadata. Error + # details are also logged to Cloud Logging. For more information, see [Viewing + # logs](/healthcare/docs/how-tos/logging). # @param [String] source_dataset - # Source dataset resource name. For example, - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # Source dataset resource name. For example, `projects/`project_id`/locations/` + # location_id`/datasets/`dataset_id``. # @param [Google::Apis::HealthcareV1::DeidentifyDatasetRequest] deidentify_dataset_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -141,8 +134,8 @@ module Google # Deleting a dataset does not affect the sources from which the dataset was # imported (if any). # @param [String] name - # The name of the dataset to delete. For example, - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # The name of the dataset to delete. For example, `projects/`project_id`/ + # locations/`location_id`/datasets/`dataset_id``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -172,8 +165,8 @@ module Google # Gets any metadata associated with a dataset. # @param [String] name - # The name of the dataset to read. For example, - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # The name of the dataset to read. For example, `projects/`project_id`/locations/ + # `location_id`/datasets/`dataset_id``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -201,22 +194,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. 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). + # Optional. 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). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -247,11 +237,11 @@ module Google # Lists the health datasets in the current project. # @param [String] parent - # The name of the project whose datasets should be listed. - # For example, `projects/`project_id`/locations/`location_id``. + # The name of the project whose datasets should be listed. For example, ` + # projects/`project_id`/locations/`location_id``. # @param [Fixnum] page_size - # The maximum number of items to return. Capped to 100 if not specified. - # May not be larger than 1000. + # The maximum number of items to return. Capped to 100 if not specified. May not + # be larger than 1000. # @param [String] page_token # The next_page_token value returned from a previous List request, if any. # @param [String] fields @@ -285,12 +275,11 @@ module Google # Updates dataset metadata. # @param [String] name - # Resource name of the dataset, of the form - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # Resource name of the dataset, of the form `projects/`project_id`/locations/` + # location_id`/datasets/`dataset_id``. # @param [Google::Apis::HealthcareV1::Dataset] dataset_object # @param [String] update_mask - # The update mask applies to the resource. For the `FieldMask` definition, - # see + # The update mask applies to the resource. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# # fieldmask # @param [String] fields @@ -324,11 +313,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -359,15 +348,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -403,8 +391,8 @@ module Google # The name of the dataset this DICOM store belongs to. # @param [Google::Apis::HealthcareV1::DicomStore] dicom_store_object # @param [String] dicom_store_id - # The ID of the DICOM store that is being created. - # Any string value up to 256 characters in length. + # The ID of the DICOM store that is being created. Any string value up to 256 + # characters in length. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -436,22 +424,16 @@ module Google end # 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. If errors occur, - # error is set. - # 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. Failed resource totals are tracked in - # Operation.metadata. - # Error details are also logged to Cloud Logging - # (see [Viewing logs](/healthcare/docs/how-tos/logging)). + # store. The metadata field type is OperationMetadata. If the request is + # successful, the response field type is DeidentifyDicomStoreSummary. If errors + # occur, error is set. 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. Failed resource totals are tracked in + # Operation.metadata. Error details are also logged to Cloud Logging (see [ + # Viewing logs](/healthcare/docs/how-tos/logging)). # @param [String] source_store - # Source DICOM store resource name. For example, - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # dicomStores/`dicom_store_id``. + # Source DICOM store resource name. For example, `projects/`project_id`/ + # locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``. # @param [Google::Apis::HealthcareV1::DeidentifyDicomStoreRequest] deidentify_dicom_store_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -513,16 +495,13 @@ module Google execute_or_queue_command(command, &block) end - # 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 logs](/healthcare/docs/how-tos/logging). - # The metadata field type is + # 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 + # logs](/healthcare/docs/how-tos/logging). The metadata field type is # OperationMetadata. # @param [String] name - # The DICOM store resource name from which to export the data. For - # example, - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # 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``. # @param [Google::Apis::HealthcareV1::ExportDicomDataRequest] export_dicom_data_request_object # @param [String] fields @@ -584,22 +563,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. 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). + # Optional. 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). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -629,14 +605,11 @@ module Google end # Imports data into the DICOM store by copying it from the specified source. - # Errors are logged to Cloud Logging. For more information, see - # [Viewing logs](/healthcare/docs/how-tos/logging). The - # metadata field type is - # OperationMetadata. + # Errors are logged to Cloud Logging. For more information, see [Viewing logs](/ + # healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. # @param [String] 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`/ + # 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``. # @param [Google::Apis::HealthcareV1::ImportDicomDataRequest] import_dicom_data_request_object # @param [String] fields @@ -672,12 +645,12 @@ module Google # @param [String] parent # Name of the dataset. # @param [String] filter - # Restricts stores returned to those matching a filter. Syntax: - # https://cloud.google.com/appengine/docs/standard/python/search/query_strings - # Only filtering on labels is supported. For example, `labels.key=value`. + # Restricts stores returned to those matching a filter. Syntax: https://cloud. + # google.com/appengine/docs/standard/python/search/query_strings Only filtering + # on labels is supported. For example, `labels.key=value`. # @param [Fixnum] page_size - # Limit on the number of DICOM stores to return in a single response. - # If zero the default page size of 100 is used. + # Limit on the number of DICOM stores to return in a single response. If zero + # the default page size of 100 is used. # @param [String] page_token # The next_page_token value returned from the previous List request, if any. # @param [String] fields @@ -712,13 +685,11 @@ module Google # Updates the specified DICOM store. # @param [String] name - # Resource name of the DICOM store, of the form - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # dicomStores/`dicom_store_id``. + # Resource name of the DICOM store, of the form `projects/`project_id`/locations/ + # `location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``. # @param [Google::Apis::HealthcareV1::DicomStore] dicom_store_object # @param [String] update_mask - # The update mask applies to the resource. For the `FieldMask` definition, - # see + # The update mask applies to the resource. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# # fieldmask # @param [String] fields @@ -751,18 +722,17 @@ module Google execute_or_queue_command(command, &block) end - # SearchForInstances returns a list of matching instances. See - # [Search Transaction] - # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6) - # . + # SearchForInstances returns a list of matching instances. See [Search + # Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18. + # html#sect_10.6). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the SearchForInstancesRequest DICOMweb request. For example, - # `instances`, `series/`series_uid`/instances`, or - # `studies/`study_uid`/instances`. + # The path of the SearchForInstancesRequest DICOMweb request. For example, ` + # instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/instances` + # . # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -791,17 +761,15 @@ module Google execute_or_queue_command(command, &block) end - # SearchForSeries returns a list of matching series. See - # [Search Transaction] - # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6) - # . + # SearchForSeries returns a list of matching series. See [Search Transaction] ( + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the SearchForSeries DICOMweb request. For example, `series` or - # `studies/`study_uid`/series`. + # The path of the SearchForSeries DICOMweb request. For example, `series` or ` + # studies/`study_uid`/series`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -830,14 +798,12 @@ module Google execute_or_queue_command(command, &block) end - # SearchForStudies returns a list of matching studies. See - # [Search Transaction] - # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6) - # . + # SearchForStudies returns a list of matching studies. See [Search Transaction] ( + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path # The path of the SearchForStudies DICOMweb request. For example, `studies`. # @param [String] fields @@ -869,11 +835,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -905,17 +871,15 @@ module Google end # 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) - # . + # identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/ + # dicom/current/output/html/part18.html#sect_10.5). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the StoreInstances DICOMweb request. For example, - # `studies/[`study_uid`]`. Note that the `study_uid` is optional. + # The path of the StoreInstances DICOMweb request. For example, `studies/[` + # study_uid`]`. Note that the `study_uid` is optional. # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -947,15 +911,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -986,13 +949,12 @@ module Google execute_or_queue_command(command, &block) end - # DeleteStudy deletes all instances within the given study. Delete requests - # are equivalent to the GET requests specified in the Retrieve transaction. - # The method returns an Operation which - # will be marked successful when the deletion is complete. - # Warning: Inserting instances into a study while a delete operation is - # running for that study could result in the new instances not appearing in - # search results until the deletion operation finishes. + # DeleteStudy deletes all instances within the given study. Delete requests are + # equivalent to the GET requests specified in the Retrieve transaction. The + # method returns an Operation which will be marked successful when the deletion + # is complete. Warning: Inserting instances into a study while a delete + # operation is running for that study could result in the new instances not + # appearing in search results until the deletion operation finishes. # @param [String] parent # @param [String] dicom_web_path # The path of the DeleteStudy request. For example, `studies/`study_uid``. @@ -1025,17 +987,15 @@ module Google end # 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) - # . + # presented as metadata with the bulk data removed. See [RetrieveTransaction] ( + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveStudyMetadata DICOMweb request. For example, - # `studies/`study_uid`/metadata`. + # The path of the RetrieveStudyMetadata DICOMweb request. For example, `studies/` + # study_uid`/metadata`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1064,17 +1024,16 @@ module Google execute_or_queue_command(command, &block) end - # RetrieveStudy returns all instances within the given study. See - # [RetrieveTransaction] - # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4) - # . + # RetrieveStudy returns all instances within the given study. See [ + # RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/ + # part18.html#sect_10.4). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveStudy DICOMweb request. For example, - # `studies/`study_uid``. + # The path of the RetrieveStudy DICOMweb request. For example, `studies/` + # study_uid``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1103,18 +1062,17 @@ module Google execute_or_queue_command(command, &block) end - # SearchForInstances returns a list of matching instances. See - # [Search Transaction] - # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6) - # . + # SearchForInstances returns a list of matching instances. See [Search + # Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18. + # html#sect_10.6). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the SearchForInstancesRequest DICOMweb request. For example, - # `instances`, `series/`series_uid`/instances`, or - # `studies/`study_uid`/instances`. + # The path of the SearchForInstancesRequest DICOMweb request. For example, ` + # instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/instances` + # . # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1143,17 +1101,15 @@ module Google execute_or_queue_command(command, &block) end - # SearchForSeries returns a list of matching series. See - # [Search Transaction] - # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6) - # . + # SearchForSeries returns a list of matching series. See [Search Transaction] ( + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the SearchForSeries DICOMweb request. For example, `series` or - # `studies/`study_uid`/series`. + # The path of the SearchForSeries DICOMweb request. For example, `series` or ` + # studies/`study_uid`/series`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1183,17 +1139,15 @@ module Google end # 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) - # . + # identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/ + # dicom/current/output/html/part18.html#sect_10.5). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the StoreInstances DICOMweb request. For example, - # `studies/[`study_uid`]`. Note that the `study_uid` is optional. + # The path of the StoreInstances DICOMweb request. For example, `studies/[` + # study_uid`]`. Note that the `study_uid` is optional. # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1225,21 +1179,20 @@ module Google execute_or_queue_command(command, &block) end - # DeleteSeries deletes all instances within the given study and series. - # Delete requests are equivalent to the GET requests specified in the - # Retrieve transaction. - # The method returns an Operation which - # will be marked successful when the deletion is complete. - # Warning: Inserting instances into a series while a delete operation is - # running for that series could result in the new instances not appearing in - # search results until the deletion operation finishes. + # DeleteSeries deletes all instances within the given study and series. Delete + # requests are equivalent to the GET requests specified in the Retrieve + # transaction. The method returns an Operation which will be marked successful + # when the deletion is complete. Warning: Inserting instances into a series + # while a delete operation is running for that series could result in the new + # instances not appearing in search results until the deletion operation + # finishes. # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the DeleteSeries request. For example, - # `studies/`study_uid`/series/`series_uid``. + # The path of the DeleteSeries request. For example, `studies/`study_uid`/series/ + # `series_uid``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1269,17 +1222,16 @@ module Google end # 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) - # . + # 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). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveSeriesMetadata DICOMweb request. For example, - # `studies/`study_uid`/series/`series_uid`/metadata`. + # The path of the RetrieveSeriesMetadata DICOMweb request. For example, `studies/ + # `study_uid`/series/`series_uid`/metadata`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1308,17 +1260,16 @@ module Google execute_or_queue_command(command, &block) end - # 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) - # . + # 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). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveSeries DICOMweb request. For example, - # `studies/`study_uid`/series/`series_uid``. + # The path of the RetrieveSeries DICOMweb request. For example, `studies/` + # study_uid`/series/`series_uid``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1347,18 +1298,17 @@ module Google execute_or_queue_command(command, &block) end - # SearchForInstances returns a list of matching instances. See - # [Search Transaction] - # (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6) - # . + # SearchForInstances returns a list of matching instances. See [Search + # Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18. + # html#sect_10.6). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the SearchForInstancesRequest DICOMweb request. For example, - # `instances`, `series/`series_uid`/instances`, or - # `studies/`study_uid`/instances`. + # The path of the SearchForInstancesRequest DICOMweb request. For example, ` + # instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/instances` + # . # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1389,16 +1339,16 @@ module Google # 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. + # 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. # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the DeleteInstance request. For example, - # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid``. + # The path of the DeleteInstance request. For example, `studies/`study_uid`/ + # series/`series_uid`/instances/`instance_uid``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1427,18 +1377,16 @@ module Google execute_or_queue_command(command, &block) end - # 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) - # . + # 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). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveInstance DICOMweb request. For example, - # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid``. + # The path of the RetrieveInstance DICOMweb request. For example, `studies/` + # study_uid`/series/`series_uid`/instances/`instance_uid``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1468,18 +1416,16 @@ module Google end # 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) - # . + # 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). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveInstanceMetadata DICOMweb request. For example, - # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/metadata`. + # The path of the RetrieveInstanceMetadata DICOMweb request. For example, ` + # studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/metadata`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1509,17 +1455,16 @@ module Google end # 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) - # . + # 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). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveRenderedInstance DICOMweb request. For example, - # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/rendered`. + # The path of the RetrieveRenderedInstance DICOMweb request. For example, ` + # studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/rendered`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1548,19 +1493,16 @@ module Google execute_or_queue_command(command, &block) end - # 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` - # . + # 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`. # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveFrames DICOMweb request. For example, - # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/frames/` - # frame_list``. + # The path of the RetrieveFrames DICOMweb request. For example, `studies/` + # study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`frame_list``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1591,18 +1533,16 @@ module Google # 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) - # . + # Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/ + # output/html/part18.html#sect_10.4). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveRenderedFrames DICOMweb request. For example, - # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/frames/` - # frame_list`/rendered`. + # The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/ + # `study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`frame_list`/ + # rendered`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1636,8 +1576,8 @@ module Google # The name of the dataset this FHIR store belongs to. # @param [Google::Apis::HealthcareV1::FhirStore] fhir_store_object # @param [String] fhir_store_id - # The ID of the FHIR store that is being created. - # The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``. + # The ID of the FHIR store that is being created. The string must match the + # following regex: `[\p`L`\p`N`_\-\.]`1,256``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1669,18 +1609,13 @@ module Google end # 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. If errors occur, - # error is set. - # Error details are also logged to Cloud Logging - # (see [Viewing logs](/healthcare/docs/how-tos/logging)). + # store. The metadata field type is OperationMetadata. If the request is + # successful, the response field type is DeidentifyFhirStoreSummary. If errors + # occur, error is set. Error details are also logged to Cloud Logging (see [ + # Viewing logs](/healthcare/docs/how-tos/logging)). # @param [String] source_store - # Source FHIR store resource name. For example, - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # fhirStores/`fhir_store_id``. + # Source FHIR store resource name. For example, `projects/`project_id`/locations/ + # `location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. # @param [Google::Apis::HealthcareV1::DeidentifyFhirStoreRequest] deidentify_fhir_store_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1741,23 +1676,17 @@ module Google execute_or_queue_command(command, &block) end - # 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 - # logs](/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. + # 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 logs](/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. # @param [String] 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``. + # 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``. # @param [Google::Apis::HealthcareV1::ExportResourcesRequest] export_resources_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1818,22 +1747,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. 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). + # Optional. 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). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1862,74 +1788,58 @@ module Google execute_or_queue_command(command, &block) end - # Imports 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. - # 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's 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 is specified by the parameters - # below. 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 - # logs](/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. + # Imports 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. 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's 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 is 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 logs](/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. # @param [String] 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``. + # 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``. # @param [Google::Apis::HealthcareV1::ImportResourcesRequest] import_resources_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1964,12 +1874,12 @@ module Google # @param [String] parent # Name of the dataset. # @param [String] filter - # Restricts stores returned to those matching a filter. Syntax: - # https://cloud.google.com/appengine/docs/standard/python/search/query_strings - # Only filtering on labels is supported, for example `labels.key=value`. + # Restricts stores returned to those matching a filter. Syntax: https://cloud. + # google.com/appengine/docs/standard/python/search/query_strings Only filtering + # on labels is supported, for example `labels.key=value`. # @param [Fixnum] page_size - # Limit on the number of FHIR stores to return in a single response. If zero - # the default page size of 100 is used. + # Limit on the number of FHIR stores to return in a single response. If zero the + # default page size of 100 is used. # @param [String] page_token # The next_page_token value returned from the previous List request, if any. # @param [String] fields @@ -2004,12 +1914,11 @@ module Google # Updates the configuration of the specified FHIR store. # @param [String] name - # Output only. Resource name of the FHIR store, of the form - # `projects/`project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. + # Output only. Resource name of the FHIR store, of the form `projects/` + # project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. # @param [Google::Apis::HealthcareV1::FhirStore] fhir_store_object # @param [String] update_mask - # The update mask applies to the resource. For the `FieldMask` definition, - # see + # The update mask applies to the resource. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# # fieldmask # @param [String] fields @@ -2043,11 +1952,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2078,15 +1987,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2117,60 +2025,52 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves a Patient resource and resources related to that patient. - # Implements the FHIR extended operation Patient-everything - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html# - # everything), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html# - # everything), - # [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html# - # everything)). - # On success, the response body will contain a JSON-encoded representation - # of a `Bundle` resource of type `searchset`, containing the results of the - # operation. - # Errors generated by the FHIR store will 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](http://hl7.org/fhir/DSTU2/compartment-patient.html), - # [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), - # [R4](http://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# + # Retrieves a Patient resource and resources related to that patient. Implements + # the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/ + # implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3]( + # http://hl7.org/implement/standards/fhir/STU3/patient-operations.html# + # everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient- + # operations.html#everything)). On success, the response body will contain a + # JSON-encoded representation of a `Bundle` resource of type `searchset`, + # containing the results of the operation. Errors generated by the FHIR store + # will 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](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www. + # hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://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_compartment_resources). # @param [String] name # Name of the `Patient` resource for which the information is required. # @param [Fixnum] _count # Maximum number of resources in a page. Defaults to 100. # @param [String] _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. + # 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. # @param [String] _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. + # 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. # @param [String] _type - # String of comma-delimited FHIR resource types. If provided, only resources - # of the specified resource type(s) are returned. + # String of comma-delimited FHIR resource types. If provided, only resources of + # the specified resource type(s) are returned. # @param [String] 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. # @param [String] 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. + # 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. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2206,12 +2106,10 @@ module Google # 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). + # 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). # @param [String] name # The name of the resource to purge. # @param [String] fields @@ -2241,22 +2139,17 @@ module Google execute_or_queue_command(command, &block) end - # Gets the FHIR capability statement - # ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), - # or the [conformance - # statement](http://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](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), - # or the [conformance + # Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/ + # fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/ + # fhir/R4/capabilitystatement.html)), or the [conformance statement](http://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](http://hl7.org/ + # implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/ + # implement/standards/fhir/R4/http.html#capabilities)), or the [conformance # interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html# - # conformance) - # in the DSTU2 case. - # On success, the response body will contain a JSON-encoded representation - # of a `CapabilityStatement` resource. + # conformance) in the DSTU2 case. On success, the response body will contain a + # JSON-encoded representation of a `CapabilityStatement` resource. # @param [String] name # Name of the FHIR store to retrieve the capabilities for. # @param [String] fields @@ -2286,33 +2179,29 @@ module Google execute_or_queue_command(command, &block) end - # Creates a FHIR resource. - # Implements the FHIR standard create interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#create)), - # which creates a new resource with a server-assigned resource ID. - # 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 will contain 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 will 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 + # Creates a FHIR resource. Implements the FHIR standard create interaction ([ + # DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3]( + # http://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](http:// + # hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new + # resource with a server-assigned resource ID. 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 will contain 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 will 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). # @param [String] parent # The name of the FHIR store this resource belongs to. # @param [String] type # The FHIR resource type to create, such as Patient or Observation. For a - # complete list, see the FHIR Resource Index - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). - # Must match the resource type in the provided content. + # complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/ + # standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/ + # standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/ + # standards/fhir/R4/resourcelist.html)). Must match the resource type in the + # provided content. # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2344,20 +2233,16 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a FHIR resource. - # Implements the FHIR standard delete interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#delete), - # [R4](http://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 will be 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). + # Deletes a FHIR resource. Implements the FHIR standard delete interaction ([ + # DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), [STU3]( + # http://hl7.org/implement/standards/fhir/STU3/http.html#delete), [R4](http:// + # 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 will be 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). # @param [String] name # The name of the resource to delete. # @param [String] fields @@ -2387,34 +2272,30 @@ module Google execute_or_queue_command(command, &block) end - # Executes all the requests in the given Bundle. - # Implements the FHIR standard batch/transaction interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction), - # [R4](http://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](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#brules)) - # and transaction processing rules - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), - # [R4](http://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 will - # contain 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 will 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 `executeBundle`, see - # [Managing FHIR resources using FHIR - # bundles](/healthcare/docs/how-tos/fhir-bundles). + # Executes all the requests in the given Bundle. Implements the FHIR standard + # batch/transaction interaction ([DSTU2](http://hl7.org/implement/standards/fhir/ + # DSTU2/http.html#transaction), [STU3](http://hl7.org/implement/standards/fhir/ + # STU3/http.html#transaction), [R4](http://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](http://hl7. + # org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](http://hl7. + # org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](http://hl7.org/ + # implement/standards/fhir/R4/http.html#brules)) and transaction processing + # rules ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0. + # 16.2), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17. + # 2), [R4](http://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 will contain 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 will 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 `executeBundle`, see [Managing FHIR + # resources using FHIR bundles](/healthcare/docs/how-tos/fhir-bundles). # @param [String] parent # Name of the FHIR store in which this bundle will be executed. # @param [Google::Apis::HealthcareV1::HttpBody] http_body_object @@ -2448,48 +2329,40 @@ module Google end # 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](http://hl7.org/implement/standards/fhir/DSTU2/http.html#history), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#history), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#history)). - # On success, the response body will contain 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 will 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# + # deleted versions) from the FHIR store. Implements the per-resource form of the + # FHIR standard history interaction ([DSTU2](http://hl7.org/implement/standards/ + # fhir/DSTU2/http.html#history), [STU3](http://hl7.org/implement/standards/fhir/ + # STU3/http.html#history), [R4](http://hl7.org/implement/standards/fhir/R4/http. + # html#history)). On success, the response body will contain 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 will 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_versions). # @param [String] name # The name of the resource to retrieve. # @param [String] _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` + # 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` # @param [Fixnum] _count # The maximum number of search results on a page. Defaults to 1000. # @param [String] _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. + # 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. # @param [String] _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. + # 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. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2521,23 +2394,19 @@ module Google execute_or_queue_command(command, &block) end - # 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](http://hl7.org/implement/standards/fhir/STU3/http.html#patch), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#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](http://hl7.org/implement/standards/fhir/STU3/http. + # html#patch), [R4](http://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 will contain a JSON-encoded representation - # of the updated resource, including the server-assigned version ID. - # Errors generated by the FHIR store will 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 + # 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 will contain a JSON-encoded representation of + # the updated resource, including the server-assigned version ID. Errors + # generated by the FHIR store will 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). # @param [String] name # The name of the resource to update. @@ -2571,26 +2440,22 @@ module Google execute_or_queue_command(command, &block) end - # Gets the contents of a FHIR resource. - # Implements the FHIR standard read interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#read), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#read), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#read)). - # Also supports the FHIR standard conditional read interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#cread), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cread), - # [R4](http://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 will contain a JSON-encoded representation - # of the resource. - # Errors generated by the FHIR store will 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). + # Gets the contents of a FHIR resource. Implements the FHIR standard read + # interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html# + # read), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#read), [ + # R4](http://hl7.org/implement/standards/fhir/R4/http.html#read)). Also supports + # the FHIR standard conditional read interaction ([DSTU2](http://hl7.org/ + # implement/standards/fhir/DSTU2/http.html#cread), [STU3](http://hl7.org/ + # implement/standards/fhir/STU3/http.html#cread), [R4](http://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 will contain a JSON-encoded + # representation of the resource. Errors generated by the FHIR store will + # 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). # @param [String] name # The name of the resource to retrieve. # @param [String] fields @@ -2620,59 +2485,46 @@ module Google execute_or_queue_command(command, &block) end - # Searches for resources in the given FHIR store according to criteria - # specified as query parameters. - # Implements the FHIR standard search interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) - # using the search semantics described in the FHIR Search specification - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), - # [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). - # Supports three 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]/[type]/_search?[parameters]` as an alternate form having - # the same semantics as the `GET` method. - # The `GET` methods do not support compartment searches. The `POST` method - # does not support `application/x-www-form-urlencoded` search parameters. - # On success, the response body will contain a JSON-encoded representation - # of a `Bundle` resource of type `searchset`, containing the results of the - # search. - # Errors generated by the FHIR store will 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](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry. - # html), - # [R4](http://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` will contain - # 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. + # Searches for resources in the given FHIR store according to criteria specified + # as query parameters. Implements the FHIR standard search interaction ([DSTU2]( + # http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http:// + # hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/ + # implement/standards/fhir/R4/http.html#search)) using the search semantics + # described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/ + # standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/ + # fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search. + # html)). Supports three 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]/[type]/ + # _search?[parameters]` as an alternate form having the same semantics as the ` + # GET` method. The `GET` methods do not support compartment searches. The `POST` + # method does not support `application/x-www-form-urlencoded` search parameters. + # On success, the response body will contain a JSON-encoded representation of a ` + # Bundle` resource of type `searchset`, containing the results of the search. + # Errors generated by the FHIR store will 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](http://hl7.org/ + # implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://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` will contain 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). + # 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). # @param [String] parent # Name of the FHIR store to retrieve resources from. # @param [Google::Apis::HealthcareV1::SearchResourcesRequest] search_resources_request_object @@ -2705,27 +2557,21 @@ module Google execute_or_queue_command(command, &block) end - # Updates the entire contents of a resource. - # Implements the FHIR standard update interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#update), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update), - # [R4](http://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. - # 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 will contain a JSON-encoded representation - # of the updated resource, including the server-assigned version ID. - # Errors generated by the FHIR store will 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 + # Updates the entire contents of a resource. Implements the FHIR standard update + # interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html# + # update), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update), + # [R4](http://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. 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 will contain a JSON-encoded representation of + # the updated resource, including the server-assigned version ID. Errors + # generated by the FHIR store will 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). # @param [String] name # The name of the resource to update. @@ -2759,22 +2605,17 @@ module Google execute_or_queue_command(command, &block) end - # Gets the contents of a version (current or historical) of a FHIR resource - # by version ID. - # Implements the FHIR standard vread interaction - # ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), - # [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#vread), - # [R4](http://hl7.org/implement/standards/fhir/R4/http.html#vread)). - # On success, the response body will contain a JSON-encoded representation - # of the resource. - # Errors generated by the FHIR store will 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_version). + # Gets the contents of a version (current or historical) of a FHIR resource by + # version ID. Implements the FHIR standard vread interaction ([DSTU2](http://hl7. + # org/implement/standards/fhir/DSTU2/http.html#vread), [STU3](http://hl7.org/ + # implement/standards/fhir/STU3/http.html#vread), [R4](http://hl7.org/implement/ + # standards/fhir/R4/http.html#vread)). On success, the response body will + # contain a JSON-encoded representation of the resource. Errors generated by the + # FHIR store will 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_version). # @param [String] name # The name of the resource version to retrieve. # @param [String] fields @@ -2809,8 +2650,8 @@ module Google # The name of the dataset this HL7v2 store belongs to. # @param [Google::Apis::HealthcareV1::Hl7V2Store] hl7_v2_store_object # @param [String] hl7_v2_store_id - # The ID of the HL7v2 store that is being created. - # The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``. + # The ID of the HL7v2 store that is being created. The string must match the + # following regex: `[\p`L`\p`N`_\-\.]`1,256``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2841,8 +2682,7 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified HL7v2 store and removes all messages that it - # contains. + # Deletes the specified HL7v2 store and removes all messages that it contains. # @param [String] name # The resource name of the HL7v2 store to delete. # @param [String] fields @@ -2902,22 +2742,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. 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). + # Optional. 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). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2950,12 +2787,12 @@ module Google # @param [String] parent # Name of the dataset. # @param [String] filter - # Restricts stores returned to those matching a filter. Syntax: - # https://cloud.google.com/appengine/docs/standard/python/search/query_strings - # Only filtering on labels is supported. For example, `labels.key=value`. + # Restricts stores returned to those matching a filter. Syntax: https://cloud. + # google.com/appengine/docs/standard/python/search/query_strings Only filtering + # on labels is supported. For example, `labels.key=value`. # @param [Fixnum] page_size - # Limit on the number of HL7v2 stores to return in a single response. - # If zero the default page size of 100 is used. + # Limit on the number of HL7v2 stores to return in a single response. If zero + # the default page size of 100 is used. # @param [String] page_token # The next_page_token value returned from the previous List request, if any. # @param [String] fields @@ -2990,12 +2827,11 @@ module Google # Updates the HL7v2 store. # @param [String] name - # Resource name of the HL7v2 store, of the form - # `projects/`project_id`/datasets/`dataset_id`/hl7V2Stores/`hl7v2_store_id``. + # Resource name of the HL7v2 store, of the form `projects/`project_id`/datasets/` + # dataset_id`/hl7V2Stores/`hl7v2_store_id``. # @param [Google::Apis::HealthcareV1::Hl7V2Store] hl7_v2_store_object # @param [String] update_mask - # The update mask applies to the resource. For the `FieldMask` definition, - # see + # The update mask applies to the resource. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# # fieldmask # @param [String] fields @@ -3029,11 +2865,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3064,15 +2900,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3104,11 +2939,10 @@ module Google end # Parses and stores an HL7v2 message. This method triggers an asynchronous - # notification to any Cloud Pub/Sub topic configured in - # projects.locations.datasets.hl7V2Stores.Hl7V2NotificationConfig, if the - # filtering matches the message. If an MLLP adapter is configured to listen - # to a Cloud Pub/Sub topic, the adapter transmits the message when a - # notification is received. + # notification to any Cloud Pub/Sub topic configured in projects.locations. + # datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the + # message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic, + # the adapter transmits the message when a notification is received. # @param [String] parent # The name of the dataset this message belongs to. # @param [Google::Apis::HealthcareV1::CreateMessageRequest] create_message_request_object @@ -3175,8 +3009,8 @@ module Google # @param [String] name # The resource name of the HL7v2 message to retrieve. # @param [String] view - # Specifies which parts of the Message resource to return in the response. - # When unspecified, equivalent to FULL. + # Specifies which parts of the Message resource to return in the response. When + # unspecified, equivalent to FULL. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3206,14 +3040,14 @@ module Google end # Parses and stores an HL7v2 message. This method triggers an asynchronous - # notification to any Cloud Pub/Sub topic configured in - # projects.locations.datasets.hl7V2Stores.Hl7V2NotificationConfig, if the - # filtering matches the message. If an MLLP adapter is configured to listen - # to a Cloud Pub/Sub topic, the adapter transmits the message when a - # notification is received. This method also generates a response - # containing an HL7v2 acknowledgement (`ACK`) message when successful or a - # negative acknowledgement (`NACK`) message in case of error, suitable for - # replying to HL7v2 interface systems that expect these acknowledgements. + # notification to any Cloud Pub/Sub topic configured in projects.locations. + # datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the + # message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic, + # the adapter transmits the message when a notification is received. This method + # also generates a response containing an HL7v2 acknowledgement (`ACK`) message + # when successful or a negative acknowledgement (`NACK`) message in case of + # error, suitable for replying to HL7v2 interface systems that expect these + # acknowledgements. # @param [String] parent # The name of the HL7v2 store this message belongs to. # @param [Google::Apis::HealthcareV1::IngestMessageRequest] ingest_message_request_object @@ -3248,46 +3082,41 @@ module Google # 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. + # delay between the time a message is created and when it can be found through a + # filter. # @param [String] parent # Name of the HL7v2 store to retrieve messages from. # @param [String] filter - # Restricts messages returned to those matching a filter. Syntax: - # https://cloud.google.com/appengine/docs/standard/python/search/query_strings - # 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"`. - # * `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":*`. + # Restricts messages returned to those matching a filter. Syntax: https://cloud. + # google.com/appengine/docs/standard/python/search/query_strings 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"`. * `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":*`. # @param [String] order_by - # 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` + # 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` # @param [Fixnum] page_size - # Limit on the number of messages to return in a single response. - # If zero the default page size of 100 is used. + # Limit on the number of messages to return in a single response. If zero the + # default page size of 100 is used. # @param [String] page_token # The next_page_token value returned from the previous List request, if any. # @param [String] 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. + # 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. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3320,21 +3149,18 @@ module Google execute_or_queue_command(command, &block) end - # Update the message. - # The contents of the message in Message.data and data extracted from - # the contents such as Message.create_time cannot 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. + # Update the message. The contents of the message in Message.data and data + # extracted from the contents such as Message.create_time cannot 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. # @param [String] 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. + # 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. # @param [Google::Apis::HealthcareV1::Message] message_object # @param [String] update_mask - # The update mask applies to the resource. For the `FieldMask` definition, - # see + # The update mask applies to the resource. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# # fieldmask # @param [String] fields @@ -3367,15 +3193,13 @@ module Google execute_or_queue_command(command, &block) end - # 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, + # 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`. # @param [String] name # The name of the operation resource to be cancelled. @@ -3409,9 +3233,8 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] name # The name of the operation resource. # @param [String] fields @@ -3441,15 +3264,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] name # The name of the operation's parent resource. # @param [String] filter diff --git a/generated/google/apis/healthcare_v1beta1.rb b/generated/google/apis/healthcare_v1beta1.rb index cdacd1b8c..0719e02ab 100644 --- a/generated/google/apis/healthcare_v1beta1.rb +++ b/generated/google/apis/healthcare_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/healthcare module HealthcareV1beta1 VERSION = 'V1beta1' - REVISION = '20200813' + REVISION = '20200819' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1beta1/classes.rb b/generated/google/apis/healthcare_v1beta1/classes.rb index 32beaac4a..da15e4222 100644 --- a/generated/google/apis/healthcare_v1beta1/classes.rb +++ b/generated/google/apis/healthcare_v1beta1/classes.rb @@ -42,9 +42,9 @@ module Google # @return [Google::Apis::HealthcareV1beta1::ImageAnnotation] attr_accessor :image_annotation - # Resource name of the Annotation, of the form - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # annotationStores/`annotation_store_id`/annotations/`annotation_id``. + # Resource name of the Annotation, of the form `projects/`project_id`/locations/` + # location_id`/datasets/`dataset_id`/annotationStores/`annotation_store_id`/ + # annotations/`annotation_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -78,24 +78,19 @@ module Google class AnnotationConfig include Google::Apis::Core::Hashable - # The name of the annotation store, in the form - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # annotationStores/`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. + # The name of the annotation store, in the form `projects/`project_id`/locations/ + # `location_id`/datasets/`dataset_id`/annotationStores/`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. # Corresponds to the JSON property `annotationStoreName` # @return [String] attr_accessor :annotation_store_name - # If set to true, the sensitive texts are included in - # SensitiveTextAnnotation - # of Annotation. + # If set to true, the sensitive texts are included in SensitiveTextAnnotation of + # Annotation. # Corresponds to the JSON property `storeQuote` # @return [Boolean] attr_accessor :store_quote @@ -131,27 +126,25 @@ module Google end end - # An Annotation store that can store annotation resources such as - # labels and tags for text, image and audio. + # An Annotation store that can store annotation resources such as labels and + # tags for text, image and audio. class AnnotationStore include Google::Apis::Core::Hashable # 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. + # 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. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Resource name of the Annotation store, of the form - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # annotationStores/`annotation_store_id``. + # Resource name of the Annotation store, of the form `projects/`project_id`/ + # locations/`location_id`/datasets/`dataset_id`/annotationStores/` + # annotation_store_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -167,53 +160,21 @@ module Google end end - # 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. + # 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. class AuditConfig include Google::Apis::Core::Hashable @@ -222,9 +183,9 @@ module Google # @return [Array] attr_accessor :audit_log_configs - # 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. + # 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. # Corresponds to the JSON property `service` # @return [String] attr_accessor :service @@ -240,28 +201,15 @@ module Google end end - # 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. + # 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. class AuditLogConfig include Google::Apis::Core::Hashable - # Specifies the identities that do not cause logging for this type of - # permission. + # Specifies the identities that do not cause logging for this type of permission. # Follows the same format of Binding.members. # Corresponds to the JSON property `exemptedMembers` # @return [Array] @@ -287,69 +235,57 @@ module Google class Binding include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `condition` # @return [Google::Apis::HealthcareV1beta1::Expr] attr_accessor :condition - # 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`. + # 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`. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members - # Role that is assigned to `members`. - # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor` + # , or `roles/owner`. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -446,10 +382,8 @@ module Google class CreateMessageRequest include Google::Apis::Core::Hashable - # A complete HL7v2 message. - # See [Introduction to HL7 Standards] - # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for - # details on the standard. + # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7. + # org/implement/standards/index.cfm?ref=common) for details on the standard. # Corresponds to the JSON property `message` # @return [Google::Apis::HealthcareV1beta1::Message] attr_accessor :message @@ -465,15 +399,14 @@ module Google end # Pseudonymization method that generates surrogates via cryptographic hashing. - # Uses SHA-256. - # Outputs a base64-encoded representation of the hashed output. + # Uses SHA-256. Outputs a base64-encoded representation of the hashed output. # For example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`. class CryptoHashConfig include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `cryptoKey` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -489,23 +422,23 @@ module Google end end - # 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. + # 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. class Dataset include Google::Apis::Core::Hashable - # Resource name of the dataset, of the form - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # Resource name of the dataset, of the form `projects/`project_id`/locations/` + # location_id`/datasets/`dataset_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # 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. + # 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. # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone @@ -526,9 +459,9 @@ module Google class DateShiftConfig include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `cryptoKey` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -544,10 +477,9 @@ module Google end end - # 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. + # 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. class DeidentifyConfig include Google::Apis::Core::Hashable @@ -595,19 +527,17 @@ module Google class DeidentifyDatasetRequest include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `config` # @return [Google::Apis::HealthcareV1beta1::DeidentifyConfig] attr_accessor :config - # 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 project and location as the - # source dataset. De-identifying data across multiple projects or locations - # is not supported. + # 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 project and location as the source dataset. De-identifying data + # across multiple projects or locations is not supported. # Corresponds to the JSON property `destinationDataset` # @return [String] attr_accessor :destination_dataset @@ -627,24 +557,20 @@ module Google class DeidentifyDicomStoreRequest include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `config` # @return [Google::Apis::HealthcareV1beta1::DeidentifyConfig] attr_accessor :config - # 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`/ - # dicomStores/`dicom_store_id``. - # * The destination dataset must exist. - # * The source dataset and destination dataset must both reside in the same - # project. De-identifying data across multiple projects is not supported. - # * The destination DICOM store must not exist. - # * The caller must have the necessary permissions to create the destination - # DICOM store. + # 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`/ + # dicomStores/`dicom_store_id``. * The destination dataset must exist. * The + # source dataset and destination dataset must both reside in the same project. + # De-identifying data across multiple projects is not supported. * The + # destination DICOM store must not exist. * The caller must have the necessary + # permissions to create the destination DICOM store. # Corresponds to the JSON property `destinationStore` # @return [String] attr_accessor :destination_store @@ -666,7 +592,7 @@ module Google end end - # Contains the status of the Deidentify operation. + # Deprecated. Contains the status of the Deidentify operation. class DeidentifyErrorDetails include Google::Apis::Core::Hashable @@ -707,24 +633,20 @@ module Google class DeidentifyFhirStoreRequest include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `config` # @return [Google::Apis::HealthcareV1beta1::DeidentifyConfig] attr_accessor :config - # 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`/ - # fhirStores/`fhir_store_id``. - # * The destination dataset must exist. - # * The source dataset and destination dataset must both reside in the same - # project. De-identifying data across multiple projects 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. + # 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`/ + # fhirStores/`fhir_store_id``. * The destination dataset must exist. * The + # source dataset and destination dataset must both reside in the same project. + # De-identifying data across multiple projects 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. # Corresponds to the JSON property `destinationStore` # @return [String] attr_accessor :destination_store @@ -750,10 +672,8 @@ module Google class DeidentifySummary include Google::Apis::Core::Hashable - # Number of resources that failed to process. - # The failures might be caused by: - # * Invalid user input data - # * Transient errors that could be skipped + # Number of resources that failed to process. The failures might be caused by: * + # Invalid user input data * Transient errors that could be skipped # Corresponds to the JSON property `failureResourceCount` # @return [Fixnum] attr_accessor :failure_resource_count @@ -818,14 +738,13 @@ module Google # @return [Google::Apis::HealthcareV1beta1::TagFilterList] attr_accessor :remove_list - # 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. + # 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 # Corresponds to the JSON property `skipIdRedaction` # @return [Boolean] @@ -849,15 +768,13 @@ module Google class DicomFilterConfig include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `resourcePathsGcsUri` # @return [String] attr_accessor :resource_paths_gcs_uri @@ -876,22 +793,19 @@ module Google class DicomStore include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Resource name of the DICOM store, of the form - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # dicomStores/`dicom_store_id``. + # Resource name of the DICOM store, of the form `projects/`project_id`/locations/ + # `location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -902,12 +816,11 @@ module Google attr_accessor :notification_config # 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. + # 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. # Corresponds to the JSON property `streamConfigs` # @return [Array] attr_accessor :stream_configs @@ -925,13 +838,11 @@ module Google end end - # 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 ````. + # 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 ````. class Empty include Google::Apis::Core::Hashable @@ -945,17 +856,17 @@ module Google end # Structure to describe the error encountered during batch operation on one - # resource. This is used both for sample errors in operation response, and - # for format of errors in error reports. + # resource. This is used both for sample errors in operation response, and for + # format of errors in error reports. class ErrorDetail include Google::Apis::Core::Hashable - # 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). + # 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). # Corresponds to the JSON property `error` # @return [Google::Apis::HealthcareV1beta1::Status] attr_accessor :error @@ -976,8 +887,8 @@ module Google end end - # Request to evaluate an Annotation store against a - # ground truth [Annotation store]. + # Request to evaluate an Annotation store against a ground truth [Annotation + # store]. class EvaluateAnnotationStoreRequest include Google::Apis::Core::Hashable @@ -987,43 +898,43 @@ module Google attr_accessor :bigquery_destination # 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" - # ``` + # 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. # Corresponds to the JSON property `evalInfoTypeMapping` # @return [Hash] attr_accessor :eval_info_type_mapping - # Optional. Similar to `eval_info_type_mapping`, infoType mapping for - # `golden_store`. + # Optional. Similar to `eval_info_type_mapping`, infoType mapping for ` + # golden_store`. # Corresponds to the JSON property `goldenInfoTypeMapping` # @return [Hash] attr_accessor :golden_info_type_mapping - # The Annotation store to use as ground truth, in the format of - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # annotationStores/`annotation_store_id``. + # The Annotation store to use as ground truth, in the format of `projects/` + # project_id`/locations/`location_id`/datasets/`dataset_id`/annotationStores/` + # annotation_store_id``. # Corresponds to the JSON property `goldenStore` # @return [String] attr_accessor :golden_store - # Specifies how to use infoTypes for evaluation. For example, a user might - # only want to evaluate `PERSON`, `LOCATION`, and `AGE`. + # Specifies how to use infoTypes for evaluation. For example, a user might only + # want to evaluate `PERSON`, `LOCATION`, and `AGE`. # Corresponds to the JSON property `infoTypeConfig` # @return [Google::Apis::HealthcareV1beta1::InfoTypeConfig] attr_accessor :info_type_config + # 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``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + def initialize(**args) update!(**args) end @@ -1035,41 +946,38 @@ module Google @golden_info_type_mapping = args[:golden_info_type_mapping] if args.key?(:golden_info_type_mapping) @golden_store = args[:golden_store] if args.key?(:golden_store) @info_type_config = args[:info_type_config] if args.key?(:info_type_config) + @name = args[:name] if args.key?(:name) end end - # Response for successful Annotation store evaluation operations. This - # structure is included in the - # response upon operation completion. + # Response for successful Annotation store evaluation operations. This structure + # is included in the response upon operation completion. class EvaluateAnnotationStoreResponse include Google::Apis::Core::Hashable - # The evaluated Annotation store, in the format of - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # annotationStores/`annotation_store_id``. + # The evaluated Annotation store, in the format of `projects/`project_id`/ + # locations/`location_id`/datasets/`dataset_id`/annotationStores/` + # annotation_store_id``. # Corresponds to the JSON property `evalStore` # @return [String] attr_accessor :eval_store - # The number of Annotations in the ground - # truth Annotation store successfully + # The number of Annotations in the ground truth Annotation store successfully # processed. # Corresponds to the JSON property `goldenCount` # @return [Fixnum] attr_accessor :golden_count - # The ground truth Annotation store, in the format of - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # annotationStores/`annotation_store_id``. + # The ground truth Annotation store, in the format of `projects/`project_id`/ + # locations/`location_id`/datasets/`dataset_id`/annotationStores/` + # annotation_store_id``. # Corresponds to the JSON property `goldenStore` # @return [String] attr_accessor :golden_store - # The number of Annotations - # in the eval store that match with corresponding annotations - # in the ground truth Annotation store. Two matched - # annotations both annotate the same resource defined in - # AnnotationSource. + # The number of Annotations in the eval store that match with corresponding + # annotations in the ground truth Annotation store. Two matched annotations both + # annotate the same resource defined in AnnotationSource. # Corresponds to the JSON property `matchedCount` # @return [Fixnum] attr_accessor :matched_count @@ -1087,15 +995,14 @@ module Google end end - # Response for failed annotation export operations. This structure - # is included in error - # details upon operation completion. + # Deprecated. Response for failed annotation export operations. This structure + # is included in error details upon operation completion. class ExportAnnotationsErrorDetails include Google::Apis::Core::Hashable - # The annotation_store used for the export operation, in the format of - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # annotationStores/`annotation_store_id``. + # The annotation_store used for the export operation, in the format of `projects/ + # `project_id`/locations/`location_id`/datasets/`dataset_id`/annotationStores/` + # annotation_store_id``. # Corresponds to the JSON property `annotationStore` # @return [String] attr_accessor :annotation_store @@ -1122,9 +1029,7 @@ module Google end end - # Request to export - # Annotations. The - # export operation is not atomic. If a + # Request to export Annotations. The export operation is not atomic. If a # failure occurs, any annotations already exported are not removed. class ExportAnnotationsRequest include Google::Apis::Core::Hashable @@ -1139,6 +1044,13 @@ module Google # @return [Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1AnnotationGcsDestination] attr_accessor :gcs_destination + # 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``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + def initialize(**args) update!(**args) end @@ -1147,19 +1059,18 @@ module Google def update!(**args) @bigquery_destination = args[:bigquery_destination] if args.key?(:bigquery_destination) @gcs_destination = args[:gcs_destination] if args.key?(:gcs_destination) + @name = args[:name] if args.key?(:name) end end # Response for successful annotation export operations. This structure is - # included in response upon operation - # completion. + # included in response upon operation completion. class ExportAnnotationsResponse include Google::Apis::Core::Hashable - # The annotation_store used for the export operation, - # in the format of - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # annotationStores/`annotation_store_id``. + # The annotation_store used for the export operation, in the format of `projects/ + # `project_id`/locations/`location_id`/datasets/`dataset_id`/annotationStores/` + # annotation_store_id``. # Corresponds to the JSON property `annotationStore` # @return [String] attr_accessor :annotation_store @@ -1180,12 +1091,10 @@ module Google end end - # 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. + # 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. class ExportDicomDataRequest include Google::Apis::Core::Hashable @@ -1249,52 +1158,43 @@ module Google end end - # 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. + # 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. class Expr include Google::Apis::Core::Hashable - # Optional. Description of the expression. This is a longer text which - # describes the expression, e.g. when hovered over it in a UI. + # Optional. Description of the expression. This is a longer text which describes + # the expression, e.g. when hovered over it in a UI. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Textual representation of an expression in Common Expression Language - # syntax. + # Textual representation of an expression in Common Expression Language syntax. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression - # Optional. String indicating the location of the expression for error - # reporting, e.g. a file name and a position in the file. + # Optional. String indicating the location of the expression for error reporting, + # e.g. a file name and a position in the file. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # 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. + # 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. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -1316,11 +1216,10 @@ module Google class FhirConfig include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `fieldMetadataList` # @return [Array] attr_accessor :field_metadata_list @@ -1358,74 +1257,67 @@ module Google class FhirStore include Google::Apis::Core::Hashable - # 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`. + # 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`. # Corresponds to the JSON property `defaultSearchHandlingStrict` # @return [Boolean] attr_accessor :default_search_handling_strict alias_method :default_search_handling_strict?, :default_search_handling_strict # 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. + # 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. # Corresponds to the JSON property `disableReferentialIntegrity` # @return [Boolean] attr_accessor :disable_referential_integrity alias_method :disable_referential_integrity?, :disable_referential_integrity - # 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. + # 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. # Corresponds to the JSON property `disableResourceVersioning` # @return [Boolean] attr_accessor :disable_resource_versioning alias_method :disable_resource_versioning?, :disable_resource_versioning - # 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. Please treat the audit logs with appropriate levels of - # care if client-specified resource IDs contain sensitive data such as - # patient identifiers, those IDs are part of the FHIR resource path - # recorded in Cloud audit logs and Cloud Pub/Sub notifications. + # 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. Please treat the audit logs with appropriate levels of + # care if client-specified resource IDs contain sensitive data such as patient + # identifiers, those IDs are part of the FHIR resource path recorded in Cloud + # audit logs and Cloud Pub/Sub notifications. # Corresponds to the JSON property `enableUpdateCreate` # @return [Boolean] attr_accessor :enable_update_create alias_method :enable_update_create?, :enable_update_create - # 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. + # 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. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Output only. Resource name of the FHIR store, of the form - # `projects/`project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. + # Output only. Resource name of the FHIR store, of the form `projects/` + # project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1436,27 +1328,24 @@ module Google attr_accessor :notification_config # 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. + # 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. # Corresponds to the JSON property `streamConfigs` # @return [Array] attr_accessor :stream_configs # 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. - # An empty value is treated as STU3. + # 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. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -1499,8 +1388,8 @@ module Google # @return [String] attr_accessor :name - # The HL7v2 table this field refers to. For example, PID-15 (Patient's - # Primary Language) usually refers to table "0296". + # The HL7v2 table this field refers to. For example, PID-15 (Patient's Primary + # Language) usually refers to table "0296". # Corresponds to the JSON property `table` # @return [String] attr_accessor :table @@ -1525,8 +1414,8 @@ module Google end end - # Specifies FHIR paths to match, and how to handle de-identification of - # matching fields. + # Specifies FHIR paths to match, and how to handle de-identification of matching + # fields. class FieldMetadata include Google::Apis::Core::Hashable @@ -1535,21 +1424,19 @@ module Google # @return [String] attr_accessor :action - # 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. + # 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. # Corresponds to the JSON property `paths` # @return [Array] attr_accessor :paths @@ -1569,8 +1456,8 @@ module Google class FilterList include Google::Apis::Core::Hashable - # These infoTypes are based on after the `eval_info_type_mapping` and - # `golden_info_type_mapping`. + # These infoTypes are based on after the `eval_info_type_mapping` and ` + # golden_info_type_mapping`. # Corresponds to the JSON property `infoTypes` # @return [Array] attr_accessor :info_types @@ -1594,8 +1481,8 @@ module Google # @return [Fixnum] attr_accessor :end - # The type of information stored in this text range. For example, - # HumanName, BirthDate, or Address. + # The type of information stored in this text range. For example, HumanName, + # BirthDate, or Address. # Corresponds to the JSON property `infoType` # @return [String] attr_accessor :info_type @@ -1628,21 +1515,17 @@ module Google class GcsSource include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1661,10 +1544,9 @@ module Google class GoogleCloudHealthcareV1beta1AnnotationBigQueryDestination include Google::Apis::Core::Hashable - # If the destination table already exists and this flag is `TRUE`, the table - # is overwritten by the contents of the input store. If the flag is not - # set and the destination table already exists, the export call returns an - # error. + # If the destination table already exists and this flag is `TRUE`, the table is + # overwritten by the contents of the input store. If the flag is not set and the + # destination table already exists, the export call returns an error. # Corresponds to the JSON property `force` # @return [Boolean] attr_accessor :force @@ -1675,8 +1557,8 @@ module Google # @return [String] attr_accessor :schema_type - # BigQuery URI to a table, up to 2000 characters long, must be of the form - # bq://projectId.bqDatasetId.tableId. + # BigQuery URI to a table, up to 2000 characters long, must be of the form bq:// + # projectId.bqDatasetId.tableId. # Corresponds to the JSON property `tableUri` # @return [String] attr_accessor :table_uri @@ -1697,12 +1579,11 @@ module Google class GoogleCloudHealthcareV1beta1AnnotationGcsDestination include Google::Apis::Core::Hashable - # 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`. + # 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`. # Corresponds to the JSON property `uriPrefix` # @return [String] attr_accessor :uri_prefix @@ -1721,23 +1602,17 @@ module Google class GoogleCloudHealthcareV1beta1AnnotationGcsSource include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1800,16 +1675,16 @@ module Google class GoogleCloudHealthcareV1beta1DicomBigQueryDestination include Google::Apis::Core::Hashable - # This flag is being replaced by write_disposition which provides additional - # options. force=false is equivalent to WRITE_EMPTY and force=true is - # equivalent to WRITE_TRUNCATE. + # If the destination table already exists and this flag is `TRUE`, the table is + # overwritten by the contents of the DICOM store. If the flag is not set and the + # destination table already exists, the export call returns an error. # Corresponds to the JSON property `force` # @return [Boolean] attr_accessor :force alias_method :force?, :force - # BigQuery URI to a table, up to 2000 characters long, in the format - # `bq://projectId.bqDatasetId.tableId` + # BigQuery URI to a table, up to 2000 characters long, in the format `bq:// + # projectId.bqDatasetId.tableId` # Corresponds to the JSON property `tableUri` # @return [String] attr_accessor :table_uri @@ -1830,47 +1705,33 @@ module Google class GoogleCloudHealthcareV1beta1DicomGcsDestination include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type - # 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`. + # 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`. # Corresponds to the JSON property `uriPrefix` # @return [String] attr_accessor :uri_prefix @@ -1890,22 +1751,17 @@ module Google class GoogleCloudHealthcareV1beta1DicomGcsSource include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1943,15 +1799,16 @@ module Google class GoogleCloudHealthcareV1beta1FhirBigQueryDestination include Google::Apis::Core::Hashable - # BigQuery URI to an existing dataset, up to 2000 characters long, in the - # format `bq://projectId.bqDatasetId`. + # BigQuery URI to an existing dataset, up to 2000 characters long, in the format + # `bq://projectId.bqDatasetId`. # Corresponds to the JSON property `datasetUri` # @return [String] attr_accessor :dataset_uri - # This flag is being replaced by write_disposition which provides additional - # options. force=false is equivalent to WRITE_EMPTY and force=true is - # equivalent to WRITE_TRUNCATE. + # If this flag is `TRUE`, all tables will be deleted from the dataset before the + # new exported tables are written. If the flag is not set and the destination + # dataset contains tables, the export call returns an error. This option is not + # used for the streaming export. # Corresponds to the JSON property `force` # @return [Boolean] attr_accessor :force @@ -1975,11 +1832,9 @@ module Google end end - # Response when errors occur while exporting resources. - # This structure is included in the - # error - # details to describe the detailed outcome. It is - # only included when the operation finishes with errors. + # Response when errors occur while exporting resources. This structure is + # included in the error details to describe the detailed outcome. It is only + # included when the operation finishes with errors. class GoogleCloudHealthcareV1beta1FhirRestExportResourcesErrorDetails include Google::Apis::Core::Hashable @@ -1988,16 +1843,15 @@ module Google # @return [Fixnum] attr_accessor :error_count - # The name of the FHIR store where resources have been exported, in the - # format - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # fhirStores/`fhir_store_id``. + # The name of the FHIR store where resources have been exported, in the format ` + # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/ + # `fhir_store_id``. # Corresponds to the JSON property `fhirStore` # @return [String] attr_accessor :fhir_store - # The total number of resources included in the export operation. This is - # the sum of the success and error counts. + # The total number of resources included in the export operation. This is the + # sum of the success and error counts. # Corresponds to the JSON property `resourceCount` # @return [Fixnum] attr_accessor :resource_count @@ -2020,17 +1874,15 @@ module Google end end - # Response when all resources export successfully. - # This structure is included in the - # response to describe the detailed - # outcome after the operation finishes successfully. + # Response when all resources export successfully. This structure is included + # in the response to describe the detailed outcome after the operation finishes + # successfully. class GoogleCloudHealthcareV1beta1FhirRestExportResourcesResponse include Google::Apis::Core::Hashable - # The name of the FHIR store where resources have been exported, in the - # format - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # fhirStores/`fhir_store_id``. + # The name of the FHIR store where resources have been exported, in the format ` + # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/ + # `fhir_store_id``. # Corresponds to the JSON property `fhirStore` # @return [String] attr_accessor :fhir_store @@ -2055,11 +1907,10 @@ module Google class GoogleCloudHealthcareV1beta1FhirRestGcsDestination include Google::Apis::Core::Hashable - # 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 user is responsible for creating the Cloud Storage bucket referenced in - # `uri_prefix`. + # 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 user is + # responsible for creating the Cloud Storage bucket referenced in `uri_prefix`. # Corresponds to the JSON property `uriPrefix` # @return [String] attr_accessor :uri_prefix @@ -2078,21 +1929,17 @@ module Google class GoogleCloudHealthcareV1beta1FhirRestGcsSource include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -2107,11 +1954,9 @@ module Google end end - # Error response of importing resources. - # This structure is included in the - # error - # details to describe the detailed error - # after the operation finishes with some failure. + # Error response of importing resources. This structure is included in the + # error details to describe the detailed error after the operation finishes with + # some failure. class GoogleCloudHealthcareV1beta1FhirRestImportResourcesErrorDetails include Google::Apis::Core::Hashable @@ -2120,16 +1965,15 @@ module Google # @return [Fixnum] attr_accessor :error_count - # The name of the FHIR store where resources have been imported, in the - # format - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # fhirStores/`fhir_store_id``. + # The name of the FHIR store where resources have been imported, in the format ` + # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/fhirStores/ + # `fhir_store_id``. # Corresponds to the JSON property `fhirStore` # @return [String] attr_accessor :fhir_store - # The total number of resources included in the source data. This is the sum - # of the success and error counts. + # The total number of resources included in the source data. This is the sum of + # the success and error counts. # Corresponds to the JSON property `inputSize` # @return [Fixnum] attr_accessor :input_size @@ -2152,16 +1996,14 @@ module Google end end - # Final response of importing resources. - # This structure is included in the - # response to describe the detailed - # outcome after the operation finishes successfully. + # Final response of importing resources. This structure is included in the + # response to describe the detailed outcome after the operation finishes + # successfully. class GoogleCloudHealthcareV1beta1FhirRestImportResourcesResponse include Google::Apis::Core::Hashable # The name of the FHIR store where the resources have been imported, in the - # format - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # format `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ # fhirStores/`fhir_store_id``. # Corresponds to the JSON property `fhirStore` # @return [String] @@ -2214,14 +2056,14 @@ module Google class Hl7SchemaConfig include Google::Apis::Core::Hashable - # Map from each HL7v2 message type and trigger event pair, such as ADT_A04, - # to its schema configuration root group. + # Map from each HL7v2 message type and trigger event pair, such as ADT_A04, to + # its schema configuration root group. # Corresponds to the JSON property `messageSchemaConfigs` # @return [Hash] attr_accessor :message_schema_configs - # Each VersionSource is tested and only if they all match is the schema used - # for the message. + # Each VersionSource is tested and only if they all match is the schema used for + # the message. # Corresponds to the JSON property `version` # @return [Array] attr_accessor :version @@ -2246,8 +2088,8 @@ module Google # @return [Array] attr_accessor :type - # The version selectors that this config applies to. A message must match - # ALL version sources to apply. + # The version selectors that this config applies to. A message must match ALL + # version sources to apply. # Corresponds to the JSON property `version` # @return [Array] attr_accessor :version @@ -2263,53 +2105,44 @@ module Google end end - # Specifies where and whether to send notifications upon changes to a - # data store. + # Specifies where and whether to send notifications upon changes to a data store. class Hl7V2NotificationConfig include Google::Apis::Core::Hashable - # Restricts notifications sent for messages matching a filter. If this is - # empty, all messages are matched. Syntax: - # https://cloud.google.com/appengine/docs/standard/python/search/query_strings - # The following fields and functions are available for filtering: - # * `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"`. - # * `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":*`. + # Restricts notifications sent for messages matching a filter. If this is empty, + # all messages are matched. Syntax: https://cloud.google.com/appengine/docs/ + # standard/python/search/query_strings The following fields and functions are + # available for filtering: * `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"`. * ` + # 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":*`. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter # The [Cloud 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 Cloud Pub/Sub, errors are - # logged to Cloud Logging. For more information, see - # [Viewing error logs in Cloud Logging](/healthcare/docs/how-tos/logging). + # 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 Cloud + # Pub/Sub, errors are logged to Cloud Logging. For more information, see [ + # Viewing error logs in Cloud Logging](/healthcare/docs/how-tos/logging). # Corresponds to the JSON property `pubsubTopic` # @return [String] attr_accessor :pubsub_topic @@ -2329,21 +2162,19 @@ module Google class Hl7V2Store include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # Resource name of the HL7v2 store, of the form - # `projects/`project_id`/datasets/`dataset_id`/hl7V2Stores/`hl7v2_store_id``. + # Resource name of the HL7v2 store, of the form `projects/`project_id`/datasets/` + # dataset_id`/hl7V2Stores/`hl7v2_store_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2353,10 +2184,10 @@ module Google # @return [Google::Apis::HealthcareV1beta1::NotificationConfig] attr_accessor :notification_config - # 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. + # 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. # Corresponds to the JSON property `notificationConfigs` # @return [Array] attr_accessor :notification_configs @@ -2367,17 +2198,15 @@ module Google # @return [Google::Apis::HealthcareV1beta1::ParserConfig] attr_accessor :parser_config - # 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. + # 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. # Corresponds to the JSON property `rejectDuplicateMessage` # @return [Boolean] attr_accessor :reject_duplicate_message @@ -2399,34 +2228,21 @@ module Google end # 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. + # 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. class HttpBody include Google::Apis::Core::Hashable @@ -2441,8 +2257,8 @@ module Google # @return [String] attr_accessor :data - # Application specific response metadata. Must be set in the first response - # for streaming APIs. + # Application specific response metadata. Must be set in the first response for + # streaming APIs. # Corresponds to the JSON property `extensions` # @return [Array>] attr_accessor :extensions @@ -2504,18 +2320,14 @@ module Google end end - # Final response of importing - # Annotations in - # partial or total failure case. This structure is included in the - # error - # details. It is only included when the operation - # finishes. + # Deprecated. Final response of importing Annotations in partial or total + # failure case. This structure is included in the error details. It is only + # included when the operation finishes. class ImportAnnotationsErrorDetails include Google::Apis::Core::Hashable - # The annotation_store that the annotations were imported to. The name - # is in the format - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # The annotation_store that the annotations were imported to. The name is in the + # format `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ # annotationStores/`annotation_store_id``. # Corresponds to the JSON property `annotationStore` # @return [String] @@ -2543,11 +2355,10 @@ module Google end end - # 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. + # 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. class ImportAnnotationsRequest include Google::Apis::Core::Hashable @@ -2556,6 +2367,13 @@ module Google # @return [Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1AnnotationGcsSource] attr_accessor :gcs_source + # 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``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + def initialize(**args) update!(**args) end @@ -2563,27 +2381,23 @@ module Google # Update properties of this object def update!(**args) @gcs_source = args[:gcs_source] if args.key?(:gcs_source) + @name = args[:name] if args.key?(:name) end end - # Final response of importing - # Annotations in - # successful case. This structure is included in the - # response. It is only included - # when the operation finishes. + # Final response of importing Annotations in successful case. This structure is + # included in the response. It is only included when the operation finishes. class ImportAnnotationsResponse include Google::Apis::Core::Hashable - # The annotation_store that the annotations were imported to, - # in the format - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # The annotation_store that the annotations were imported to, in the format ` + # projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ # annotationStores/`annotation_store_id``. # Corresponds to the JSON property `annotationStore` # @return [String] attr_accessor :annotation_store - # The number of the input annotations. All input have been - # imported successfully. + # The number of the input annotations. All input have been imported successfully. # Corresponds to the JSON property `successCount` # @return [Fixnum] attr_accessor :success_count @@ -2599,13 +2413,14 @@ module Google end end - # Returns the errors encountered during DICOM store import. + # Deprecated. Error details are in [Cloud Logging](/healthcare/docs/how-tos/ + # logging). Returns the errors encountered during DICOM store import. class ImportDicomDataErrorDetails include Google::Apis::Core::Hashable - # Deprecated. Use only for debugging purposes. - # Contains sample errors encountered in imports of individual resources. - # For example, a Cloud Storage object. + # Deprecated. Use only for debugging purposes. Contains sample errors + # encountered in imports of individual resources. For example, a Cloud Storage + # object. # Corresponds to the JSON property `sampleErrors` # @return [Array] attr_accessor :sample_errors @@ -2620,10 +2435,9 @@ module Google end end - # 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. + # 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. class ImportDicomDataRequest include Google::Apis::Core::Hashable @@ -2674,10 +2488,9 @@ module Google end end - # 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. + # 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. class ImportMessagesResponse include Google::Apis::Core::Hashable @@ -2716,8 +2529,8 @@ module Google end end - # Specifies how to use infoTypes for evaluation. For example, a user might - # only want to evaluate `PERSON`, `LOCATION`, and `AGE`. + # Specifies how to use infoTypes for evaluation. For example, a user might only + # want to evaluate `PERSON`, `LOCATION`, and `AGE`. class InfoTypeConfig include Google::Apis::Core::Hashable @@ -2731,27 +2544,15 @@ module Google # @return [Google::Apis::HealthcareV1beta1::FilterList] attr_accessor :ignore_list - # 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 + # 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 # Corresponds to the JSON property `strictMatching` # @return [Boolean] attr_accessor :strict_matching @@ -2769,8 +2570,7 @@ module Google end end - # A transformation to apply to text that is identified as a specific - # info_type. + # A transformation to apply to text that is identified as a specific info_type. class InfoTypeTransformation include Google::Apis::Core::Hashable @@ -2780,8 +2580,7 @@ module Google attr_accessor :character_mask_config # Pseudonymization method that generates surrogates via cryptographic hashing. - # Uses SHA-256. - # Outputs a base64-encoded representation of the hashed output. + # Uses SHA-256. Outputs a base64-encoded representation of the hashed output. # For example, `L7k0BHmF1ha5U3NfGykjro4xWi1MPVQPjhMAZbSV9mM=`. # Corresponds to the JSON property `cryptoHashConfig` # @return [Google::Apis::HealthcareV1beta1::CryptoHashConfig] @@ -2800,18 +2599,15 @@ module Google # @return [Array] attr_accessor :info_types - # Define how to redact sensitive values. Default behaviour is erase. - # For example, "My name is Jane." becomes "My name is ." + # Define how to redact sensitive values. Default behaviour is erase. For example, + # "My name is Jane." becomes "My name is ." # Corresponds to the JSON property `redactConfig` # @return [Google::Apis::HealthcareV1beta1::RedactConfig] attr_accessor :redact_config - # 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. + # 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. # Corresponds to the JSON property `replaceWithInfoTypeConfig` # @return [Google::Apis::HealthcareV1beta1::ReplaceWithInfoTypeConfig] attr_accessor :replace_with_info_type_config @@ -2835,10 +2631,8 @@ module Google class IngestMessageRequest include Google::Apis::Core::Hashable - # A complete HL7v2 message. - # See [Introduction to HL7 Standards] - # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for - # details on the standard. + # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7. + # org/implement/standards/index.cfm?ref=common) for details on the standard. # Corresponds to the JSON property `message` # @return [Google::Apis::HealthcareV1beta1::Message] attr_accessor :message @@ -2853,8 +2647,7 @@ module Google end end - # Acknowledges that a message has been ingested into the specified - # HL7v2 store. + # Acknowledges that a message has been ingested into the specified HL7v2 store. class IngestMessageResponse include Google::Apis::Core::Hashable @@ -2864,10 +2657,8 @@ module Google # @return [String] attr_accessor :hl7_ack - # A complete HL7v2 message. - # See [Introduction to HL7 Standards] - # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for - # details on the standard. + # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7. + # org/implement/standards/index.cfm?ref=common) for details on the standard. # Corresponds to the JSON property `message` # @return [Google::Apis::HealthcareV1beta1::Message] attr_accessor :message @@ -2883,13 +2674,12 @@ module Google end end - # Lists the Annotation stores - # in the given dataset. + # Lists the Annotation stores in the given dataset. class ListAnnotationStoresResponse include Google::Apis::Core::Hashable - # The returned Annotation stores. Won't be more Annotation stores than the - # value of page_size in the request. + # The returned Annotation stores. Won't be more Annotation stores than the value + # of page_size in the request. # Corresponds to the JSON property `annotationStores` # @return [Array] attr_accessor :annotation_stores @@ -2911,14 +2701,12 @@ module Google end end - # Lists the Annotations in the specified - # Annotation store. + # Lists the Annotations in the specified Annotation store. class ListAnnotationsResponse include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `annotations` # @return [Array] attr_accessor :annotations @@ -2949,8 +2737,8 @@ module Google # @return [Array] attr_accessor :datasets - # Token to retrieve the next page of results, or empty if there are no - # more results in the list. + # Token to retrieve the next page of results, or empty if there are no more + # results in the list. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -3076,10 +2864,8 @@ module Google class ListMessagesResponse include Google::Apis::Core::Hashable - # The returned Messages. Won't be more Messages than the value of - # page_size in the request. See - # view for - # populated fields. + # The returned Messages. Won't be more Messages than the value of page_size in + # the request. See view for populated fields. # Corresponds to the JSON property `hl7V2Messages` # @return [Array] attr_accessor :hl7_v2_messages @@ -3130,14 +2916,14 @@ module Google class Location include Google::Apis::Core::Hashable - # The friendly name for this location, typically a nearby city name. - # For example, "Tokyo". + # The friendly name for this location, typically a nearby city name. For example, + # "Tokyo". # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Cross-service attributes for the location. For example - # `"cloud.googleapis.com/region": "us-east1"` + # Cross-service attributes for the location. For example `"cloud.googleapis.com/ + # region": "us-east1"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -3153,8 +2939,8 @@ module Google # @return [Hash] attr_accessor :metadata - # Resource name for the location, which may vary between implementations. - # For example: `"projects/example-project/locations/us-east1"` + # Resource name for the location, which may vary between implementations. For + # example: `"projects/example-project/locations/us-east1"` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3173,10 +2959,8 @@ module Google end end - # A complete HL7v2 message. - # See [Introduction to HL7 Standards] - # (https://www.hl7.org/implement/standards/index.cfm?ref=common) for - # details on the standard. + # A complete HL7v2 message. See [Introduction to HL7 Standards] (https://www.hl7. + # org/implement/standards/index.cfm?ref=common) for details on the standard. class Message include Google::Apis::Core::Hashable @@ -3191,15 +2975,13 @@ module Google # @return [String] attr_accessor :data - # 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. + # 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. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -3209,10 +2991,9 @@ module Google # @return [String] attr_accessor :message_type - # 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. + # 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. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3222,8 +3003,7 @@ module Google # @return [Google::Apis::HealthcareV1beta1::ParsedData] attr_accessor :parsed_data - # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this - # message. + # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. # Corresponds to the JSON property `patientIds` # @return [Array] attr_accessor :patient_ids @@ -3269,20 +3049,17 @@ module Google # The [Cloud 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.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 Cloud Pub/Sub topic. Not having adequate - # permissions causes the calls that send notifications to fail. - # If a notification can't be published to Cloud Pub/Sub, errors are logged to - # Cloud Logging (see [Viewing - # logs](/healthcare/docs/how-tos/logging)). If the number of - # errors exceeds a certain rate, some aren't submitted. + # 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 Cloud Pub/Sub topic. Not having adequate permissions causes the calls + # that send notifications to fail. If a notification can't be published to Cloud + # Pub/Sub, errors are logged to Cloud Logging (see [Viewing logs](/healthcare/ + # docs/how-tos/logging)). If the number of errors exceeds a certain rate, some + # aren't submitted. # Corresponds to the JSON property `pubsubTopic` # @return [String] attr_accessor :pubsub_topic @@ -3302,47 +3079,45 @@ module Google class Operation include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done - # 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). + # 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). # Corresponds to the JSON property `error` # @return [Google::Apis::HealthcareV1beta1::Status] attr_accessor :error - # 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. + # 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. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # 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``. + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # 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`. + # 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`. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response @@ -3361,8 +3136,8 @@ module Google end end - # OperationMetadata provides information about the operation execution. - # Returned in the long-running operation's metadata field. + # OperationMetadata provides information about the operation execution. Returned + # in the long-running operation's metadata field. class OperationMetadata include Google::Apis::Core::Hashable @@ -3393,8 +3168,8 @@ module Google attr_accessor :end_time # A link to audit and error logs in the log viewer. Error logs are generated - # only by some operations, listed at - # [Viewing logs](/healthcare/docs/how-tos/logging). + # only by some operations, listed at [Viewing logs](/healthcare/docs/how-tos/ + # logging). # Corresponds to the JSON property `logsUrl` # @return [String] attr_accessor :logs_url @@ -3449,9 +3224,8 @@ module Google # @return [Google::Apis::HealthcareV1beta1::SchemaPackage] attr_accessor :schema - # Byte(s) to use as the segment terminator. If this is unset, '\r' is - # used as segment terminator, matching the HL7 version 2 - # specification. + # Byte(s) to use as the segment terminator. If this is unset, '\r' is used as + # segment terminator, matching the HL7 version 2 specification. # Corresponds to the JSON property `segmentTerminator` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -3495,66 +3269,32 @@ module Google end # 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/). + # 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/). class Policy include Google::Apis::Core::Hashable @@ -3563,48 +3303,44 @@ module Google # @return [Array] attr_accessor :audit_configs - # 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. + # 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. # Corresponds to the JSON property `bindings` # @return [Array] attr_accessor :bindings - # `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` 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. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag - # 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). + # 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). # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -3653,8 +3389,8 @@ module Google end end - # Define how to redact sensitive values. Default behaviour is erase. - # For example, "My name is Jane." becomes "My name is ." + # Define how to redact sensitive values. Default behaviour is erase. For example, + # "My name is Jane." becomes "My name is ." class RedactConfig include Google::Apis::Core::Hashable @@ -3667,12 +3403,9 @@ module Google end end - # 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. + # 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. class ReplaceWithInfoTypeConfig include Google::Apis::Core::Hashable @@ -3728,18 +3461,16 @@ module Google class SchemaConfig include Google::Apis::Core::Hashable - # 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. + # 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. # Corresponds to the JSON property `recursiveStructureDepth` # @return [Fixnum] attr_accessor :recursive_structure_depth - # Specifies the output schema type. If unspecified, the default is - # `LOSSLESS`. + # Specifies the output schema type. Schema type is required. # Corresponds to the JSON property `schemaType` # @return [String] attr_accessor :schema_type @@ -3813,10 +3544,10 @@ module Google attr_accessor :ignore_min_occurs alias_method :ignore_min_occurs?, :ignore_min_occurs - # 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. + # 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. # Corresponds to the JSON property `schemas` # @return [Array] attr_accessor :schemas @@ -3826,14 +3557,20 @@ module Google # @return [String] attr_accessor :schematized_parsing_type - # Schema type definitions that are layered based on their VersionSources - # that match the incoming message. Type definitions present in higher indices + # 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. # Corresponds to the JSON property `types` # @return [Array] attr_accessor :types + # Determines how unexpected segments (segments not matched to the schema) are + # handled. + # Corresponds to the JSON property `unexpectedSegmentHandling` + # @return [String] + attr_accessor :unexpected_segment_handling + def initialize(**args) update!(**args) end @@ -3844,6 +3581,7 @@ module Google @schemas = args[:schemas] if args.key?(:schemas) @schematized_parsing_type = args[:schematized_parsing_type] if args.key?(:schematized_parsing_type) @types = args[:types] if args.key?(:types) + @unexpected_segment_handling = args[:unexpected_segment_handling] if args.key?(:unexpected_segment_handling) end end @@ -3851,8 +3589,8 @@ module Google class SchemaSegment include Google::Apis::Core::Hashable - # The maximum number of times this segment can be present in this group. - # 0 or -1 means unbounded. + # The maximum number of times this segment can be present in this group. 0 or -1 + # means unbounded. # Corresponds to the JSON property `maxOccurs` # @return [Fixnum] attr_accessor :max_occurs @@ -3910,10 +3648,10 @@ module Google include Google::Apis::Core::Hashable # 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)). + # 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)). # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -3932,18 +3670,15 @@ module Google class Segment include Google::Apis::Core::Hashable - # 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". + # 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". # Corresponds to the JSON property `fields` # @return [Hash] attr_accessor :fields @@ -3953,8 +3688,8 @@ module Google # @return [String] attr_accessor :segment_id - # Set ID for segments that can be in a set. This can be empty if it's - # missing or isn't applicable. + # Set ID for segments that can be in a set. This can be empty if it's missing or + # isn't applicable. # Corresponds to the JSON property `setId` # @return [String] attr_accessor :set_id @@ -3975,9 +3710,9 @@ module Google class SensitiveTextAnnotation include Google::Apis::Core::Hashable - # 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` + # 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` # Corresponds to the JSON property `details` # @return [Hash] attr_accessor :details @@ -3997,74 +3732,39 @@ module Google include Google::Apis::Core::Hashable # 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/). + # 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/). # Corresponds to the JSON property `policy` # @return [Google::Apis::HealthcareV1beta1::Policy] attr_accessor :policy # 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"` + # the fields in the mask will be modified. If no mask is provided, the following + # default mask is used: `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -4080,12 +3780,12 @@ module Google end end - # 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). + # 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). class Status include Google::Apis::Core::Hashable @@ -4094,15 +3794,15 @@ module Google # @return [Fixnum] attr_accessor :code - # A list of messages that carry the error details. There is a common set of + # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details - # 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. + # 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. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -4128,10 +3828,9 @@ module Google # @return [Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1FhirBigQueryDestination] attr_accessor :bigquery_destination - # 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 + # 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. # Corresponds to the JSON property `resourceTypes` # @return [Array] @@ -4152,11 +3851,10 @@ module Google class TagFilterList include Google::Apis::Core::Hashable - # 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 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". # Corresponds to the JSON property `tags` # @return [Array] attr_accessor :tags @@ -4175,10 +3873,9 @@ module Google class TestIamPermissionsRequest include Google::Apis::Core::Hashable - # 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). + # 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). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -4197,8 +3894,7 @@ module Google class TestIamPermissionsResponse include Google::Apis::Core::Hashable - # A subset of `TestPermissionsRequest.permissions` that the caller is - # allowed. + # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -4241,14 +3937,14 @@ module Google # @return [Array] attr_accessor :fields - # The name of this type. This would be the segment or datatype name. - # For example, "PID" or "XPN". + # The name of this type. This would be the segment or datatype name. For example, + # "PID" or "XPN". # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # If this is a primitive type then this field is the type of the primitive - # For example, STRING. Leave unspecified for composite types. + # If this is a primitive type then this field is the type of the primitive For + # example, STRING. Leave unspecified for composite types. # Corresponds to the JSON property `primitive` # @return [String] attr_accessor :primitive @@ -4274,8 +3970,7 @@ module Google # @return [String] attr_accessor :msh_field - # The value to match with the field. For example, "My Application Name" or - # "2.3". + # The value to match with the field. For example, "My Application Name" or "2.3". # Corresponds to the JSON property `value` # @return [String] attr_accessor :value diff --git a/generated/google/apis/healthcare_v1beta1/representations.rb b/generated/google/apis/healthcare_v1beta1/representations.rb index 2ab9f3e89..b170ed91a 100644 --- a/generated/google/apis/healthcare_v1beta1/representations.rb +++ b/generated/google/apis/healthcare_v1beta1/representations.rb @@ -1010,6 +1010,7 @@ module Google property :golden_store, as: 'goldenStore' property :info_type_config, as: 'infoTypeConfig', class: Google::Apis::HealthcareV1beta1::InfoTypeConfig, decorator: Google::Apis::HealthcareV1beta1::InfoTypeConfig::Representation + property :name, as: 'name' end end @@ -1039,6 +1040,7 @@ module Google property :gcs_destination, as: 'gcsDestination', class: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1AnnotationGcsDestination, decorator: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1AnnotationGcsDestination::Representation + property :name, as: 'name' end end @@ -1383,6 +1385,7 @@ module Google class Representation < Google::Apis::Core::JsonRepresentation property :gcs_source, as: 'gcsSource', class: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1AnnotationGcsSource, decorator: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1AnnotationGcsSource::Representation + property :name, as: 'name' end end @@ -1729,6 +1732,7 @@ module Google property :schematized_parsing_type, as: 'schematizedParsingType' collection :types, as: 'types', class: Google::Apis::HealthcareV1beta1::Hl7TypesConfig, decorator: Google::Apis::HealthcareV1beta1::Hl7TypesConfig::Representation + property :unexpected_segment_handling, as: 'unexpectedSegmentHandling' end end diff --git a/generated/google/apis/healthcare_v1beta1/service.rb b/generated/google/apis/healthcare_v1beta1/service.rb index 396d16024..e5780aeab 100644 --- a/generated/google/apis/healthcare_v1beta1/service.rb +++ b/generated/google/apis/healthcare_v1beta1/service.rb @@ -116,20 +116,18 @@ module Google execute_or_queue_command(command, &block) end - # 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. - # A Google Cloud Platform project can contain up to 500 datasets across all + # 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. A + # Google Cloud Platform project can contain up to 500 datasets across all # regions. # @param [String] parent - # The name of the project where the server creates the dataset. For - # example, `projects/`project_id`/locations/`location_id``. + # The name of the project where the server creates the dataset. For example, ` + # projects/`project_id`/locations/`location_id``. # @param [Google::Apis::HealthcareV1beta1::Dataset] dataset_object # @param [String] dataset_id - # The ID of the dataset that is being created. - # The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``. + # The ID of the dataset that is being created. The string must match the + # following regex: `[\p`L`\p`N`_\-\.]`1,256``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -160,25 +158,17 @@ module Google execute_or_queue_command(command, &block) end - # 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. - # If errors occur, - # error - # details field type is - # DeidentifyErrorDetails. - # The LRO result may still be successful if de-identification fails for some - # DICOM instances. The new de-identified dataset will not contain these - # failed resources. Failed resource totals are tracked in - # DeidentifySummary.failure_resource_count. - # Error details are also logged to Cloud Logging. For more information, - # see [Viewing logs](/healthcare/docs/how-tos/logging). + # 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 logs](/healthcare/ + # docs/how-tos/logging). # @param [String] source_dataset - # Source dataset resource name. For example, - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # Source dataset resource name. For example, `projects/`project_id`/locations/` + # location_id`/datasets/`dataset_id``. # @param [Google::Apis::HealthcareV1beta1::DeidentifyDatasetRequest] deidentify_dataset_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -213,8 +203,8 @@ module Google # Deleting a dataset does not affect the sources from which the dataset was # imported (if any). # @param [String] name - # The name of the dataset to delete. For example, - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # The name of the dataset to delete. For example, `projects/`project_id`/ + # locations/`location_id`/datasets/`dataset_id``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -244,8 +234,8 @@ module Google # Gets any metadata associated with a dataset. # @param [String] name - # The name of the dataset to read. For example, - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # The name of the dataset to read. For example, `projects/`project_id`/locations/ + # `location_id`/datasets/`dataset_id``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -273,22 +263,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. 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). + # Optional. 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). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -319,11 +306,11 @@ module Google # Lists the health datasets in the current project. # @param [String] parent - # The name of the project whose datasets should be listed. - # For example, `projects/`project_id`/locations/`location_id``. + # The name of the project whose datasets should be listed. For example, ` + # projects/`project_id`/locations/`location_id``. # @param [Fixnum] page_size - # The maximum number of items to return. Capped to 100 if not specified. - # May not be larger than 1000. + # The maximum number of items to return. Capped to 100 if not specified. May not + # be larger than 1000. # @param [String] page_token # The next_page_token value returned from a previous List request, if any. # @param [String] fields @@ -357,12 +344,11 @@ module Google # Updates dataset metadata. # @param [String] name - # Resource name of the dataset, of the form - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id``. + # Resource name of the dataset, of the form `projects/`project_id`/locations/` + # location_id`/datasets/`dataset_id``. # @param [Google::Apis::HealthcareV1beta1::Dataset] dataset_object # @param [String] update_mask - # The update mask applies to the resource. For the `FieldMask` definition, - # see + # The update mask applies to the resource. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# # fieldmask # @param [String] fields @@ -396,11 +382,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -431,15 +417,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -475,8 +460,8 @@ module Google # The name of the dataset this Annotation store belongs to. # @param [Google::Apis::HealthcareV1beta1::AnnotationStore] annotation_store_object # @param [String] annotation_store_id - # The ID of the Annotation store that is being created. - # The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``. + # The ID of the Annotation store that is being created. The string must match + # the following regex: `[\p`L`\p`N`_\-\.]`1,256``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -538,18 +523,14 @@ module Google execute_or_queue_command(command, &block) end - # 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 logs](/healthcare/docs/how-tos/logging)). + # 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 + # logs](/healthcare/docs/how-tos/logging)). # @param [String] eval_store - # The Annotation store to compare against `golden_store`, in the - # format of - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # 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``. # @param [Google::Apis::HealthcareV1beta1::EvaluateAnnotationStoreRequest] evaluate_annotation_store_request_object # @param [String] fields @@ -581,24 +562,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. - # If errors occur, the error - # field type is ImportAnnotationsErrorDetails. - # Errors are also logged to Cloud Logging - # (see [Viewing logs](/healthcare/docs/how-tos/logging)). + # 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 logs](/ + # healthcare/docs/how-tos/logging)). # @param [String] annotation_store - # The name of the Annotation store to export annotations to, in - # the format of - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # 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``. # @param [Google::Apis::HealthcareV1beta1::ExportAnnotationsRequest] export_annotations_request_object # @param [String] fields @@ -630,8 +601,7 @@ module Google execute_or_queue_command(command, &block) end - # Gets the specified Annotation store or returns NOT_FOUND if it does not - # exist. + # Gets the specified Annotation store or returns NOT_FOUND if it does not exist. # @param [String] name # The resource name of the Annotation store to get. # @param [String] fields @@ -661,22 +631,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. 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). + # Optional. 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). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -705,26 +672,15 @@ module Google execute_or_queue_command(command, &block) end - # 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. - # If errors occur, the error - # field type is ImportAnnotationsErrorDetails. - # Errors are also logged to Cloud Logging - # (see [Viewing logs](/healthcare/docs/how-tos/logging)). + # 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 logs](/healthcare/docs/how-tos/logging)). # @param [String] annotation_store - # 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``. + # 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``. # @param [Google::Apis::HealthcareV1beta1::ImportAnnotationsRequest] import_annotations_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -759,12 +715,12 @@ module Google # @param [String] parent # Name of the dataset. # @param [String] filter - # Restricts stores returned to those matching a filter. Syntax: - # https://cloud.google.com/appengine/docs/standard/python/search/query_strings - # Only filtering on labels is supported, for example `labels.key=value`. + # Restricts stores returned to those matching a filter. Syntax: https://cloud. + # google.com/appengine/docs/standard/python/search/query_strings Only filtering + # on labels is supported, for example `labels.key=value`. # @param [Fixnum] page_size - # Limit on the number of Annotation stores to return in a single response. - # If zero the default page size of 100 is used. + # Limit on the number of Annotation stores to return in a single response. If + # zero the default page size of 100 is used. # @param [String] page_token # The next_page_token value returned from the previous List request, if any. # @param [String] fields @@ -799,13 +755,12 @@ module Google # Updates the specified Annotation store. # @param [String] name - # Resource name of the Annotation store, of the form - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # annotationStores/`annotation_store_id``. + # Resource name of the Annotation store, of the form `projects/`project_id`/ + # locations/`location_id`/datasets/`dataset_id`/annotationStores/` + # annotation_store_id``. # @param [Google::Apis::HealthcareV1beta1::AnnotationStore] annotation_store_object # @param [String] update_mask - # The update mask applies to the resource. For the `FieldMask` definition, - # see + # The update mask applies to the resource. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# # fieldmask # @param [String] fields @@ -839,11 +794,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -874,15 +829,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -913,12 +867,12 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] parent - # The name of the Annotation store this annotation belongs to. For example, - # `projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/ + # The name of the Annotation store this annotation belongs to. For example, ` + # projects/my-project/locations/us-central1/datasets/mydataset/annotationStores/ # myannotationstore`. # @param [Google::Apis::HealthcareV1beta1::Annotation] annotation_object # @param [String] fields @@ -950,8 +904,7 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an Annotation or returns - # NOT_FOUND if it does not exist. + # Deletes an Annotation or returns NOT_FOUND if it does not exist. # @param [String] name # The resource name of the Annotation to delete. # @param [String] fields @@ -1011,24 +964,20 @@ module Google execute_or_queue_command(command, &block) end - # Lists the Annotations in the given - # Annotation store for a source - # resource. + # Lists the Annotations in the given Annotation store for a source resource. # @param [String] parent # Name of the Annotation store to retrieve Annotations from. # @param [String] 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`. + # 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`. # @param [Fixnum] page_size - # Limit on the number of Annotations to return in a single response. - # If zero the default page size of 100 is used. + # Limit on the number of Annotations to return in a single response. If zero the + # default page size of 100 is used. # @param [String] page_token # The next_page_token value returned from the previous List request, if any. # @param [String] view @@ -1066,13 +1015,12 @@ module Google # Updates the Annotation. # @param [String] 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``. + # Resource name of the Annotation, of the form `projects/`project_id`/locations/` + # location_id`/datasets/`dataset_id`/annotationStores/`annotation_store_id`/ + # annotations/`annotation_id``. # @param [Google::Apis::HealthcareV1beta1::Annotation] annotation_object # @param [String] update_mask - # The update mask applies to the resource. For the `FieldMask` definition, - # see + # The update mask applies to the resource. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# # fieldmask # @param [String] fields @@ -1110,8 +1058,8 @@ module Google # The name of the dataset this DICOM store belongs to. # @param [Google::Apis::HealthcareV1beta1::DicomStore] dicom_store_object # @param [String] dicom_store_id - # The ID of the DICOM store that is being created. - # Any string value up to 256 characters in length. + # The ID of the DICOM store that is being created. Any string value up to 256 + # characters in length. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1143,24 +1091,16 @@ module Google end # 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. If errors occur, - # error - # details field type is - # DeidentifyErrorDetails. - # 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. Failed resource totals are tracked in - # DeidentifySummary.failure_resource_count. - # Error details are also logged to Cloud Logging - # (see [Viewing logs](/healthcare/docs/how-tos/logging)). + # 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 logs](/ + # healthcare/docs/how-tos/logging). # @param [String] source_store - # Source DICOM store resource name. For example, - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # dicomStores/`dicom_store_id``. + # Source DICOM store resource name. For example, `projects/`project_id`/ + # locations/`location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``. # @param [Google::Apis::HealthcareV1beta1::DeidentifyDicomStoreRequest] deidentify_dicom_store_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1222,16 +1162,13 @@ module Google execute_or_queue_command(command, &block) end - # 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 logs](/healthcare/docs/how-tos/logging). - # The metadata field type is + # 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 + # logs](/healthcare/docs/how-tos/logging). The metadata field type is # OperationMetadata. # @param [String] name - # The DICOM store resource name from which to export the data. For - # example, - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ + # 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``. # @param [Google::Apis::HealthcareV1beta1::ExportDicomDataRequest] export_dicom_data_request_object # @param [String] fields @@ -1293,22 +1230,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. 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). + # Optional. 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). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1338,16 +1272,11 @@ module Google end # Imports data into the DICOM store by copying it from the specified source. - # For errors, the Operation is populated with error details (in the form - # of ImportDicomDataErrorDetails in error.details), which hold - # finer-grained error information. Errors are also logged to Cloud Logging. - # For more information, see [Viewing logs](/healthcare/docs/how-tos/logging). - # The metadata field type is - # OperationMetadata. + # Errors are logged to Cloud Logging. For more information, see [Viewing logs](/ + # healthcare/docs/how-tos/logging). The metadata field type is OperationMetadata. # @param [String] 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`/ + # 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``. # @param [Google::Apis::HealthcareV1beta1::ImportDicomDataRequest] import_dicom_data_request_object # @param [String] fields @@ -1383,12 +1312,12 @@ module Google # @param [String] parent # Name of the dataset. # @param [String] filter - # Restricts stores returned to those matching a filter. Syntax: - # https://cloud.google.com/appengine/docs/standard/python/search/query_strings - # Only filtering on labels is supported. For example, `labels.key=value`. + # Restricts stores returned to those matching a filter. Syntax: https://cloud. + # google.com/appengine/docs/standard/python/search/query_strings Only filtering + # on labels is supported. For example, `labels.key=value`. # @param [Fixnum] page_size - # Limit on the number of DICOM stores to return in a single response. - # If zero the default page size of 100 is used. + # Limit on the number of DICOM stores to return in a single response. If zero + # the default page size of 100 is used. # @param [String] page_token # The next_page_token value returned from the previous List request, if any. # @param [String] fields @@ -1423,13 +1352,11 @@ module Google # Updates the specified DICOM store. # @param [String] name - # Resource name of the DICOM store, of the form - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # dicomStores/`dicom_store_id``. + # Resource name of the DICOM store, of the form `projects/`project_id`/locations/ + # `location_id`/datasets/`dataset_id`/dicomStores/`dicom_store_id``. # @param [Google::Apis::HealthcareV1beta1::DicomStore] dicom_store_object # @param [String] update_mask - # The update mask applies to the resource. For the `FieldMask` definition, - # see + # The update mask applies to the resource. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# # fieldmask # @param [String] fields @@ -1462,17 +1389,17 @@ module Google execute_or_queue_command(command, &block) end - # SearchForInstances returns a list of matching instances. See - # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # SearchForInstances returns a list of matching instances. See [ + # RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ # part18.html#sect_10.4). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the SearchForInstancesRequest DICOMweb request. For example, - # `instances`, `series/`series_uid`/instances`, or - # `studies/`study_uid`/instances`. + # The path of the SearchForInstancesRequest DICOMweb request. For example, ` + # instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/instances` + # . # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1501,16 +1428,15 @@ module Google execute_or_queue_command(command, &block) end - # SearchForSeries returns a list of matching series. See - # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # SearchForSeries returns a list of matching series. See [RetrieveTransaction]( + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the SearchForSeries DICOMweb request. For example, `series` or - # `studies/`study_uid`/series`. + # The path of the SearchForSeries DICOMweb request. For example, `series` or ` + # studies/`study_uid`/series`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1539,13 +1465,12 @@ module Google execute_or_queue_command(command, &block) end - # SearchForStudies returns a list of matching studies. See - # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # SearchForStudies returns a list of matching studies. See [RetrieveTransaction]( + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path # The path of the SearchForStudies DICOMweb request. For example, `studies`. # @param [String] fields @@ -1577,11 +1502,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1613,17 +1538,15 @@ module Google end # 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). + # identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/ + # dicom/current/output/html/part18.html#sect_10.5). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the StoreInstances DICOMweb request. For example, - # `studies/[`study_uid`]`. Note that the `study_uid` is optional. + # The path of the StoreInstances DICOMweb request. For example, `studies/[` + # study_uid`]`. Note that the `study_uid` is optional. # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1655,15 +1578,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1694,8 +1616,8 @@ module Google execute_or_queue_command(command, &block) end - # DeleteStudy deletes all instances within the given study. Delete requests - # are equivalent to the GET requests specified in the Retrieve transaction. + # DeleteStudy deletes all instances within the given study. Delete requests are + # equivalent to the GET requests specified in the Retrieve transaction. # @param [String] parent # @param [String] dicom_web_path # The path of the DeleteStudy request. For example, `studies/`study_uid``. @@ -1728,16 +1650,15 @@ module Google end # 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). + # presented as metadata with the bulk data removed. See [RetrieveTransaction]( + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveStudyMetadata DICOMweb request. For example, - # `studies/`study_uid`/metadata`. + # The path of the RetrieveStudyMetadata DICOMweb request. For example, `studies/` + # study_uid`/metadata`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1766,16 +1687,16 @@ module Google execute_or_queue_command(command, &block) end - # RetrieveStudy returns all instances within the given study. See - # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # RetrieveStudy returns all instances within the given study. See [ + # RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ # part18.html#sect_10.4). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveStudy DICOMweb request. For example, - # `studies/`study_uid``. + # The path of the RetrieveStudy DICOMweb request. For example, `studies/` + # study_uid``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1804,17 +1725,17 @@ module Google execute_or_queue_command(command, &block) end - # SearchForInstances returns a list of matching instances. See - # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # SearchForInstances returns a list of matching instances. See [ + # RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ # part18.html#sect_10.4). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the SearchForInstancesRequest DICOMweb request. For example, - # `instances`, `series/`series_uid`/instances`, or - # `studies/`study_uid`/instances`. + # The path of the SearchForInstancesRequest DICOMweb request. For example, ` + # instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/instances` + # . # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1843,16 +1764,15 @@ module Google execute_or_queue_command(command, &block) end - # SearchForSeries returns a list of matching series. See - # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ - # part18.html#sect_10.4). + # SearchForSeries returns a list of matching series. See [RetrieveTransaction]( + # http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the SearchForSeries DICOMweb request. For example, `series` or - # `studies/`study_uid`/series`. + # The path of the SearchForSeries DICOMweb request. For example, `series` or ` + # studies/`study_uid`/series`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1882,17 +1802,15 @@ module Google end # 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). + # identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/ + # dicom/current/output/html/part18.html#sect_10.5). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the StoreInstances DICOMweb request. For example, - # `studies/[`study_uid`]`. Note that the `study_uid` is optional. + # The path of the StoreInstances DICOMweb request. For example, `studies/[` + # study_uid`]`. Note that the `study_uid` is optional. # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1924,16 +1842,16 @@ module Google execute_or_queue_command(command, &block) end - # DeleteSeries deletes all instances within the given study and series. - # Delete requests are equivalent to the GET requests specified in the - # Retrieve transaction. + # DeleteSeries deletes all instances within the given study and series. Delete + # requests are equivalent to the GET requests specified in the Retrieve + # transaction. # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the DeleteSeries request. For example, - # `studies/`study_uid`/series/`series_uid``. + # The path of the DeleteSeries request. For example, `studies/`study_uid`/series/ + # `series_uid``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1963,16 +1881,16 @@ module Google end # 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/ + # 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). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveSeriesMetadata DICOMweb request. For example, - # `studies/`study_uid`/series/`series_uid`/metadata`. + # The path of the RetrieveSeriesMetadata DICOMweb request. For example, `studies/ + # `study_uid`/series/`series_uid`/metadata`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2001,16 +1919,16 @@ module Google execute_or_queue_command(command, &block) end - # RetrieveSeries returns all instances within the given study and series. See - # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # 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). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveSeries DICOMweb request. For example, - # `studies/`study_uid`/series/`series_uid``. + # The path of the RetrieveSeries DICOMweb request. For example, `studies/` + # study_uid`/series/`series_uid``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2039,17 +1957,17 @@ module Google execute_or_queue_command(command, &block) end - # SearchForInstances returns a list of matching instances. See - # [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ + # SearchForInstances returns a list of matching instances. See [ + # RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/ # part18.html#sect_10.4). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the SearchForInstancesRequest DICOMweb request. For example, - # `instances`, `series/`series_uid`/instances`, or - # `studies/`study_uid`/instances`. + # The path of the SearchForInstancesRequest DICOMweb request. For example, ` + # instances`, `series/`series_uid`/instances`, or `studies/`study_uid`/instances` + # . # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2080,16 +1998,16 @@ module Google # 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. + # 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. # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the DeleteInstance request. For example, - # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid``. + # The path of the DeleteInstance request. For example, `studies/`study_uid`/ + # series/`series_uid`/instances/`instance_uid``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2118,17 +2036,16 @@ module Google execute_or_queue_command(command, &block) end - # 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). + # 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). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveInstance DICOMweb request. For example, - # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid``. + # The path of the RetrieveInstance DICOMweb request. For example, `studies/` + # study_uid`/series/`series_uid`/instances/`instance_uid``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2158,17 +2075,16 @@ module Google end # 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). + # 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). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveInstanceMetadata DICOMweb request. For example, - # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/metadata`. + # The path of the RetrieveInstanceMetadata DICOMweb request. For example, ` + # studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/metadata`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2198,16 +2114,16 @@ module Google end # 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/ + # 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). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveRenderedInstance DICOMweb request. For example, - # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/rendered`. + # The path of the RetrieveRenderedInstance DICOMweb request. For example, ` + # studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/rendered`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2236,18 +2152,16 @@ module Google execute_or_queue_command(command, &block) end - # 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). + # 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). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveFrames DICOMweb request. For example, - # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/frames/` - # frame_list``. + # The path of the RetrieveFrames DICOMweb request. For example, `studies/` + # study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`frame_list``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2278,17 +2192,16 @@ module Google # 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). + # Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/ + # output/html/part18.html#sect_10.4). # @param [String] 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``. + # 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``. # @param [String] dicom_web_path - # The path of the RetrieveRenderedFrames DICOMweb request. For example, - # `studies/`study_uid`/series/`series_uid`/instances/`instance_uid`/frames/` - # frame_list`/rendered`. + # The path of the RetrieveRenderedFrames DICOMweb request. For example, `studies/ + # `study_uid`/series/`series_uid`/instances/`instance_uid`/frames/`frame_list`/ + # rendered`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2322,8 +2235,8 @@ module Google # The name of the dataset this FHIR store belongs to. # @param [Google::Apis::HealthcareV1beta1::FhirStore] fhir_store_object # @param [String] fhir_store_id - # The ID of the FHIR store that is being created. - # The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``. + # The ID of the FHIR store that is being created. The string must match the + # following regex: `[\p`L`\p`N`_\-\.]`1,256``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2355,20 +2268,14 @@ module Google end # 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. If errors occur, - # error - # details field type is - # DeidentifyErrorDetails. - # Errors are also logged to Cloud Logging - # (see [Viewing logs](/healthcare/docs/how-tos/logging)). + # 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 logs](/healthcare/ + # docs/how-tos/logging). # @param [String] source_store - # Source FHIR store resource name. For example, - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # fhirStores/`fhir_store_id``. + # Source FHIR store resource name. For example, `projects/`project_id`/locations/ + # `location_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. # @param [Google::Apis::HealthcareV1beta1::DeidentifyFhirStoreRequest] deidentify_fhir_store_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2429,23 +2336,17 @@ module Google execute_or_queue_command(command, &block) end - # 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 - # logs](/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. + # 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 logs](/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. # @param [String] 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``. + # 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``. # @param [Google::Apis::HealthcareV1beta1::ExportResourcesRequest] export_resources_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2506,22 +2407,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. 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). + # Optional. 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). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2550,74 +2448,58 @@ module Google execute_or_queue_command(command, &block) end - # 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. - # 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 Cloud 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 is specified by the parameters - # below. 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 - # logs](/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. + # 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. 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 Cloud 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 is specified by the parameters below. 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 logs](/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. # @param [String] 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``. + # 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``. # @param [Google::Apis::HealthcareV1beta1::ImportResourcesRequest] import_resources_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2652,12 +2534,12 @@ module Google # @param [String] parent # Name of the dataset. # @param [String] filter - # Restricts stores returned to those matching a filter. Syntax: - # https://cloud.google.com/appengine/docs/standard/python/search/query_strings - # Only filtering on labels is supported, for example `labels.key=value`. + # Restricts stores returned to those matching a filter. Syntax: https://cloud. + # google.com/appengine/docs/standard/python/search/query_strings Only filtering + # on labels is supported, for example `labels.key=value`. # @param [Fixnum] page_size - # Limit on the number of FHIR stores to return in a single response. If zero - # the default page size of 100 is used. + # Limit on the number of FHIR stores to return in a single response. If zero the + # default page size of 100 is used. # @param [String] page_token # The next_page_token value returned from the previous List request, if any. # @param [String] fields @@ -2692,12 +2574,11 @@ module Google # Updates the configuration of the specified FHIR store. # @param [String] name - # Output only. Resource name of the FHIR store, of the form - # `projects/`project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. + # Output only. Resource name of the FHIR store, of the form `projects/` + # project_id`/datasets/`dataset_id`/fhirStores/`fhir_store_id``. # @param [Google::Apis::HealthcareV1beta1::FhirStore] fhir_store_object # @param [String] update_mask - # The update mask applies to the resource. For the `FieldMask` definition, - # see + # The update mask applies to the resource. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# # fieldmask # @param [String] fields @@ -2731,11 +2612,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2766,15 +2647,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2805,37 +2685,35 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] parent # The name for the FHIR store containing the concept map(s) to use for the # translation. # @param [String] code # The code to translate. # @param [String] concept_map_version - # The version of the concept map to use. If unset, the most current version - # is used. + # The version of the concept map to use. If unset, the most current version is + # used. # @param [String] source - # The source value set of the concept map to be used. If unset, target is - # used to search for concept maps. + # The source value set of the concept map to be used. If unset, target is used + # to search for concept maps. # @param [String] system # The system for the code to be translated. # @param [String] target - # The target value set of the concept map to be used. If unset, source is - # used to search for concept maps. + # The target value set of the concept map to be used. If unset, source is used + # to search for concept maps. # @param [String] url - # The canonical url of the concept map to use. If unset, the source and - # target is used to search for concept maps. + # The canonical url of the concept map to use. If unset, the source and target + # is used to search for concept maps. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2870,23 +2748,22 @@ module Google end # Translates a code from one value set to another using a concept map. - # 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. + # 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. # @param [String] name # The URL for the concept map to use for the translation. # @param [String] code # The code to translate. # @param [String] concept_map_version - # The version of the concept map to use. If unset, the most current version - # is used. + # The version of the concept map to use. If unset, the most current version is + # used. # @param [String] system # The system for the code to be translated. # @param [String] fields @@ -2920,35 +2797,27 @@ module Google end # 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. + # 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 + # 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. # @param [String] parent # Name of the FHIR store to retrieve resources from. @@ -2979,60 +2848,52 @@ module Google execute_or_queue_command(command, &block) end - # 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# + # 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_compartment_resources). # @param [String] name # Name of the `Patient` resource for which the information is required. # @param [Fixnum] _count # Maximum number of resources in a page. Defaults to 100. # @param [String] _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. + # 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. # @param [String] _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. + # 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. # @param [String] _type - # String of comma-delimited FHIR resource types. If provided, only resources - # of the specified resource type(s) are returned. + # String of comma-delimited FHIR resource types. If provided, only resources of + # the specified resource type(s) are returned. # @param [String] 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. # @param [String] 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. + # 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. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3068,12 +2929,10 @@ module Google # 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). + # 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). # @param [String] name # The name of the resource to purge. # @param [String] fields @@ -3103,23 +2962,17 @@ module Google execute_or_queue_command(command, &block) end - # 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 + # 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. + # conformance) in the DSTU2 case. On success, the response body contains a JSON- + # encoded representation of a `CapabilityStatement` resource. # @param [String] name # Name of the FHIR store to retrieve the capabilities for. # @param [String] fields @@ -3149,34 +3002,29 @@ module Google execute_or_queue_command(command, &block) end - # 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# + # 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). # @param [String] parent # The name of the FHIR store this resource belongs to. # @param [String] type # The FHIR resource type to delete, 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)). + # 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)). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3206,40 +3054,35 @@ module Google end # 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# + # 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). # @param [String] parent # The name of the FHIR store this resource belongs to. # @param [String] type # The FHIR resource type to update, 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)). + # 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)). # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3272,45 +3115,38 @@ module Google end # 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. 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. + # 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. 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). + # 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). # @param [String] parent # The name of the FHIR store this resource belongs to. # @param [String] type # The FHIR resource type to update, 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)). - # Must match the resource type in the provided content. + # 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)). Must match the resource type in the + # provided content. # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3342,40 +3178,35 @@ module Google execute_or_queue_command(command, &block) end - # 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). + # 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). # @param [String] parent # The name of the FHIR store this resource belongs to. # @param [String] type # The FHIR resource type to create, 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)). - # Must match the resource type in the provided content. + # 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)). Must match the resource type in the + # provided content. # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3407,20 +3238,16 @@ module Google execute_or_queue_command(command, &block) end - # 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). + # 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). # @param [String] name # The name of the resource to delete. # @param [String] fields @@ -3450,40 +3277,36 @@ module Google execute_or_queue_command(command, &block) end - # 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). + # 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). # @param [String] parent # Name of the FHIR store in which this bundle will be executed. # @param [Google::Apis::HealthcareV1beta1::HttpBody] http_body_object @@ -3517,48 +3340,40 @@ module Google end # 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# + # 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_versions). # @param [String] name # The name of the resource to retrieve. # @param [String] _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` + # 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` # @param [Fixnum] _count # The maximum number of search results on a page. Defaults to 1000. # @param [String] _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. + # 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. # @param [String] _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. + # 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. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3590,23 +3405,19 @@ module Google execute_or_queue_command(command, &block) end - # 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 + # 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). # @param [String] name # The name of the resource to update. @@ -3640,26 +3451,22 @@ module Google execute_or_queue_command(command, &block) end - # 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). + # 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). # @param [String] name # The name of the resource to retrieve. # @param [String] fields @@ -3689,59 +3496,46 @@ module Google execute_or_queue_command(command, &block) end - # 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 three 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]/[type]/_search?[parameters]` as an alternate form having - # the same semantics as the `GET` method. - # The `GET` 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). + # 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 three 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]/[type]/ + # _search?[parameters]` as an alternate form having the same semantics as the ` + # GET` method. The `GET` 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). # @param [String] parent # Name of the FHIR store to retrieve resources from. # @param [Google::Apis::HealthcareV1beta1::SearchResourcesRequest] search_resources_request_object @@ -3774,27 +3568,21 @@ module Google execute_or_queue_command(command, &block) end - # 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. - # 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 + # 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. 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). # @param [String] name # The name of the resource to update. @@ -3828,22 +3616,17 @@ module Google execute_or_queue_command(command, &block) end - # 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_version). + # 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_version). # @param [String] name # The name of the resource version to retrieve. # @param [String] fields @@ -3878,8 +3661,8 @@ module Google # The name of the dataset this HL7v2 store belongs to. # @param [Google::Apis::HealthcareV1beta1::Hl7V2Store] hl7_v2_store_object # @param [String] hl7_v2_store_id - # The ID of the HL7v2 store that is being created. - # The string must match the following regex: `[\p`L`\p`N`_\-\.]`1,256``. + # The ID of the HL7v2 store that is being created. The string must match the + # following regex: `[\p`L`\p`N`_\-\.]`1,256``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3910,8 +3693,7 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified HL7v2 store and removes all messages that it - # contains. + # Deletes the specified HL7v2 store and removes all messages that it contains. # @param [String] name # The resource name of the HL7v2 store to delete. # @param [String] fields @@ -3971,22 +3753,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a resource. - # Returns an empty policy if the resource exists and does not have a policy - # set. + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Fixnum] options_requested_policy_version - # Optional. 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). + # Optional. 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). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4015,40 +3794,32 @@ module Google execute_or_queue_command(command, &block) end - # 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 - # logs](/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. + # 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 logs](/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. # @param [String] name - # The name of the target HL7v2 store, in the format - # `projects/`project_id`/locations/`location_id`/datasets/`dataset_id`/ - # hl7v2Stores/`hl7v2_store_id`` + # The name of the target HL7v2 store, in the format `projects/`project_id`/ + # locations/`location_id`/datasets/`dataset_id`/hl7v2Stores/`hl7v2_store_id`` # @param [Google::Apis::HealthcareV1beta1::ImportMessagesRequest] import_messages_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4083,12 +3854,12 @@ module Google # @param [String] parent # Name of the dataset. # @param [String] filter - # Restricts stores returned to those matching a filter. Syntax: - # https://cloud.google.com/appengine/docs/standard/python/search/query_strings - # Only filtering on labels is supported. For example, `labels.key=value`. + # Restricts stores returned to those matching a filter. Syntax: https://cloud. + # google.com/appengine/docs/standard/python/search/query_strings Only filtering + # on labels is supported. For example, `labels.key=value`. # @param [Fixnum] page_size - # Limit on the number of HL7v2 stores to return in a single response. - # If zero the default page size of 100 is used. + # Limit on the number of HL7v2 stores to return in a single response. If zero + # the default page size of 100 is used. # @param [String] page_token # The next_page_token value returned from the previous List request, if any. # @param [String] fields @@ -4123,12 +3894,11 @@ module Google # Updates the HL7v2 store. # @param [String] name - # Resource name of the HL7v2 store, of the form - # `projects/`project_id`/datasets/`dataset_id`/hl7V2Stores/`hl7v2_store_id``. + # Resource name of the HL7v2 store, of the form `projects/`project_id`/datasets/` + # dataset_id`/hl7V2Stores/`hl7v2_store_id``. # @param [Google::Apis::HealthcareV1beta1::Hl7V2Store] hl7_v2_store_object # @param [String] update_mask - # The update mask applies to the resource. For the `FieldMask` definition, - # see + # The update mask applies to the resource. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# # fieldmask # @param [String] fields @@ -4162,11 +3932,11 @@ module Google end # Sets the access control policy on the specified resource. Replaces any - # existing policy. - # Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy is being specified. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1beta1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4197,15 +3967,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. - # See the operation documentation for the appropriate value for this field. + # REQUIRED: The resource for which the policy detail is being requested. See the + # operation documentation for the appropriate value for this field. # @param [Google::Apis::HealthcareV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4237,11 +4006,10 @@ module Google end # Parses and stores an HL7v2 message. This method triggers an asynchronous - # notification to any Cloud Pub/Sub topic configured in - # projects.locations.datasets.hl7V2Stores.Hl7V2NotificationConfig, if the - # filtering matches the message. If an MLLP adapter is configured to listen - # to a Cloud Pub/Sub topic, the adapter transmits the message when a - # notification is received. + # notification to any Cloud Pub/Sub topic configured in projects.locations. + # datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the + # message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic, + # the adapter transmits the message when a notification is received. # @param [String] parent # The name of the dataset this message belongs to. # @param [Google::Apis::HealthcareV1beta1::CreateMessageRequest] create_message_request_object @@ -4308,8 +4076,8 @@ module Google # @param [String] name # The resource name of the HL7v2 message to retrieve. # @param [String] view - # Specifies which parts of the Message resource to return in the response. - # When unspecified, equivalent to FULL. + # Specifies which parts of the Message resource to return in the response. When + # unspecified, equivalent to FULL. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4339,14 +4107,14 @@ module Google end # Parses and stores an HL7v2 message. This method triggers an asynchronous - # notification to any Cloud Pub/Sub topic configured in - # projects.locations.datasets.hl7V2Stores.Hl7V2NotificationConfig, if the - # filtering matches the message. If an MLLP adapter is configured to listen - # to a Cloud Pub/Sub topic, the adapter transmits the message when a - # notification is received. This method also generates a response - # containing an HL7v2 acknowledgement (`ACK`) message when successful or a - # negative acknowledgement (`NACK`) message in case of error, suitable for - # replying to HL7v2 interface systems that expect these acknowledgements. + # notification to any Cloud Pub/Sub topic configured in projects.locations. + # datasets.hl7V2Stores.Hl7V2NotificationConfig, if the filtering matches the + # message. If an MLLP adapter is configured to listen to a Cloud Pub/Sub topic, + # the adapter transmits the message when a notification is received. This method + # also generates a response containing an HL7v2 acknowledgement (`ACK`) message + # when successful or a negative acknowledgement (`NACK`) message in case of + # error, suitable for replying to HL7v2 interface systems that expect these + # acknowledgements. # @param [String] parent # The name of the HL7v2 store this message belongs to. # @param [Google::Apis::HealthcareV1beta1::IngestMessageRequest] ingest_message_request_object @@ -4381,46 +4149,41 @@ module Google # 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. + # delay between the time a message is created and when it can be found through a + # filter. # @param [String] parent # Name of the HL7v2 store to retrieve messages from. # @param [String] filter - # Restricts messages returned to those matching a filter. Syntax: - # https://cloud.google.com/appengine/docs/standard/python/search/query_strings - # The following fields and functions are available for filtering: - # * `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"`. - # * `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":*`. + # Restricts messages returned to those matching a filter. Syntax: https://cloud. + # google.com/appengine/docs/standard/python/search/query_strings The following + # fields and functions are available for filtering: * `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"`. * `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":*`. # @param [String] order_by - # 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` + # 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` # @param [Fixnum] page_size - # Limit on the number of messages to return in a single response. - # If zero the default page size of 100 is used. + # Limit on the number of messages to return in a single response. If zero the + # default page size of 100 is used. # @param [String] page_token # The next_page_token value returned from the previous List request, if any. # @param [String] 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. + # 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. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4453,21 +4216,18 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] 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. + # 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. # @param [Google::Apis::HealthcareV1beta1::Message] message_object # @param [String] update_mask - # The update mask applies to the resource. For the `FieldMask` definition, - # see + # The update mask applies to the resource. For the `FieldMask` definition, see # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf# # fieldmask # @param [String] fields @@ -4500,15 +4260,13 @@ module Google execute_or_queue_command(command, &block) end - # 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, + # 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`. # @param [String] name # The name of the operation resource to be cancelled. @@ -4542,9 +4300,8 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] name # The name of the operation resource. # @param [String] fields @@ -4574,15 +4331,14 @@ module Google execute_or_queue_command(command, &block) end - # 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. + # 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. # @param [String] name # The name of the operation's parent resource. # @param [String] filter diff --git a/generated/google/apis/iam_v1.rb b/generated/google/apis/iam_v1.rb index 950bcf87c..d5b0b017b 100644 --- a/generated/google/apis/iam_v1.rb +++ b/generated/google/apis/iam_v1.rb @@ -22,12 +22,15 @@ module Google # # Manages identity and access control for Google Cloud Platform resources, # including the creation of service accounts, which you can use to authenticate - # to Google and make API calls. + # to Google and make API calls. *Note:* This API is tied to the IAM service + # account credentials API ( iamcredentials.googleapis.com). Enabling or + # disabling this API will also enable or disable the IAM service account + # credentials API. # # @see https://cloud.google.com/iam/ module IamV1 VERSION = 'V1' - REVISION = '20200806' + REVISION = '20200824' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/iam_v1/service.rb b/generated/google/apis/iam_v1/service.rb index 0eb2a686a..16e589447 100644 --- a/generated/google/apis/iam_v1/service.rb +++ b/generated/google/apis/iam_v1/service.rb @@ -24,7 +24,10 @@ module Google # # Manages identity and access control for Google Cloud Platform resources, # including the creation of service accounts, which you can use to authenticate - # to Google and make API calls. + # to Google and make API calls. *Note:* This API is tied to the IAM service + # account credentials API ( iamcredentials.googleapis.com). Enabling or + # disabling this API will also enable or disable the IAM service account + # credentials API. # # @example # require 'google/apis/iam_v1' diff --git a/generated/google/apis/memcache_v1.rb b/generated/google/apis/localservices_v1.rb similarity index 54% rename from generated/google/apis/memcache_v1.rb rename to generated/google/apis/localservices_v1.rb index 2112c3104..218d87bd1 100644 --- a/generated/google/apis/memcache_v1.rb +++ b/generated/google/apis/localservices_v1.rb @@ -12,24 +12,20 @@ # See the License for the specific language governing permissions and # limitations under the License. -require 'google/apis/memcache_v1/service.rb' -require 'google/apis/memcache_v1/classes.rb' -require 'google/apis/memcache_v1/representations.rb' +require 'google/apis/localservices_v1/service.rb' +require 'google/apis/localservices_v1/classes.rb' +require 'google/apis/localservices_v1/representations.rb' module Google module Apis - # Cloud Memorystore for Memcached API + # Local Services API # - # Google Cloud Memorystore for Memcached API is used for creating and managing - # Memcached instances in GCP. + # # - # @see https://cloud.google.com/memorystore/ - module MemcacheV1 + # @see https://ads.google.com/local-services-ads/ + module LocalservicesV1 VERSION = 'V1' - REVISION = '20200817' - - # View and manage your data across Google Cloud Platform services - AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + REVISION = '20200821' end end end diff --git a/generated/google/apis/localservices_v1/classes.rb b/generated/google/apis/localservices_v1/classes.rb new file mode 100644 index 000000000..cfcde467d --- /dev/null +++ b/generated/google/apis/localservices_v1/classes.rb @@ -0,0 +1,419 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module LocalservicesV1 + + # An Account Report of a GLS account identified by their account id containing + # aggregate data gathered from a particular date range. + class GoogleAdsHomeservicesLocalservicesV1AccountReport + include Google::Apis::Core::Hashable + + # Unique identifier of the GLS account. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Average review rating score from 1-5 stars. + # Corresponds to the JSON property `averageFiveStarRating` + # @return [Float] + attr_accessor :average_five_star_rating + + # Average weekly budget in the currency code of the account. + # Corresponds to the JSON property `averageWeeklyBudget` + # @return [Float] + attr_accessor :average_weekly_budget + + # Business name of the account. + # Corresponds to the JSON property `businessName` + # @return [String] + attr_accessor :business_name + + # Currency code of the account. + # Corresponds to the JSON property `currencyCode` + # @return [String] + attr_accessor :currency_code + + # Number of charged leads the account received in current specified period. + # Corresponds to the JSON property `currentPeriodChargedLeads` + # @return [Fixnum] + attr_accessor :current_period_charged_leads + + # Number of connected phone calls (duration over 30s) in current specified + # period. + # Corresponds to the JSON property `currentPeriodConnectedPhoneCalls` + # @return [Fixnum] + attr_accessor :current_period_connected_phone_calls + + # Number of phone calls in current specified period, including both connected + # and unconnected calls. + # Corresponds to the JSON property `currentPeriodPhoneCalls` + # @return [Fixnum] + attr_accessor :current_period_phone_calls + + # Total cost of the account in current specified period in the account's + # specified currency. + # Corresponds to the JSON property `currentPeriodTotalCost` + # @return [Float] + attr_accessor :current_period_total_cost + + # Phone lead responsiveness of the account for the past 90 days from current + # date. This is computed by taking the total number of connected calls from + # charged phone leads and dividing by the total number of calls received. + # Corresponds to the JSON property `phoneLeadResponsiveness` + # @return [Float] + attr_accessor :phone_lead_responsiveness + + # Number of charged leads the account received in previous specified period. + # Corresponds to the JSON property `previousPeriodChargedLeads` + # @return [Fixnum] + attr_accessor :previous_period_charged_leads + + # Number of connected phone calls (duration over 30s) in previous specified + # period. + # Corresponds to the JSON property `previousPeriodConnectedPhoneCalls` + # @return [Fixnum] + attr_accessor :previous_period_connected_phone_calls + + # Number of phone calls in previous specified period, including both connected + # and unconnected calls. + # Corresponds to the JSON property `previousPeriodPhoneCalls` + # @return [Fixnum] + attr_accessor :previous_period_phone_calls + + # Total cost of the account in previous specified period in the account's + # specified currency. + # Corresponds to the JSON property `previousPeriodTotalCost` + # @return [Float] + attr_accessor :previous_period_total_cost + + # Total number of reviews the account has up to current date. + # Corresponds to the JSON property `totalReview` + # @return [Fixnum] + attr_accessor :total_review + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @average_five_star_rating = args[:average_five_star_rating] if args.key?(:average_five_star_rating) + @average_weekly_budget = args[:average_weekly_budget] if args.key?(:average_weekly_budget) + @business_name = args[:business_name] if args.key?(:business_name) + @currency_code = args[:currency_code] if args.key?(:currency_code) + @current_period_charged_leads = args[:current_period_charged_leads] if args.key?(:current_period_charged_leads) + @current_period_connected_phone_calls = args[:current_period_connected_phone_calls] if args.key?(:current_period_connected_phone_calls) + @current_period_phone_calls = args[:current_period_phone_calls] if args.key?(:current_period_phone_calls) + @current_period_total_cost = args[:current_period_total_cost] if args.key?(:current_period_total_cost) + @phone_lead_responsiveness = args[:phone_lead_responsiveness] if args.key?(:phone_lead_responsiveness) + @previous_period_charged_leads = args[:previous_period_charged_leads] if args.key?(:previous_period_charged_leads) + @previous_period_connected_phone_calls = args[:previous_period_connected_phone_calls] if args.key?(:previous_period_connected_phone_calls) + @previous_period_phone_calls = args[:previous_period_phone_calls] if args.key?(:previous_period_phone_calls) + @previous_period_total_cost = args[:previous_period_total_cost] if args.key?(:previous_period_total_cost) + @total_review = args[:total_review] if args.key?(:total_review) + end + end + + # Conatiner for aggregator specific information if lead is for an aggregator GLS + # account. + class GoogleAdsHomeservicesLocalservicesV1AggregatorInfo + include Google::Apis::Core::Hashable + + # Provider id (listed in aggregator system) which maps to a account id in GLS + # system. + # Corresponds to the JSON property `aggregatorProviderId` + # @return [String] + attr_accessor :aggregator_provider_id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @aggregator_provider_id = args[:aggregator_provider_id] if args.key?(:aggregator_provider_id) + end + end + + # A Detailed Lead Report of a lead identified by their lead id and contains + # consumer, account, monetization, and lead data. + class GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport + include Google::Apis::Core::Hashable + + # Identifies account that received the lead. + # Corresponds to the JSON property `accountId` + # @return [Fixnum] + attr_accessor :account_id + + # Conatiner for aggregator specific information if lead is for an aggregator GLS + # account. + # Corresponds to the JSON property `aggregatorInfo` + # @return [Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1AggregatorInfo] + attr_accessor :aggregator_info + + # Business name associated to the account. + # Corresponds to the JSON property `businessName` + # @return [String] + attr_accessor :business_name + + # Whether the lead has been charged. + # Corresponds to the JSON property `chargeStatus` + # @return [String] + attr_accessor :charge_status + + # Currency code. + # Corresponds to the JSON property `currencyCode` + # @return [String] + attr_accessor :currency_code + + # Dispute status related to the lead. + # Corresponds to the JSON property `disputeStatus` + # @return [String] + attr_accessor :dispute_status + + # Location of the associated account's home city. + # Corresponds to the JSON property `geo` + # @return [String] + attr_accessor :geo + + # Lead category (e.g. hvac, plumber) + # Corresponds to the JSON property `leadCategory` + # @return [String] + attr_accessor :lead_category + + # Timestamp of when the lead was created. + # Corresponds to the JSON property `leadCreationTimestamp` + # @return [String] + attr_accessor :lead_creation_timestamp + + # Unique identifier of a Detailed Lead Report. + # Corresponds to the JSON property `leadId` + # @return [Fixnum] + attr_accessor :lead_id + + # Price of the lead (available only after it has been charged). + # Corresponds to the JSON property `leadPrice` + # @return [Float] + attr_accessor :lead_price + + # Lead type. + # Corresponds to the JSON property `leadType` + # @return [String] + attr_accessor :lead_type + + # Container for message lead specific information. + # Corresponds to the JSON property `messageLead` + # @return [Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1MessageLead] + attr_accessor :message_lead + + # Container for phone lead specific information. + # Corresponds to the JSON property `phoneLead` + # @return [Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1PhoneLead] + attr_accessor :phone_lead + + # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/ + # time-zones). + # Corresponds to the JSON property `timezone` + # @return [Google::Apis::LocalservicesV1::GoogleTypeTimeZone] + attr_accessor :timezone + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_id = args[:account_id] if args.key?(:account_id) + @aggregator_info = args[:aggregator_info] if args.key?(:aggregator_info) + @business_name = args[:business_name] if args.key?(:business_name) + @charge_status = args[:charge_status] if args.key?(:charge_status) + @currency_code = args[:currency_code] if args.key?(:currency_code) + @dispute_status = args[:dispute_status] if args.key?(:dispute_status) + @geo = args[:geo] if args.key?(:geo) + @lead_category = args[:lead_category] if args.key?(:lead_category) + @lead_creation_timestamp = args[:lead_creation_timestamp] if args.key?(:lead_creation_timestamp) + @lead_id = args[:lead_id] if args.key?(:lead_id) + @lead_price = args[:lead_price] if args.key?(:lead_price) + @lead_type = args[:lead_type] if args.key?(:lead_type) + @message_lead = args[:message_lead] if args.key?(:message_lead) + @phone_lead = args[:phone_lead] if args.key?(:phone_lead) + @timezone = args[:timezone] if args.key?(:timezone) + end + end + + # Container for message lead specific information. + class GoogleAdsHomeservicesLocalservicesV1MessageLead + include Google::Apis::Core::Hashable + + # Consumer phone number associated with the message lead. + # Corresponds to the JSON property `consumerPhoneNumber` + # @return [String] + attr_accessor :consumer_phone_number + + # Name of the customer who created the lead. + # Corresponds to the JSON property `customerName` + # @return [String] + attr_accessor :customer_name + + # The job type of the specified lead. + # Corresponds to the JSON property `jobType` + # @return [String] + attr_accessor :job_type + + # The postal code of the customer who created the lead. + # Corresponds to the JSON property `postalCode` + # @return [String] + attr_accessor :postal_code + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @consumer_phone_number = args[:consumer_phone_number] if args.key?(:consumer_phone_number) + @customer_name = args[:customer_name] if args.key?(:customer_name) + @job_type = args[:job_type] if args.key?(:job_type) + @postal_code = args[:postal_code] if args.key?(:postal_code) + end + end + + # Container for phone lead specific information. + class GoogleAdsHomeservicesLocalservicesV1PhoneLead + include Google::Apis::Core::Hashable + + # Timestamp of the phone call which resulted in a charged phone lead. + # Corresponds to the JSON property `chargedCallTimestamp` + # @return [String] + attr_accessor :charged_call_timestamp + + # Duration of the charged phone call in seconds. + # Corresponds to the JSON property `chargedConnectedCallDurationSeconds` + # @return [String] + attr_accessor :charged_connected_call_duration_seconds + + # Consumer phone number associated with the phone lead. + # Corresponds to the JSON property `consumerPhoneNumber` + # @return [String] + attr_accessor :consumer_phone_number + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @charged_call_timestamp = args[:charged_call_timestamp] if args.key?(:charged_call_timestamp) + @charged_connected_call_duration_seconds = args[:charged_connected_call_duration_seconds] if args.key?(:charged_connected_call_duration_seconds) + @consumer_phone_number = args[:consumer_phone_number] if args.key?(:consumer_phone_number) + end + end + + # A page of the response received from the SearchAccountReports method. A + # paginated response where more pages are available has `next_page_token` set. + # This token can be used in a subsequent request to retrieve the next request + # page. + class GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse + include Google::Apis::Core::Hashable + + # List of account reports which maps 1:1 to a particular linked GLS account. + # Corresponds to the JSON property `accountReports` + # @return [Array] + attr_accessor :account_reports + + # Pagination token to retrieve the next page of results. When `next_page_token` + # is not filled in, there is no next page and the list returned is the last page + # in the result set. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @account_reports = args[:account_reports] if args.key?(:account_reports) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # A page of the response received from the SearchDetailedLeadReports method. A + # paginated response where more pages are available has `next_page_token` set. + # This token can be used in a subsequent request to retrieve the next request + # page. + class GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse + include Google::Apis::Core::Hashable + + # List of detailed lead reports uniquely identified by external lead id. + # Corresponds to the JSON property `detailedLeadReports` + # @return [Array] + attr_accessor :detailed_lead_reports + + # Pagination token to retrieve the next page of results. When `next_page_token` + # is not filled in, there is no next page and the list returned is the last page + # in the result set. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @detailed_lead_reports = args[:detailed_lead_reports] if args.key?(:detailed_lead_reports) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + end + end + + # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/ + # time-zones). + class GoogleTypeTimeZone + include Google::Apis::Core::Hashable + + # IANA Time Zone Database time zone, e.g. "America/New_York". + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + # Optional. IANA Time Zone Database version number, e.g. "2019a". + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @id = args[:id] if args.key?(:id) + @version = args[:version] if args.key?(:version) + end + end + end + end +end diff --git a/generated/google/apis/localservices_v1/representations.rb b/generated/google/apis/localservices_v1/representations.rb new file mode 100644 index 000000000..6d90b4be2 --- /dev/null +++ b/generated/google/apis/localservices_v1/representations.rb @@ -0,0 +1,172 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module LocalservicesV1 + + class GoogleAdsHomeservicesLocalservicesV1AccountReport + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleAdsHomeservicesLocalservicesV1AggregatorInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleAdsHomeservicesLocalservicesV1MessageLead + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleAdsHomeservicesLocalservicesV1PhoneLead + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleTypeTimeZone + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleAdsHomeservicesLocalservicesV1AccountReport + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :average_five_star_rating, as: 'averageFiveStarRating' + property :average_weekly_budget, as: 'averageWeeklyBudget' + property :business_name, as: 'businessName' + property :currency_code, as: 'currencyCode' + property :current_period_charged_leads, :numeric_string => true, as: 'currentPeriodChargedLeads' + property :current_period_connected_phone_calls, :numeric_string => true, as: 'currentPeriodConnectedPhoneCalls' + property :current_period_phone_calls, :numeric_string => true, as: 'currentPeriodPhoneCalls' + property :current_period_total_cost, as: 'currentPeriodTotalCost' + property :phone_lead_responsiveness, as: 'phoneLeadResponsiveness' + property :previous_period_charged_leads, :numeric_string => true, as: 'previousPeriodChargedLeads' + property :previous_period_connected_phone_calls, :numeric_string => true, as: 'previousPeriodConnectedPhoneCalls' + property :previous_period_phone_calls, :numeric_string => true, as: 'previousPeriodPhoneCalls' + property :previous_period_total_cost, as: 'previousPeriodTotalCost' + property :total_review, as: 'totalReview' + end + end + + class GoogleAdsHomeservicesLocalservicesV1AggregatorInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :aggregator_provider_id, as: 'aggregatorProviderId' + end + end + + class GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :account_id, :numeric_string => true, as: 'accountId' + property :aggregator_info, as: 'aggregatorInfo', class: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1AggregatorInfo, decorator: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1AggregatorInfo::Representation + + property :business_name, as: 'businessName' + property :charge_status, as: 'chargeStatus' + property :currency_code, as: 'currencyCode' + property :dispute_status, as: 'disputeStatus' + property :geo, as: 'geo' + property :lead_category, as: 'leadCategory' + property :lead_creation_timestamp, as: 'leadCreationTimestamp' + property :lead_id, :numeric_string => true, as: 'leadId' + property :lead_price, as: 'leadPrice' + property :lead_type, as: 'leadType' + property :message_lead, as: 'messageLead', class: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1MessageLead, decorator: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1MessageLead::Representation + + property :phone_lead, as: 'phoneLead', class: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1PhoneLead, decorator: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1PhoneLead::Representation + + property :timezone, as: 'timezone', class: Google::Apis::LocalservicesV1::GoogleTypeTimeZone, decorator: Google::Apis::LocalservicesV1::GoogleTypeTimeZone::Representation + + end + end + + class GoogleAdsHomeservicesLocalservicesV1MessageLead + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :consumer_phone_number, as: 'consumerPhoneNumber' + property :customer_name, as: 'customerName' + property :job_type, as: 'jobType' + property :postal_code, as: 'postalCode' + end + end + + class GoogleAdsHomeservicesLocalservicesV1PhoneLead + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :charged_call_timestamp, as: 'chargedCallTimestamp' + property :charged_connected_call_duration_seconds, as: 'chargedConnectedCallDurationSeconds' + property :consumer_phone_number, as: 'consumerPhoneNumber' + end + end + + class GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :account_reports, as: 'accountReports', class: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1AccountReport, decorator: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1AccountReport::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :detailed_lead_reports, as: 'detailedLeadReports', class: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport, decorator: Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport::Representation + + property :next_page_token, as: 'nextPageToken' + end + end + + class GoogleTypeTimeZone + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :id, as: 'id' + property :version, as: 'version' + end + end + end + end +end diff --git a/generated/google/apis/localservices_v1/service.rb b/generated/google/apis/localservices_v1/service.rb new file mode 100644 index 000000000..ee681db3a --- /dev/null +++ b/generated/google/apis/localservices_v1/service.rb @@ -0,0 +1,199 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module LocalservicesV1 + # Local Services API + # + # + # + # @example + # require 'google/apis/localservices_v1' + # + # Localservices = Google::Apis::LocalservicesV1 # Alias the module + # service = Localservices::LocalservicesService.new + # + # @see https://ads.google.com/local-services-ads/ + class LocalservicesService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + attr_accessor :quota_user + + def initialize + super('https://localservices.googleapis.com/', '') + @batch_path = 'batch' + end + + # Get account reports containing aggregate account data of all linked GLS + # accounts. Caller needs to provide their manager customer id and the associated + # auth credential that allows them read permissions on their linked accounts. + # @param [Fixnum] end_date_day + # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if + # specifying a year by itself or a year and month where the day is not + # significant. + # @param [Fixnum] end_date_month + # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month + # and day. + # @param [Fixnum] end_date_year + # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. + # @param [Fixnum] page_size + # The maximum number of accounts to return. If the page size is unset, page size + # will default to 1000. Maximum page_size is 10000. Optional. + # @param [String] page_token + # The `next_page_token` value returned from a previous request to + # SearchAccountReports that indicates where listing should continue. Optional. + # @param [String] query + # A query string for searching for account reports. Caller must provide a + # customer id of their MCC account with an associated Gaia Mint that allows read + # permission on their linked accounts. Search expressions are case insensitive. + # Example query: | Query | Description | |-------------------------|------------- + # ----------------------------------| | manager_customer_id:123 | Get Account + # Report for Manager with id 123. | Required. + # @param [Fixnum] start_date_day + # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if + # specifying a year by itself or a year and month where the day is not + # significant. + # @param [Fixnum] start_date_month + # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month + # and day. + # @param [Fixnum] start_date_year + # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_account_reports(end_date_day: nil, end_date_month: nil, end_date_year: nil, page_size: nil, page_token: nil, query: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/accountReports:search', options) + command.response_representation = Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse::Representation + command.response_class = Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse + command.query['endDate.day'] = end_date_day unless end_date_day.nil? + command.query['endDate.month'] = end_date_month unless end_date_month.nil? + command.query['endDate.year'] = end_date_year unless end_date_year.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['query'] = query unless query.nil? + command.query['startDate.day'] = start_date_day unless start_date_day.nil? + command.query['startDate.month'] = start_date_month unless start_date_month.nil? + command.query['startDate.year'] = start_date_year unless start_date_year.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Get detailed lead reports containing leads that have been received by all + # linked GLS accounts. Caller needs to provide their manager customer id and the + # associated auth credential that allows them read permissions on their linked + # accounts. + # @param [Fixnum] end_date_day + # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if + # specifying a year by itself or a year and month where the day is not + # significant. + # @param [Fixnum] end_date_month + # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month + # and day. + # @param [Fixnum] end_date_year + # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. + # @param [Fixnum] page_size + # The maximum number of accounts to return. If the page size is unset, page size + # will default to 1000. Maximum page_size is 10000. Optional. + # @param [String] page_token + # The `next_page_token` value returned from a previous request to + # SearchDetailedLeadReports that indicates where listing should continue. + # Optional. + # @param [String] query + # A query string for searching for account reports. Caller must provide a + # customer id of their MCC account with an associated Gaia Mint that allows read + # permission on their linked accounts. Search expressions are case insensitive. + # Example query: | Query | Description | |-------------------------|------------- + # ----------------------------------| | manager_customer_id:123 | Get Detailed + # Lead Report for Manager with id | | | 123. | Required. + # @param [Fixnum] start_date_day + # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if + # specifying a year by itself or a year and month where the day is not + # significant. + # @param [Fixnum] start_date_month + # Month of year. Must be from 1 to 12, or 0 if specifying a year without a month + # and day. + # @param [Fixnum] start_date_year + # Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def search_detailed_lead_reports(end_date_day: nil, end_date_month: nil, end_date_year: nil, page_size: nil, page_token: nil, query: nil, start_date_day: nil, start_date_month: nil, start_date_year: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1/detailedLeadReports:search', options) + command.response_representation = Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse::Representation + command.response_class = Google::Apis::LocalservicesV1::GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse + command.query['endDate.day'] = end_date_day unless end_date_day.nil? + command.query['endDate.month'] = end_date_month unless end_date_month.nil? + command.query['endDate.year'] = end_date_year unless end_date_year.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['query'] = query unless query.nil? + command.query['startDate.day'] = start_date_day unless start_date_day.nil? + command.query['startDate.month'] = start_date_month unless start_date_month.nil? + command.query['startDate.year'] = start_date_year unless start_date_year.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/memcache_v1/classes.rb b/generated/google/apis/memcache_v1/classes.rb deleted file mode 100644 index 124223991..000000000 --- a/generated/google/apis/memcache_v1/classes.rb +++ /dev/null @@ -1,1137 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module MemcacheV1 - - # Request for ApplyParameters. - class ApplyParametersRequest - include Google::Apis::Core::Hashable - - # Whether to apply instance-level parameter group to all nodes. If set to true, - # will explicitly restrict users from specifying any nodes, and apply parameter - # group updates to all nodes within the instance. - # Corresponds to the JSON property `applyAll` - # @return [Boolean] - attr_accessor :apply_all - alias_method :apply_all?, :apply_all - - # Nodes to which we should apply the instance-level parameter group. - # Corresponds to the JSON property `nodeIds` - # @return [Array] - attr_accessor :node_ids - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @apply_all = args[:apply_all] if args.key?(:apply_all) - @node_ids = args[:node_ids] if args.key?(:node_ids) - end - end - - # The request message for Operations.CancelOperation. - class CancelOperationRequest - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - - # 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 ````. - class Empty - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - - # Represents the metadata of a long-running operation. - class GoogleCloudMemcacheV1OperationMetadata - include Google::Apis::Core::Hashable - - # Output only. API version used to start the operation. - # Corresponds to the JSON property `apiVersion` - # @return [String] - attr_accessor :api_version - - # Output only. Identifies whether the user has requested cancellation of the - # operation. Operations that have successfully been cancelled have Operation. - # error value with a google.rpc.Status.code of 1, corresponding to `Code. - # CANCELLED`. - # Corresponds to the JSON property `cancelRequested` - # @return [Boolean] - attr_accessor :cancel_requested - alias_method :cancel_requested?, :cancel_requested - - # Output only. Time when the operation was created. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Output only. Time when the operation finished running. - # Corresponds to the JSON property `endTime` - # @return [String] - attr_accessor :end_time - - # Output only. Human-readable status of the operation, if any. - # Corresponds to the JSON property `statusDetail` - # @return [String] - attr_accessor :status_detail - - # Output only. Server-defined resource path for the target of the operation. - # Corresponds to the JSON property `target` - # @return [String] - attr_accessor :target - - # Output only. Name of the verb executed by the operation. - # Corresponds to the JSON property `verb` - # @return [String] - attr_accessor :verb - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @api_version = args[:api_version] if args.key?(:api_version) - @cancel_requested = args[:cancel_requested] if args.key?(:cancel_requested) - @create_time = args[:create_time] if args.key?(:create_time) - @end_time = args[:end_time] if args.key?(:end_time) - @status_detail = args[:status_detail] if args.key?(:status_detail) - @target = args[:target] if args.key?(:target) - @verb = args[:verb] if args.key?(:verb) - end - end - - # - class GoogleCloudSaasacceleratorManagementProvidersV1Instance - include Google::Apis::Core::Hashable - - # consumer_defined_name is the name that is set by the consumer. On the other - # hand Name field represents system-assigned id of an instance so consumers are - # not necessarily aware of it. consumer_defined_name is used for notification/UI - # purposes for consumer to recognize their instances. - # Corresponds to the JSON property `consumerDefinedName` - # @return [String] - attr_accessor :consumer_defined_name - - # Output only. Timestamp when the resource was created. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Optional. Resource labels to represent user provided metadata. Each label is a - # key-value pair, where both the key and the value are arbitrary strings - # provided by the user. - # Corresponds to the JSON property `labels` - # @return [Hash] - attr_accessor :labels - - # The MaintenancePolicies that have been attached to the instance. The key must - # be of the type name of the oneof policy name defined in MaintenancePolicy, and - # the referenced policy must define the same policy type. For complete details - # of MaintenancePolicy, please refer to go/cloud-saas-mw-ug. - # Corresponds to the JSON property `maintenancePolicyNames` - # @return [Hash] - attr_accessor :maintenance_policy_names - - # The MaintenanceSchedule contains the scheduling information of published - # maintenance schedule. - # Corresponds to the JSON property `maintenanceSchedules` - # @return [Hash] - attr_accessor :maintenance_schedules - - # Maintenance settings associated with instance. Allows service producers and - # end users to assign settings that controls maintenance on this instance. - # Corresponds to the JSON property `maintenanceSettings` - # @return [Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings] - attr_accessor :maintenance_settings - - # Unique name of the resource. It uses the form: `projects/`project_id`/ - # locations/`location_id`/instances/`instance_id`` - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Output only. Custom string attributes used primarily to expose producer- - # specific information in monitoring dashboards. See go/get-instance-metadata. - # Corresponds to the JSON property `producerMetadata` - # @return [Hash] - attr_accessor :producer_metadata - - # Output only. The list of data plane resources provisioned for this instance, e. - # g. compute VMs. See go/get-instance-metadata. - # Corresponds to the JSON property `provisionedResources` - # @return [Array] - attr_accessor :provisioned_resources - - # Link to the SLM instance template. Only populated when updating SLM instances - # via SSA's Actuation service adaptor. Service producers with custom control - # plane (e.g. Cloud SQL) doesn't need to populate this field. Instead they - # should use software_versions. - # Corresponds to the JSON property `slmInstanceTemplate` - # @return [String] - attr_accessor :slm_instance_template - - # SloMetadata contains resources required for proper SLO classification of the - # instance. - # Corresponds to the JSON property `sloMetadata` - # @return [Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata] - attr_accessor :slo_metadata - - # Software versions that are used to deploy this instance. This can be mutated - # by rollout services. - # Corresponds to the JSON property `softwareVersions` - # @return [Hash] - attr_accessor :software_versions - - # Output only. Current lifecycle state of the resource (e.g. if it's being - # created or ready to use). - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - # Output only. ID of the associated GCP tenant project. See go/get-instance- - # metadata. - # Corresponds to the JSON property `tenantProjectId` - # @return [String] - attr_accessor :tenant_project_id - - # Output only. Timestamp when the resource was last modified. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @consumer_defined_name = args[:consumer_defined_name] if args.key?(:consumer_defined_name) - @create_time = args[:create_time] if args.key?(:create_time) - @labels = args[:labels] if args.key?(:labels) - @maintenance_policy_names = args[:maintenance_policy_names] if args.key?(:maintenance_policy_names) - @maintenance_schedules = args[:maintenance_schedules] if args.key?(:maintenance_schedules) - @maintenance_settings = args[:maintenance_settings] if args.key?(:maintenance_settings) - @name = args[:name] if args.key?(:name) - @producer_metadata = args[:producer_metadata] if args.key?(:producer_metadata) - @provisioned_resources = args[:provisioned_resources] if args.key?(:provisioned_resources) - @slm_instance_template = args[:slm_instance_template] if args.key?(:slm_instance_template) - @slo_metadata = args[:slo_metadata] if args.key?(:slo_metadata) - @software_versions = args[:software_versions] if args.key?(:software_versions) - @state = args[:state] if args.key?(:state) - @tenant_project_id = args[:tenant_project_id] if args.key?(:tenant_project_id) - @update_time = args[:update_time] if args.key?(:update_time) - end - end - - # Maintenance schedule which is exposed to customer and potentially end user, - # indicating published upcoming future maintenance schedule - class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule - include Google::Apis::Core::Hashable - - # Can this scheduled update be rescheduled? By default, it's true and API needs - # to do explicitly check whether it's set, if it's set as false explicitly, it's - # false - # Corresponds to the JSON property `canReschedule` - # @return [Boolean] - attr_accessor :can_reschedule - alias_method :can_reschedule?, :can_reschedule - - # The scheduled end time for the maintenance. - # Corresponds to the JSON property `endTime` - # @return [String] - attr_accessor :end_time - - # The rollout management policy this maintenance schedule is associated with. - # When doing reschedule update request, the reschedule should be against this - # given policy. - # Corresponds to the JSON property `rolloutManagementPolicy` - # @return [String] - attr_accessor :rollout_management_policy - - # The scheduled start time for the maintenance. - # Corresponds to the JSON property `startTime` - # @return [String] - attr_accessor :start_time - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @can_reschedule = args[:can_reschedule] if args.key?(:can_reschedule) - @end_time = args[:end_time] if args.key?(:end_time) - @rollout_management_policy = args[:rollout_management_policy] if args.key?(:rollout_management_policy) - @start_time = args[:start_time] if args.key?(:start_time) - end - end - - # Maintenance settings associated with instance. Allows service producers and - # end users to assign settings that controls maintenance on this instance. - class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings - include Google::Apis::Core::Hashable - - # Optional. Exclude instance from maintenance. When true, rollout service will - # not attempt maintenance on the instance. Rollout service will include the - # instance in reported rollout progress as not attempted. - # Corresponds to the JSON property `exclude` - # @return [Boolean] - attr_accessor :exclude - alias_method :exclude?, :exclude - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @exclude = args[:exclude] if args.key?(:exclude) - end - end - - # Node information for custom per-node SLO implementations. SSA does not support - # per-node SLO, but producers can populate per-node information in SloMetadata - # for custom precomputations. SSA Eligibility Exporter will emit per-node metric - # based on this information. - class GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata - include Google::Apis::Core::Hashable - - # By default node is eligible if instance is eligible. But individual node might - # be excluded from SLO by adding entry here. For semantic see SloMetadata. - # exclusions. If both instance and node level exclusions are present for time - # period, the node level's reason will be reported by Eligibility Exporter. - # Corresponds to the JSON property `exclusions` - # @return [Array] - attr_accessor :exclusions - - # The location of the node, if different from instance location. - # Corresponds to the JSON property `location` - # @return [String] - attr_accessor :location - - # The id of the node. This should be equal to SaasInstanceNode.node_id. - # Corresponds to the JSON property `nodeId` - # @return [String] - attr_accessor :node_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @exclusions = args[:exclusions] if args.key?(:exclusions) - @location = args[:location] if args.key?(:location) - @node_id = args[:node_id] if args.key?(:node_id) - end - end - - # Describes provisioned dataplane resources. - class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource - include Google::Apis::Core::Hashable - - # Type of the resource. This can be either a GCP resource or a custom one (e.g. - # another cloud provider's VM). For GCP compute resources use singular form of - # the names listed in GCP compute API documentation (https://cloud.google.com/ - # compute/docs/reference/rest/v1/), prefixed with 'compute-', for example: ' - # compute-instance', 'compute-disk', 'compute-autoscaler'. - # Corresponds to the JSON property `resourceType` - # @return [String] - attr_accessor :resource_type - - # URL identifying the resource, e.g. "https://www.googleapis.com/compute/v1/ - # projects/...)". - # Corresponds to the JSON property `resourceUrl` - # @return [String] - attr_accessor :resource_url - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @resource_type = args[:resource_type] if args.key?(:resource_type) - @resource_url = args[:resource_url] if args.key?(:resource_url) - end - end - - # SloEligibility is a tuple containing eligibility value: true if an instance is - # eligible for SLO calculation or false if it should be excluded from all SLO- - # related calculations along with a user-defined reason. - class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility - include Google::Apis::Core::Hashable - - # Whether an instance is eligible or ineligible. - # Corresponds to the JSON property `eligible` - # @return [Boolean] - attr_accessor :eligible - alias_method :eligible?, :eligible - - # User-defined reason for the current value of instance eligibility. Usually, - # this can be directly mapped to the internal state. An empty reason is allowed. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @eligible = args[:eligible] if args.key?(:eligible) - @reason = args[:reason] if args.key?(:reason) - end - end - - # SloExclusion represents an exclusion in SLI calculation applies to all SLOs. - class GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion - include Google::Apis::Core::Hashable - - # Exclusion duration. No restrictions on the possible values. When an ongoing - # operation is taking longer than initially expected, an existing entry in the - # exclusion list can be updated by extending the duration. This is supported by - # the subsystem exporting eligibility data as long as such extension is - # committed at least 10 minutes before the original exclusion expiration - - # otherwise it is possible that there will be "gaps" in the exclusion - # application in the exported timeseries. - # Corresponds to the JSON property `duration` - # @return [String] - attr_accessor :duration - - # Human-readable reason for the exclusion. This should be a static string (e.g. " - # Disruptive update in progress") and should not contain dynamically generated - # data (e.g. instance name). Can be left empty. - # Corresponds to the JSON property `reason` - # @return [String] - attr_accessor :reason - - # Name of an SLI that this exclusion applies to. Can be left empty, signaling - # that the instance should be excluded from all SLIs defined in the service SLO - # configuration. - # Corresponds to the JSON property `sliName` - # @return [String] - attr_accessor :sli_name - - # Start time of the exclusion. No alignment (e.g. to a full minute) needed. - # Corresponds to the JSON property `startTime` - # @return [String] - attr_accessor :start_time - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @duration = args[:duration] if args.key?(:duration) - @reason = args[:reason] if args.key?(:reason) - @sli_name = args[:sli_name] if args.key?(:sli_name) - @start_time = args[:start_time] if args.key?(:start_time) - end - end - - # SloMetadata contains resources required for proper SLO classification of the - # instance. - class GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata - include Google::Apis::Core::Hashable - - # SloEligibility is a tuple containing eligibility value: true if an instance is - # eligible for SLO calculation or false if it should be excluded from all SLO- - # related calculations along with a user-defined reason. - # Corresponds to the JSON property `eligibility` - # @return [Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility] - attr_accessor :eligibility - - # List of SLO exclusion windows. When multiple entries in the list match ( - # matching the exclusion time-window against current time point) the exclusion - # reason used in the first matching entry will be published. It is not needed to - # include expired exclusion in this list, as only the currently applicable - # exclusions are taken into account by the eligibility exporting subsystem (the - # historical state of exclusions will be reflected in the historically produced - # timeseries regardless of the current state). This field can be used to mark - # the instance as temporary ineligible for the purpose of SLO calculation. For - # permanent instance SLO exclusion, use of custom instance eligibility is - # recommended. See 'eligibility' field below. - # Corresponds to the JSON property `exclusions` - # @return [Array] - attr_accessor :exclusions - - # Optional. List of nodes. Some producers need to use per-node metadata to - # calculate SLO. This field allows such producers to publish per-node SLO meta - # data, which will be consumed by SSA Eligibility Exporter and published in the - # form of per node metric to Monarch. - # Corresponds to the JSON property `nodes` - # @return [Array] - attr_accessor :nodes - - # Name of the SLO tier the Instance belongs to. This name will be expected to - # match the tiers specified in the service SLO configuration. Field is mandatory - # and must not be empty. - # Corresponds to the JSON property `tier` - # @return [String] - attr_accessor :tier - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @eligibility = args[:eligibility] if args.key?(:eligibility) - @exclusions = args[:exclusions] if args.key?(:exclusions) - @nodes = args[:nodes] if args.key?(:nodes) - @tier = args[:tier] if args.key?(:tier) - end - end - - # - class Instance - include Google::Apis::Core::Hashable - - # The full name of the Google Compute Engine [network](/compute/docs/networks- - # and-firewalls#networks) to which the instance is connected. If left - # unspecified, the `default` network will be used. - # Corresponds to the JSON property `authorizedNetwork` - # @return [String] - attr_accessor :authorized_network - - # Output only. The time the instance was created. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Output only. Endpoint for Discovery API - # Corresponds to the JSON property `discoveryEndpoint` - # @return [String] - attr_accessor :discovery_endpoint - - # User provided name for the instance only used for display purposes. Cannot be - # more than 80 characters. - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # List of messages that describe current statuses of memcached instance. - # Corresponds to the JSON property `instanceMessages` - # @return [Array] - attr_accessor :instance_messages - - # Resource labels to represent user-provided metadata. Refer to cloud - # documentation on labels for more details. https://cloud.google.com/compute/ - # docs/labeling-resources - # Corresponds to the JSON property `labels` - # @return [Hash] - attr_accessor :labels - - # Output only. The full version of memcached server running on this instance. - # System automatically determines the full memcached version for an instance - # based on the input MemcacheVersion. The full version format will be "memcached- - # 1.5.16". - # Corresponds to the JSON property `memcacheFullVersion` - # @return [String] - attr_accessor :memcache_full_version - - # Output only. List of Memcached nodes. Refer to [Node] message for more details. - # Corresponds to the JSON property `memcacheNodes` - # @return [Array] - attr_accessor :memcache_nodes - - # The major version of Memcached software. If not provided, latest supported - # version will be used. Currently the latest supported major version is - # MEMCACHE_1_5. The minor version will be automatically determined by our system - # based on the latest supported minor version. - # Corresponds to the JSON property `memcacheVersion` - # @return [String] - attr_accessor :memcache_version - - # Required. Unique name of the resource in this scope including project and - # location using the form: `projects/`project_id`/locations/`location_id`/ - # instances/`instance_id`` Note: Memcached instances are managed and addressed - # at regional level so location_id here refers to a GCP region; however, users - # may choose which zones Memcached nodes within an instances should be - # provisioned in. Refer to [zones] field for more details. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Configuration for a Memcached Node. - # Corresponds to the JSON property `nodeConfig` - # @return [Google::Apis::MemcacheV1::NodeConfig] - attr_accessor :node_config - - # Required. Number of nodes in the Memcached instance. - # Corresponds to the JSON property `nodeCount` - # @return [Fixnum] - attr_accessor :node_count - - # Optional: User defined parameters to apply to the memcached process on each - # node. - # Corresponds to the JSON property `parameters` - # @return [Google::Apis::MemcacheV1::MemcacheParameters] - attr_accessor :parameters - - # Output only. The state of this Memcached instance. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - # Output only. The time the instance was updated. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time - - # Zones where Memcached nodes should be provisioned in. Memcached nodes will be - # equally distributed across these zones. If not provided, the service will by - # default create nodes in all zones in the region for the instance. - # Corresponds to the JSON property `zones` - # @return [Array] - attr_accessor :zones - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @authorized_network = args[:authorized_network] if args.key?(:authorized_network) - @create_time = args[:create_time] if args.key?(:create_time) - @discovery_endpoint = args[:discovery_endpoint] if args.key?(:discovery_endpoint) - @display_name = args[:display_name] if args.key?(:display_name) - @instance_messages = args[:instance_messages] if args.key?(:instance_messages) - @labels = args[:labels] if args.key?(:labels) - @memcache_full_version = args[:memcache_full_version] if args.key?(:memcache_full_version) - @memcache_nodes = args[:memcache_nodes] if args.key?(:memcache_nodes) - @memcache_version = args[:memcache_version] if args.key?(:memcache_version) - @name = args[:name] if args.key?(:name) - @node_config = args[:node_config] if args.key?(:node_config) - @node_count = args[:node_count] if args.key?(:node_count) - @parameters = args[:parameters] if args.key?(:parameters) - @state = args[:state] if args.key?(:state) - @update_time = args[:update_time] if args.key?(:update_time) - @zones = args[:zones] if args.key?(:zones) - end - end - - # - class InstanceMessage - include Google::Apis::Core::Hashable - - # A code that correspond to one type of user-facing message. - # Corresponds to the JSON property `code` - # @return [String] - attr_accessor :code - - # Message on memcached instance which will be exposed to users. - # Corresponds to the JSON property `message` - # @return [String] - attr_accessor :message - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @code = args[:code] if args.key?(:code) - @message = args[:message] if args.key?(:message) - end - end - - # Response for ListInstances. - class ListInstancesResponse - include Google::Apis::Core::Hashable - - # Token to retrieve the next page of results, or empty if there are no more - # results in the list. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # A list of Memcached instances in the project in the specified location, or - # across all locations. If the `location_id` in the parent field of the request - # is "-", all regions available to the project are queried, and the results - # aggregated. - # Corresponds to the JSON property `resources` - # @return [Array] - attr_accessor :resources - - # Locations that could not be reached. - # Corresponds to the JSON property `unreachable` - # @return [Array] - attr_accessor :unreachable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @resources = args[:resources] if args.key?(:resources) - @unreachable = args[:unreachable] if args.key?(:unreachable) - end - end - - # The response message for Locations.ListLocations. - class ListLocationsResponse - include Google::Apis::Core::Hashable - - # A list of locations that matches the specified filter in the request. - # Corresponds to the JSON property `locations` - # @return [Array] - attr_accessor :locations - - # The standard List next-page token. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @locations = args[:locations] if args.key?(:locations) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # The response message for Operations.ListOperations. - class ListOperationsResponse - include Google::Apis::Core::Hashable - - # The standard List next-page token. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # A list of operations that matches the specified filter in the request. - # Corresponds to the JSON property `operations` - # @return [Array] - attr_accessor :operations - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @operations = args[:operations] if args.key?(:operations) - end - end - - # A resource that represents Google Cloud Platform location. - class Location - include Google::Apis::Core::Hashable - - # The friendly name for this location, typically a nearby city name. For example, - # "Tokyo". - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # Cross-service attributes for the location. For example `"cloud.googleapis.com/ - # region": "us-east1"` - # Corresponds to the JSON property `labels` - # @return [Hash] - attr_accessor :labels - - # The canonical id for this location. For example: `"us-east1"`. - # Corresponds to the JSON property `locationId` - # @return [String] - attr_accessor :location_id - - # Service-specific metadata. For example the available capacity at the given - # location. - # Corresponds to the JSON property `metadata` - # @return [Hash] - attr_accessor :metadata - - # Resource name for the location, which may vary between implementations. For - # example: `"projects/example-project/locations/us-east1"` - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @display_name = args[:display_name] if args.key?(:display_name) - @labels = args[:labels] if args.key?(:labels) - @location_id = args[:location_id] if args.key?(:location_id) - @metadata = args[:metadata] if args.key?(:metadata) - @name = args[:name] if args.key?(:name) - end - end - - # Metadata for the given google.cloud.location.Location. - class LocationMetadata - include Google::Apis::Core::Hashable - - # Output only. The set of available zones in the location. The map is keyed by - # the lowercase ID of each zone, as defined by GCE. These keys can be specified - # in the `zones` field when creating a Memcached instance. - # Corresponds to the JSON property `availableZones` - # @return [Hash] - attr_accessor :available_zones - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @available_zones = args[:available_zones] if args.key?(:available_zones) - end - end - - # - class MemcacheParameters - include Google::Apis::Core::Hashable - - # Output only. The unique ID associated with this set of parameters. Users can - # use this id to determine if the parameters associated with the instance differ - # from the parameters associated with the nodes and any action needs to be taken - # to apply parameters on nodes. - # Corresponds to the JSON property `id` - # @return [String] - attr_accessor :id - - # User defined set of parameters to use in the memcached process. - # Corresponds to the JSON property `params` - # @return [Hash] - attr_accessor :params - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @id = args[:id] if args.key?(:id) - @params = args[:params] if args.key?(:params) - end - end - - # - class Node - include Google::Apis::Core::Hashable - - # Output only. Hostname or IP address of the Memcached node used by the clients - # to connect to the Memcached server on this node. - # Corresponds to the JSON property `host` - # @return [String] - attr_accessor :host - - # Output only. Identifier of the Memcached node. The node id does not include - # project or location like the Memcached instance name. - # Corresponds to the JSON property `nodeId` - # @return [String] - attr_accessor :node_id - - # User defined parameters currently applied to the node. - # Corresponds to the JSON property `parameters` - # @return [Google::Apis::MemcacheV1::MemcacheParameters] - attr_accessor :parameters - - # Output only. The port number of the Memcached server on this node. - # Corresponds to the JSON property `port` - # @return [Fixnum] - attr_accessor :port - - # Output only. Current state of the Memcached node. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - # Output only. Location (GCP Zone) for the Memcached node. - # Corresponds to the JSON property `zone` - # @return [String] - attr_accessor :zone - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @host = args[:host] if args.key?(:host) - @node_id = args[:node_id] if args.key?(:node_id) - @parameters = args[:parameters] if args.key?(:parameters) - @port = args[:port] if args.key?(:port) - @state = args[:state] if args.key?(:state) - @zone = args[:zone] if args.key?(:zone) - end - end - - # Configuration for a Memcached Node. - class NodeConfig - include Google::Apis::Core::Hashable - - # Required. Number of cpus per Memcached node. - # Corresponds to the JSON property `cpuCount` - # @return [Fixnum] - attr_accessor :cpu_count - - # Required. Memory size in MiB for each Memcached node. - # Corresponds to the JSON property `memorySizeMb` - # @return [Fixnum] - attr_accessor :memory_size_mb - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @cpu_count = args[:cpu_count] if args.key?(:cpu_count) - @memory_size_mb = args[:memory_size_mb] if args.key?(:memory_size_mb) - end - end - - # This resource represents a long-running operation that is the result of a - # network API call. - class Operation - include Google::Apis::Core::Hashable - - # 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. - # Corresponds to the JSON property `done` - # @return [Boolean] - attr_accessor :done - alias_method :done?, :done - - # 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). - # Corresponds to the JSON property `error` - # @return [Google::Apis::MemcacheV1::Status] - attr_accessor :error - - # 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. - # Corresponds to the JSON property `metadata` - # @return [Hash] - attr_accessor :metadata - - # 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``. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # 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`. - # Corresponds to the JSON property `response` - # @return [Hash] - attr_accessor :response - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @done = args[:done] if args.key?(:done) - @error = args[:error] if args.key?(:error) - @metadata = args[:metadata] if args.key?(:metadata) - @name = args[:name] if args.key?(:name) - @response = args[:response] if args.key?(:response) - end - end - - # Represents the metadata of a long-running operation. - class OperationMetadata - include Google::Apis::Core::Hashable - - # Output only. API version used to start the operation. - # Corresponds to the JSON property `apiVersion` - # @return [String] - attr_accessor :api_version - - # Output only. Identifies whether the user has requested cancellation of the - # operation. Operations that have successfully been cancelled have Operation. - # error value with a google.rpc.Status.code of 1, corresponding to `Code. - # CANCELLED`. - # Corresponds to the JSON property `cancelRequested` - # @return [Boolean] - attr_accessor :cancel_requested - alias_method :cancel_requested?, :cancel_requested - - # Output only. Time when the operation was created. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Output only. Time when the operation finished running. - # Corresponds to the JSON property `endTime` - # @return [String] - attr_accessor :end_time - - # Output only. Human-readable status of the operation, if any. - # Corresponds to the JSON property `statusDetail` - # @return [String] - attr_accessor :status_detail - - # Output only. Server-defined resource path for the target of the operation. - # Corresponds to the JSON property `target` - # @return [String] - attr_accessor :target - - # Output only. Name of the verb executed by the operation. - # Corresponds to the JSON property `verb` - # @return [String] - attr_accessor :verb - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @api_version = args[:api_version] if args.key?(:api_version) - @cancel_requested = args[:cancel_requested] if args.key?(:cancel_requested) - @create_time = args[:create_time] if args.key?(:create_time) - @end_time = args[:end_time] if args.key?(:end_time) - @status_detail = args[:status_detail] if args.key?(:status_detail) - @target = args[:target] if args.key?(:target) - @verb = args[:verb] if args.key?(:verb) - end - end - - # 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). - class Status - include Google::Apis::Core::Hashable - - # The status code, which should be an enum value of google.rpc.Code. - # Corresponds to the JSON property `code` - # @return [Fixnum] - attr_accessor :code - - # A list of messages that carry the error details. There is a common set of - # message types for APIs to use. - # Corresponds to the JSON property `details` - # @return [Array>] - attr_accessor :details - - # 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. - # Corresponds to the JSON property `message` - # @return [String] - attr_accessor :message - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @code = args[:code] if args.key?(:code) - @details = args[:details] if args.key?(:details) - @message = args[:message] if args.key?(:message) - end - end - - # Request for UpdateParameters. - class UpdateParametersRequest - include Google::Apis::Core::Hashable - - # The parameters to apply to the instance. - # Corresponds to the JSON property `parameters` - # @return [Google::Apis::MemcacheV1::MemcacheParameters] - attr_accessor :parameters - - # Required. Mask of fields to update. - # Corresponds to the JSON property `updateMask` - # @return [String] - attr_accessor :update_mask - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @parameters = args[:parameters] if args.key?(:parameters) - @update_mask = args[:update_mask] if args.key?(:update_mask) - end - end - - # - class ZoneMetadata - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - end - end -end diff --git a/generated/google/apis/memcache_v1/representations.rb b/generated/google/apis/memcache_v1/representations.rb deleted file mode 100644 index cb08c6089..000000000 --- a/generated/google/apis/memcache_v1/representations.rb +++ /dev/null @@ -1,471 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module MemcacheV1 - - class ApplyParametersRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CancelOperationRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Empty - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudMemcacheV1OperationMetadata - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSaasacceleratorManagementProvidersV1Instance - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Instance - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class InstanceMessage - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListInstancesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListLocationsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListOperationsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Location - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class LocationMetadata - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class MemcacheParameters - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Node - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class NodeConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Operation - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OperationMetadata - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Status - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UpdateParametersRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ZoneMetadata - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ApplyParametersRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :apply_all, as: 'applyAll' - collection :node_ids, as: 'nodeIds' - end - end - - class CancelOperationRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class Empty - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class GoogleCloudMemcacheV1OperationMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :api_version, as: 'apiVersion' - property :cancel_requested, as: 'cancelRequested' - property :create_time, as: 'createTime' - property :end_time, as: 'endTime' - property :status_detail, as: 'statusDetail' - property :target, as: 'target' - property :verb, as: 'verb' - end - end - - class GoogleCloudSaasacceleratorManagementProvidersV1Instance - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :consumer_defined_name, as: 'consumerDefinedName' - property :create_time, as: 'createTime' - hash :labels, as: 'labels' - hash :maintenance_policy_names, as: 'maintenancePolicyNames' - hash :maintenance_schedules, as: 'maintenanceSchedules', class: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule, decorator: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule::Representation - - property :maintenance_settings, as: 'maintenanceSettings', class: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings, decorator: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings::Representation - - property :name, as: 'name' - hash :producer_metadata, as: 'producerMetadata' - collection :provisioned_resources, as: 'provisionedResources', class: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource, decorator: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource::Representation - - property :slm_instance_template, as: 'slmInstanceTemplate' - property :slo_metadata, as: 'sloMetadata', class: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata, decorator: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata::Representation - - hash :software_versions, as: 'softwareVersions' - property :state, as: 'state' - property :tenant_project_id, as: 'tenantProjectId' - property :update_time, as: 'updateTime' - end - end - - class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSchedule - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :can_reschedule, as: 'canReschedule' - property :end_time, as: 'endTime' - property :rollout_management_policy, as: 'rolloutManagementPolicy' - property :start_time, as: 'startTime' - end - end - - class GoogleCloudSaasacceleratorManagementProvidersV1MaintenanceSettings - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :exclude, as: 'exclude' - end - end - - class GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :exclusions, as: 'exclusions', class: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion, decorator: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion::Representation - - property :location, as: 'location' - property :node_id, as: 'nodeId' - end - end - - class GoogleCloudSaasacceleratorManagementProvidersV1ProvisionedResource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :resource_type, as: 'resourceType' - property :resource_url, as: 'resourceUrl' - end - end - - class GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :eligible, as: 'eligible' - property :reason, as: 'reason' - end - end - - class GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :duration, as: 'duration' - property :reason, as: 'reason' - property :sli_name, as: 'sliName' - property :start_time, as: 'startTime' - end - end - - class GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :eligibility, as: 'eligibility', class: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility, decorator: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility::Representation - - collection :exclusions, as: 'exclusions', class: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion, decorator: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion::Representation - - collection :nodes, as: 'nodes', class: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata, decorator: Google::Apis::MemcacheV1::GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata::Representation - - property :tier, as: 'tier' - end - end - - class Instance - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :authorized_network, as: 'authorizedNetwork' - property :create_time, as: 'createTime' - property :discovery_endpoint, as: 'discoveryEndpoint' - property :display_name, as: 'displayName' - collection :instance_messages, as: 'instanceMessages', class: Google::Apis::MemcacheV1::InstanceMessage, decorator: Google::Apis::MemcacheV1::InstanceMessage::Representation - - hash :labels, as: 'labels' - property :memcache_full_version, as: 'memcacheFullVersion' - collection :memcache_nodes, as: 'memcacheNodes', class: Google::Apis::MemcacheV1::Node, decorator: Google::Apis::MemcacheV1::Node::Representation - - property :memcache_version, as: 'memcacheVersion' - property :name, as: 'name' - property :node_config, as: 'nodeConfig', class: Google::Apis::MemcacheV1::NodeConfig, decorator: Google::Apis::MemcacheV1::NodeConfig::Representation - - property :node_count, as: 'nodeCount' - property :parameters, as: 'parameters', class: Google::Apis::MemcacheV1::MemcacheParameters, decorator: Google::Apis::MemcacheV1::MemcacheParameters::Representation - - property :state, as: 'state' - property :update_time, as: 'updateTime' - collection :zones, as: 'zones' - end - end - - class InstanceMessage - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :code, as: 'code' - property :message, as: 'message' - end - end - - class ListInstancesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :resources, as: 'resources', class: Google::Apis::MemcacheV1::Instance, decorator: Google::Apis::MemcacheV1::Instance::Representation - - collection :unreachable, as: 'unreachable' - end - end - - class ListLocationsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :locations, as: 'locations', class: Google::Apis::MemcacheV1::Location, decorator: Google::Apis::MemcacheV1::Location::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class ListOperationsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :operations, as: 'operations', class: Google::Apis::MemcacheV1::Operation, decorator: Google::Apis::MemcacheV1::Operation::Representation - - end - end - - class Location - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :display_name, as: 'displayName' - hash :labels, as: 'labels' - property :location_id, as: 'locationId' - hash :metadata, as: 'metadata' - property :name, as: 'name' - end - end - - class LocationMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :available_zones, as: 'availableZones', class: Google::Apis::MemcacheV1::ZoneMetadata, decorator: Google::Apis::MemcacheV1::ZoneMetadata::Representation - - end - end - - class MemcacheParameters - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :id, as: 'id' - hash :params, as: 'params' - end - end - - class Node - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :host, as: 'host' - property :node_id, as: 'nodeId' - property :parameters, as: 'parameters', class: Google::Apis::MemcacheV1::MemcacheParameters, decorator: Google::Apis::MemcacheV1::MemcacheParameters::Representation - - property :port, as: 'port' - property :state, as: 'state' - property :zone, as: 'zone' - end - end - - class NodeConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :cpu_count, as: 'cpuCount' - property :memory_size_mb, as: 'memorySizeMb' - end - end - - class Operation - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :done, as: 'done' - property :error, as: 'error', class: Google::Apis::MemcacheV1::Status, decorator: Google::Apis::MemcacheV1::Status::Representation - - hash :metadata, as: 'metadata' - property :name, as: 'name' - hash :response, as: 'response' - end - end - - class OperationMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :api_version, as: 'apiVersion' - property :cancel_requested, as: 'cancelRequested' - property :create_time, as: 'createTime' - property :end_time, as: 'endTime' - property :status_detail, as: 'statusDetail' - property :target, as: 'target' - property :verb, as: 'verb' - end - end - - class Status - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :code, as: 'code' - collection :details, as: 'details' - property :message, as: 'message' - end - end - - class UpdateParametersRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :parameters, as: 'parameters', class: Google::Apis::MemcacheV1::MemcacheParameters, decorator: Google::Apis::MemcacheV1::MemcacheParameters::Representation - - property :update_mask, as: 'updateMask' - end - end - - class ZoneMetadata - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - end - end -end diff --git a/generated/google/apis/memcache_v1/service.rb b/generated/google/apis/memcache_v1/service.rb deleted file mode 100644 index 74789eeb1..000000000 --- a/generated/google/apis/memcache_v1/service.rb +++ /dev/null @@ -1,545 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module MemcacheV1 - # Cloud Memorystore for Memcached API - # - # Google Cloud Memorystore for Memcached API is used for creating and managing - # Memcached instances in GCP. - # - # @example - # require 'google/apis/memcache_v1' - # - # Memcache = Google::Apis::MemcacheV1 # Alias the module - # service = Memcache::CloudMemorystoreforMemcachedService.new - # - # @see https://cloud.google.com/memorystore/ - class CloudMemorystoreforMemcachedService < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - - # @return [String] - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - attr_accessor :quota_user - - def initialize - super('https://memcache.googleapis.com/', '') - @batch_path = 'batch' - end - - # Gets information about a location. - # @param [String] name - # Resource name for the location. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MemcacheV1::Location] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MemcacheV1::Location] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/{+name}', options) - command.response_representation = Google::Apis::MemcacheV1::Location::Representation - command.response_class = Google::Apis::MemcacheV1::Location - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists information about the supported locations for this service. - # @param [String] name - # The resource that owns the locations collection, if applicable. - # @param [String] filter - # The standard list filter. - # @param [Fixnum] page_size - # The standard list page size. - # @param [String] page_token - # The standard list page token. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MemcacheV1::ListLocationsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MemcacheV1::ListLocationsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/{+name}/locations', options) - command.response_representation = Google::Apis::MemcacheV1::ListLocationsResponse::Representation - command.response_class = Google::Apis::MemcacheV1::ListLocationsResponse - command.params['name'] = name unless name.nil? - command.query['filter'] = filter unless filter.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # ApplyParameters will update current set of Parameters to the set of specified - # nodes of the Memcached Instance. - # @param [String] name - # Required. Resource name of the Memcached instance for which parameter group - # updates should be applied. - # @param [Google::Apis::MemcacheV1::ApplyParametersRequest] apply_parameters_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MemcacheV1::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MemcacheV1::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def apply_instance_parameters(name, apply_parameters_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1/{+name}:applyParameters', options) - command.request_representation = Google::Apis::MemcacheV1::ApplyParametersRequest::Representation - command.request_object = apply_parameters_request_object - command.response_representation = Google::Apis::MemcacheV1::Operation::Representation - command.response_class = Google::Apis::MemcacheV1::Operation - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a new Instance in a given project and location. - # @param [String] parent - # Required. The resource name of the instance location using the form: `projects/ - # `project_id`/locations/`location_id`` where `location_id` refers to a GCP - # region - # @param [Google::Apis::MemcacheV1::Instance] instance_object - # @param [String] instance_id - # Required. The logical name of the Memcached instance in the user project with - # the following restrictions: * Must contain only lowercase letters, numbers, - # and hyphens. * Must start with a letter. * Must be between 1-40 characters. * - # Must end with a number or a letter. * Must be unique within the user project / - # location - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MemcacheV1::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MemcacheV1::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_project_location_instance(parent, instance_object = nil, instance_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1/{+parent}/instances', options) - command.request_representation = Google::Apis::MemcacheV1::Instance::Representation - command.request_object = instance_object - command.response_representation = Google::Apis::MemcacheV1::Operation::Representation - command.response_class = Google::Apis::MemcacheV1::Operation - command.params['parent'] = parent unless parent.nil? - command.query['instanceId'] = instance_id unless instance_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a single Instance. - # @param [String] name - # Required. Memcached instance resource name in the format: `projects/` - # project_id`/locations/`location_id`/instances/`instance_id`` where ` - # location_id` refers to a GCP region - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MemcacheV1::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MemcacheV1::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_project_location_instance(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v1/{+name}', options) - command.response_representation = Google::Apis::MemcacheV1::Operation::Representation - command.response_class = Google::Apis::MemcacheV1::Operation - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets details of a single Instance. - # @param [String] name - # Required. Memcached instance resource name in the format: `projects/` - # project_id`/locations/`location_id`/instances/`instance_id`` where ` - # location_id` refers to a GCP region - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MemcacheV1::Instance] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MemcacheV1::Instance] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_location_instance(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/{+name}', options) - command.response_representation = Google::Apis::MemcacheV1::Instance::Representation - command.response_class = Google::Apis::MemcacheV1::Instance - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists Instances in a given project and location. - # @param [String] parent - # Required. The resource name of the instance location using the form: `projects/ - # `project_id`/locations/`location_id`` where `location_id` refers to a GCP - # region - # @param [String] filter - # List filter. For example, exclude all Memcached instances with name as my- - # instance by specifying "name != my-instance". - # @param [String] order_by - # Sort results. Supported values are "name", "name desc" or "" (unsorted). - # @param [Fixnum] page_size - # The maximum number of items to return. If not specified, a default value of - # 1000 will be used by the service. Regardless of the page_size value, the - # response may include a partial list and a caller should only rely on response' - # s next_page_token to determine if there are more instances left to be queried. - # @param [String] page_token - # The next_page_token value returned from a previous List request, if any. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MemcacheV1::ListInstancesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MemcacheV1::ListInstancesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_location_instances(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/{+parent}/instances', options) - command.response_representation = Google::Apis::MemcacheV1::ListInstancesResponse::Representation - command.response_class = Google::Apis::MemcacheV1::ListInstancesResponse - command.params['parent'] = parent unless parent.nil? - command.query['filter'] = filter unless filter.nil? - command.query['orderBy'] = order_by unless order_by.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates an existing Instance in a given project and location. - # @param [String] name - # Required. Unique name of the resource in this scope including project and - # location using the form: `projects/`project_id`/locations/`location_id`/ - # instances/`instance_id`` Note: Memcached instances are managed and addressed - # at regional level so location_id here refers to a GCP region; however, users - # may choose which zones Memcached nodes within an instances should be - # provisioned in. Refer to [zones] field for more details. - # @param [Google::Apis::MemcacheV1::Instance] instance_object - # @param [String] update_mask - # Required. Mask of fields to update. * `displayName` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MemcacheV1::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MemcacheV1::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_project_location_instance(name, instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v1/{+name}', options) - command.request_representation = Google::Apis::MemcacheV1::Instance::Representation - command.request_object = instance_object - command.response_representation = Google::Apis::MemcacheV1::Operation::Representation - command.response_class = Google::Apis::MemcacheV1::Operation - command.params['name'] = name unless name.nil? - command.query['updateMask'] = update_mask unless update_mask.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates the defined Memcached Parameters for an existing Instance. This method - # only stages the parameters, it must be followed by ApplyParameters to apply - # the parameters to nodes of the Memcached Instance. - # @param [String] name - # Required. Resource name of the Memcached instance for which the parameters - # should be updated. - # @param [Google::Apis::MemcacheV1::UpdateParametersRequest] update_parameters_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MemcacheV1::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MemcacheV1::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_instance_parameters(name, update_parameters_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v1/{+name}:updateParameters', options) - command.request_representation = Google::Apis::MemcacheV1::UpdateParametersRequest::Representation - command.request_object = update_parameters_request_object - command.response_representation = Google::Apis::MemcacheV1::Operation::Representation - command.response_class = Google::Apis::MemcacheV1::Operation - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # 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`. - # @param [String] name - # The name of the operation resource to be cancelled. - # @param [Google::Apis::MemcacheV1::CancelOperationRequest] cancel_operation_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MemcacheV1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MemcacheV1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1/{+name}:cancel', options) - command.request_representation = Google::Apis::MemcacheV1::CancelOperationRequest::Representation - command.request_object = cancel_operation_request_object - command.response_representation = Google::Apis::MemcacheV1::Empty::Representation - command.response_class = Google::Apis::MemcacheV1::Empty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a long-running operation. This method indicates that the client is no - # longer interested in the operation result. It does not cancel the operation. - # If the server doesn't support this method, it returns `google.rpc.Code. - # UNIMPLEMENTED`. - # @param [String] name - # The name of the operation resource to be deleted. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MemcacheV1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MemcacheV1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v1/{+name}', options) - command.response_representation = Google::Apis::MemcacheV1::Empty::Representation - command.response_class = Google::Apis::MemcacheV1::Empty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # 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. - # @param [String] name - # The name of the operation resource. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MemcacheV1::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MemcacheV1::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/{+name}', options) - command.response_representation = Google::Apis::MemcacheV1::Operation::Representation - command.response_class = Google::Apis::MemcacheV1::Operation - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # 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. - # @param [String] name - # The name of the operation's parent resource. - # @param [String] filter - # The standard list filter. - # @param [Fixnum] page_size - # The standard list page size. - # @param [String] page_token - # The standard list page token. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::MemcacheV1::ListOperationsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::MemcacheV1::ListOperationsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1/{+name}/operations', options) - command.response_representation = Google::Apis::MemcacheV1::ListOperationsResponse::Representation - command.response_class = Google::Apis::MemcacheV1::ListOperationsResponse - command.params['name'] = name unless name.nil? - command.query['filter'] = filter unless filter.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - end - end - end - end -end diff --git a/generated/google/apis/safebrowsing_v4.rb b/generated/google/apis/safebrowsing_v4.rb index 8f11b32d1..1e2c20c55 100644 --- a/generated/google/apis/safebrowsing_v4.rb +++ b/generated/google/apis/safebrowsing_v4.rb @@ -29,7 +29,7 @@ module Google # @see https://developers.google.com/safe-browsing/ module SafebrowsingV4 VERSION = 'V4' - REVISION = '20200801' + REVISION = '20200825' end end end diff --git a/generated/google/apis/sasportal_v1alpha1.rb b/generated/google/apis/sasportal_v1alpha1.rb index f1cbece42..0957acd48 100644 --- a/generated/google/apis/sasportal_v1alpha1.rb +++ b/generated/google/apis/sasportal_v1alpha1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/spectrum-access-system/ module SasportalV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200817' + REVISION = '20200824' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' diff --git a/generated/google/apis/securitycenter_v1p1alpha1.rb b/generated/google/apis/securitycenter_v1p1alpha1.rb deleted file mode 100644 index cad985b07..000000000 --- a/generated/google/apis/securitycenter_v1p1alpha1.rb +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'google/apis/securitycenter_v1p1alpha1/service.rb' -require 'google/apis/securitycenter_v1p1alpha1/classes.rb' -require 'google/apis/securitycenter_v1p1alpha1/representations.rb' - -module Google - module Apis - # Security Command Center API - # - # Security Command Center API provides access to temporal views of assets and - # findings within an organization. - # - # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview - module SecuritycenterV1p1alpha1 - VERSION = 'V1p1alpha1' - REVISION = '20200820' - - # View and manage your data across Google Cloud Platform services - AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' - end - end -end diff --git a/generated/google/apis/securitycenter_v1p1alpha1/classes.rb b/generated/google/apis/securitycenter_v1p1alpha1/classes.rb deleted file mode 100644 index 481e9c348..000000000 --- a/generated/google/apis/securitycenter_v1p1alpha1/classes.rb +++ /dev/null @@ -1,869 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module SecuritycenterV1p1alpha1 - - # 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 ````. - class Empty - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - - # Security Command Center finding. A finding is a record of assessment data like - # security, risk, health, or privacy, that is ingested into Security Command - # Center for presentation, notification, analysis, policy testing, and - # enforcement. For example, a cross-site scripting (XSS) vulnerability in an App - # Engine application is a finding. - class Finding - include Google::Apis::Core::Hashable - - # The additional taxonomy group within findings from a given source. This field - # is immutable after creation time. Example: "XSS_FLASH_INJECTION" - # Corresponds to the JSON property `category` - # @return [String] - attr_accessor :category - - # The time at which the finding was created in Security Command Center. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # The time at which the event took place, or when an update to the finding - # occurred. For example, if the finding represents an open firewall it would - # capture the time the detector believes the firewall became open. The accuracy - # is determined by the detector. If the finding were to be resolved afterward, - # this time would reflect when the finding was resolved. - # Corresponds to the JSON property `eventTime` - # @return [String] - attr_accessor :event_time - - # The URI that, if available, points to a web page outside of Security Command - # Center where additional information about the finding can be found. This field - # is guaranteed to be either empty or a well formed URL. - # Corresponds to the JSON property `externalUri` - # @return [String] - attr_accessor :external_uri - - # The relative resource name of this finding. See: https://cloud.google.com/apis/ - # design/resource_names#relative_resource_name Example: "organizations/` - # organization_id`/sources/`source_id`/findings/`finding_id`" - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The relative resource name of the source the finding belongs to. See: https:// - # cloud.google.com/apis/design/resource_names#relative_resource_name This field - # is immutable after creation time. For example: "organizations/`organization_id` - # /sources/`source_id`" - # Corresponds to the JSON property `parent` - # @return [String] - attr_accessor :parent - - # For findings on Google Cloud resources, the full resource name of the Google - # Cloud resource this finding is for. See: https://cloud.google.com/apis/design/ - # resource_names#full_resource_name When the finding is for a non-Google Cloud - # resource, the resourceName can be a customer or partner defined string. This - # field is immutable after creation time. - # Corresponds to the JSON property `resourceName` - # @return [String] - attr_accessor :resource_name - - # User specified security marks that are attached to the parent Security Command - # Center resource. Security marks are scoped within a Security Command Center - # organization -- they can be modified and viewed by all users who have proper - # permissions on the organization. - # Corresponds to the JSON property `securityMarks` - # @return [Google::Apis::SecuritycenterV1p1alpha1::SecurityMarks] - attr_accessor :security_marks - - # Source specific properties. These properties are managed by the source that - # writes the finding. The key names in the source_properties map must be between - # 1 and 255 characters, and must start with a letter and contain alphanumeric - # characters or underscores only. - # Corresponds to the JSON property `sourceProperties` - # @return [Hash] - attr_accessor :source_properties - - # The state of the finding. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @category = args[:category] if args.key?(:category) - @create_time = args[:create_time] if args.key?(:create_time) - @event_time = args[:event_time] if args.key?(:event_time) - @external_uri = args[:external_uri] if args.key?(:external_uri) - @name = args[:name] if args.key?(:name) - @parent = args[:parent] if args.key?(:parent) - @resource_name = args[:resource_name] if args.key?(:resource_name) - @security_marks = args[:security_marks] if args.key?(:security_marks) - @source_properties = args[:source_properties] if args.key?(:source_properties) - @state = args[:state] if args.key?(:state) - end - end - - # Cloud SCC's Notification - class GoogleCloudSecuritycenterV1NotificationMessage - include Google::Apis::Core::Hashable - - # Security Command Center finding. A finding is a record of assessment data like - # security, risk, health, or privacy, that is ingested into Security Command - # Center for presentation, notification, analysis, policy testing, and - # enforcement. For example, a cross-site scripting (XSS) vulnerability in an App - # Engine application is a finding. - # Corresponds to the JSON property `finding` - # @return [Google::Apis::SecuritycenterV1p1alpha1::Finding] - attr_accessor :finding - - # Name of the notification config that generated current notification. - # Corresponds to the JSON property `notificationConfigName` - # @return [String] - attr_accessor :notification_config_name - - # Information related to the Google Cloud resource. - # Corresponds to the JSON property `resource` - # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1Resource] - attr_accessor :resource - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @finding = args[:finding] if args.key?(:finding) - @notification_config_name = args[:notification_config_name] if args.key?(:notification_config_name) - @resource = args[:resource] if args.key?(:resource) - end - end - - # Information related to the Google Cloud resource. - class GoogleCloudSecuritycenterV1Resource - include Google::Apis::Core::Hashable - - # The full resource name of the resource. See: https://cloud.google.com/apis/ - # design/resource_names#full_resource_name - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The full resource name of resource's parent. - # Corresponds to the JSON property `parent` - # @return [String] - attr_accessor :parent - - # The human readable name of resource's parent. - # Corresponds to the JSON property `parentDisplayName` - # @return [String] - attr_accessor :parent_display_name - - # The full resource name of project that the resource belongs to. - # Corresponds to the JSON property `project` - # @return [String] - attr_accessor :project - - # The human readable name of project that the resource belongs to. - # Corresponds to the JSON property `projectDisplayName` - # @return [String] - attr_accessor :project_display_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - @parent = args[:parent] if args.key?(:parent) - @parent_display_name = args[:parent_display_name] if args.key?(:parent_display_name) - @project = args[:project] if args.key?(:project) - @project_display_name = args[:project_display_name] if args.key?(:project_display_name) - end - end - - # Response of asset discovery run - class GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse - include Google::Apis::Core::Hashable - - # The duration between asset discovery run start and end - # Corresponds to the JSON property `duration` - # @return [String] - attr_accessor :duration - - # The state of an asset discovery run. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @duration = args[:duration] if args.key?(:duration) - @state = args[:state] if args.key?(:state) - end - end - - # Response of asset discovery run - class GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse - include Google::Apis::Core::Hashable - - # The duration between asset discovery run start and end - # Corresponds to the JSON property `duration` - # @return [String] - attr_accessor :duration - - # The state of an asset discovery run. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @duration = args[:duration] if args.key?(:duration) - @state = args[:state] if args.key?(:state) - end - end - - # Security Command Center representation of a Google Cloud resource. The Asset - # is a Security Command Center resource that captures information about a single - # Google Cloud resource. All modifications to an Asset are only within the - # context of Security Command Center and don't affect the referenced Google - # Cloud resource. - class GoogleCloudSecuritycenterV1p1beta1Asset - include Google::Apis::Core::Hashable - - # The time at which the asset was created in Security Command Center. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Cloud IAM Policy information associated with the Google Cloud resource - # described by the Security Command Center asset. This information is managed - # and defined by the Google Cloud resource and cannot be modified by the user. - # Corresponds to the JSON property `iamPolicy` - # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1IamPolicy] - attr_accessor :iam_policy - - # The relative resource name of this asset. See: https://cloud.google.com/apis/ - # design/resource_names#relative_resource_name Example: "organizations/` - # organization_id`/assets/`asset_id`". - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Resource managed properties. These properties are managed and defined by the - # Google Cloud resource and cannot be modified by the user. - # Corresponds to the JSON property `resourceProperties` - # @return [Hash] - attr_accessor :resource_properties - - # Security Command Center managed properties. These properties are managed by - # Security Command Center and cannot be modified by the user. - # Corresponds to the JSON property `securityCenterProperties` - # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties] - attr_accessor :security_center_properties - - # User specified security marks that are attached to the parent Security Command - # Center resource. Security marks are scoped within a Security Command Center - # organization -- they can be modified and viewed by all users who have proper - # permissions on the organization. - # Corresponds to the JSON property `securityMarks` - # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] - attr_accessor :security_marks - - # The time at which the asset was last updated, added, or deleted in Cloud SCC. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @create_time = args[:create_time] if args.key?(:create_time) - @iam_policy = args[:iam_policy] if args.key?(:iam_policy) - @name = args[:name] if args.key?(:name) - @resource_properties = args[:resource_properties] if args.key?(:resource_properties) - @security_center_properties = args[:security_center_properties] if args.key?(:security_center_properties) - @security_marks = args[:security_marks] if args.key?(:security_marks) - @update_time = args[:update_time] if args.key?(:update_time) - end - end - - # Security Command Center finding. A finding is a record of assessment data ( - # security, risk, health or privacy) ingested into Security Command Center for - # presentation, notification, analysis, policy testing, and enforcement. For - # example, an XSS vulnerability in an App Engine application is a finding. - class GoogleCloudSecuritycenterV1p1beta1Finding - include Google::Apis::Core::Hashable - - # The additional taxonomy group within findings from a given source. This field - # is immutable after creation time. Example: "XSS_FLASH_INJECTION" - # Corresponds to the JSON property `category` - # @return [String] - attr_accessor :category - - # The time at which the finding was created in Security Command Center. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # The time at which the event took place, or when an update to the finding - # occurred. For example, if the finding represents an open firewall it would - # capture the time the detector believes the firewall became open. The accuracy - # is determined by the detector. If the finding were to be resolved afterward, - # this time would reflect when the finding was resolved. - # Corresponds to the JSON property `eventTime` - # @return [String] - attr_accessor :event_time - - # The URI that, if available, points to a web page outside of Security Command - # Center where additional information about the finding can be found. This field - # is guaranteed to be either empty or a well formed URL. - # Corresponds to the JSON property `externalUri` - # @return [String] - attr_accessor :external_uri - - # The relative resource name of this finding. See: https://cloud.google.com/apis/ - # design/resource_names#relative_resource_name Example: "organizations/` - # organization_id`/sources/`source_id`/findings/`finding_id`" - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The relative resource name of the source the finding belongs to. See: https:// - # cloud.google.com/apis/design/resource_names#relative_resource_name This field - # is immutable after creation time. For example: "organizations/`organization_id` - # /sources/`source_id`" - # Corresponds to the JSON property `parent` - # @return [String] - attr_accessor :parent - - # For findings on Google Cloud resources, the full resource name of the Google - # Cloud resource this finding is for. See: https://cloud.google.com/apis/design/ - # resource_names#full_resource_name When the finding is for a non-Google Cloud - # resource, the resourceName can be a customer or partner defined string. This - # field is immutable after creation time. - # Corresponds to the JSON property `resourceName` - # @return [String] - attr_accessor :resource_name - - # User specified security marks that are attached to the parent Security Command - # Center resource. Security marks are scoped within a Security Command Center - # organization -- they can be modified and viewed by all users who have proper - # permissions on the organization. - # Corresponds to the JSON property `securityMarks` - # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] - attr_accessor :security_marks - - # The severity of the finding. - # Corresponds to the JSON property `severity` - # @return [String] - attr_accessor :severity - - # Source specific properties. These properties are managed by the source that - # writes the finding. The key names in the source_properties map must be between - # 1 and 255 characters, and must start with a letter and contain alphanumeric - # characters or underscores only. - # Corresponds to the JSON property `sourceProperties` - # @return [Hash] - attr_accessor :source_properties - - # The state of the finding. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @category = args[:category] if args.key?(:category) - @create_time = args[:create_time] if args.key?(:create_time) - @event_time = args[:event_time] if args.key?(:event_time) - @external_uri = args[:external_uri] if args.key?(:external_uri) - @name = args[:name] if args.key?(:name) - @parent = args[:parent] if args.key?(:parent) - @resource_name = args[:resource_name] if args.key?(:resource_name) - @security_marks = args[:security_marks] if args.key?(:security_marks) - @severity = args[:severity] if args.key?(:severity) - @source_properties = args[:source_properties] if args.key?(:source_properties) - @state = args[:state] if args.key?(:state) - end - end - - # Cloud IAM Policy information associated with the Google Cloud resource - # described by the Security Command Center asset. This information is managed - # and defined by the Google Cloud resource and cannot be modified by the user. - class GoogleCloudSecuritycenterV1p1beta1IamPolicy - include Google::Apis::Core::Hashable - - # The JSON representation of the Policy associated with the asset. See https:// - # cloud.google.com/iam/docs/reference/rest/v1/Policy for format details. - # Corresponds to the JSON property `policyBlob` - # @return [String] - attr_accessor :policy_blob - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @policy_blob = args[:policy_blob] if args.key?(:policy_blob) - end - end - - # Security Command Center's Notification - class GoogleCloudSecuritycenterV1p1beta1NotificationMessage - include Google::Apis::Core::Hashable - - # Security Command Center finding. A finding is a record of assessment data ( - # security, risk, health or privacy) ingested into Security Command Center for - # presentation, notification, analysis, policy testing, and enforcement. For - # example, an XSS vulnerability in an App Engine application is a finding. - # Corresponds to the JSON property `finding` - # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Finding] - attr_accessor :finding - - # Name of the notification config that generated current notification. - # Corresponds to the JSON property `notificationConfigName` - # @return [String] - attr_accessor :notification_config_name - - # Information related to the Google Cloud resource. - # Corresponds to the JSON property `resource` - # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Resource] - attr_accessor :resource - - # Wrapper over asset object that also captures the state change for the asset e. - # g. if it was a newly created asset vs updated or deleted asset. - # Corresponds to the JSON property `temporalAsset` - # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1TemporalAsset] - attr_accessor :temporal_asset - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @finding = args[:finding] if args.key?(:finding) - @notification_config_name = args[:notification_config_name] if args.key?(:notification_config_name) - @resource = args[:resource] if args.key?(:resource) - @temporal_asset = args[:temporal_asset] if args.key?(:temporal_asset) - end - end - - # Information related to the Google Cloud resource. - class GoogleCloudSecuritycenterV1p1beta1Resource - include Google::Apis::Core::Hashable - - # The full resource name of the resource. See: https://cloud.google.com/apis/ - # design/resource_names#full_resource_name - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The full resource name of resource's parent. - # Corresponds to the JSON property `parent` - # @return [String] - attr_accessor :parent - - # The human readable name of resource's parent. - # Corresponds to the JSON property `parentDisplayName` - # @return [String] - attr_accessor :parent_display_name - - # The full resource name of project that the resource belongs to. - # Corresponds to the JSON property `project` - # @return [String] - attr_accessor :project - - # The human readable name of project that the resource belongs to. - # Corresponds to the JSON property `projectDisplayName` - # @return [String] - attr_accessor :project_display_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - @parent = args[:parent] if args.key?(:parent) - @parent_display_name = args[:parent_display_name] if args.key?(:parent_display_name) - @project = args[:project] if args.key?(:project) - @project_display_name = args[:project_display_name] if args.key?(:project_display_name) - end - end - - # Response of asset discovery run - class GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse - include Google::Apis::Core::Hashable - - # The duration between asset discovery run start and end - # Corresponds to the JSON property `duration` - # @return [String] - attr_accessor :duration - - # The state of an asset discovery run. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @duration = args[:duration] if args.key?(:duration) - @state = args[:state] if args.key?(:state) - end - end - - # Security Command Center managed properties. These properties are managed by - # Security Command Center and cannot be modified by the user. - class GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties - include Google::Apis::Core::Hashable - - # The user defined display name for this resource. - # Corresponds to the JSON property `resourceDisplayName` - # @return [String] - attr_accessor :resource_display_name - - # The full resource name of the Google Cloud resource this asset represents. - # This field is immutable after create time. See: https://cloud.google.com/apis/ - # design/resource_names#full_resource_name - # Corresponds to the JSON property `resourceName` - # @return [String] - attr_accessor :resource_name - - # Owners of the Google Cloud resource. - # Corresponds to the JSON property `resourceOwners` - # @return [Array] - attr_accessor :resource_owners - - # The full resource name of the immediate parent of the resource. See: https:// - # cloud.google.com/apis/design/resource_names#full_resource_name - # Corresponds to the JSON property `resourceParent` - # @return [String] - attr_accessor :resource_parent - - # The user defined display name for the parent of this resource. - # Corresponds to the JSON property `resourceParentDisplayName` - # @return [String] - attr_accessor :resource_parent_display_name - - # The full resource name of the project the resource belongs to. See: https:// - # cloud.google.com/apis/design/resource_names#full_resource_name - # Corresponds to the JSON property `resourceProject` - # @return [String] - attr_accessor :resource_project - - # The user defined display name for the project of this resource. - # Corresponds to the JSON property `resourceProjectDisplayName` - # @return [String] - attr_accessor :resource_project_display_name - - # The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, - # and ORGANIZATION. This is a case insensitive field defined by Security Command - # Center and/or the producer of the resource and is immutable after create time. - # Corresponds to the JSON property `resourceType` - # @return [String] - attr_accessor :resource_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @resource_display_name = args[:resource_display_name] if args.key?(:resource_display_name) - @resource_name = args[:resource_name] if args.key?(:resource_name) - @resource_owners = args[:resource_owners] if args.key?(:resource_owners) - @resource_parent = args[:resource_parent] if args.key?(:resource_parent) - @resource_parent_display_name = args[:resource_parent_display_name] if args.key?(:resource_parent_display_name) - @resource_project = args[:resource_project] if args.key?(:resource_project) - @resource_project_display_name = args[:resource_project_display_name] if args.key?(:resource_project_display_name) - @resource_type = args[:resource_type] if args.key?(:resource_type) - end - end - - # User specified security marks that are attached to the parent Security Command - # Center resource. Security marks are scoped within a Security Command Center - # organization -- they can be modified and viewed by all users who have proper - # permissions on the organization. - class GoogleCloudSecuritycenterV1p1beta1SecurityMarks - include Google::Apis::Core::Hashable - - # Mutable user specified security marks belonging to the parent resource. - # Constraints are as follows: * Keys and values are treated as case insensitive * - # Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, - # numbers, underscores, or dashes * Values have leading and trailing whitespace - # trimmed, remaining characters must be between 1 - 4096 characters (inclusive) - # Corresponds to the JSON property `marks` - # @return [Hash] - attr_accessor :marks - - # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ - # apis/design/resource_names#relative_resource_name Examples: "organizations/` - # organization_id`/assets/`asset_id`/securityMarks" "organizations/` - # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @marks = args[:marks] if args.key?(:marks) - @name = args[:name] if args.key?(:name) - end - end - - # Wrapper over asset object that also captures the state change for the asset e. - # g. if it was a newly created asset vs updated or deleted asset. - class GoogleCloudSecuritycenterV1p1beta1TemporalAsset - include Google::Apis::Core::Hashable - - # Security Command Center representation of a Google Cloud resource. The Asset - # is a Security Command Center resource that captures information about a single - # Google Cloud resource. All modifications to an Asset are only within the - # context of Security Command Center and don't affect the referenced Google - # Cloud resource. - # Corresponds to the JSON property `asset` - # @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Asset] - attr_accessor :asset - - # Represents if the asset was created/updated/deleted. - # Corresponds to the JSON property `changeType` - # @return [String] - attr_accessor :change_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @asset = args[:asset] if args.key?(:asset) - @change_type = args[:change_type] if args.key?(:change_type) - end - end - - # The response message for Operations.ListOperations. - class ListOperationsResponse - include Google::Apis::Core::Hashable - - # The standard List next-page token. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # A list of operations that matches the specified filter in the request. - # Corresponds to the JSON property `operations` - # @return [Array] - attr_accessor :operations - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @operations = args[:operations] if args.key?(:operations) - end - end - - # This resource represents a long-running operation that is the result of a - # network API call. - class Operation - include Google::Apis::Core::Hashable - - # 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. - # Corresponds to the JSON property `done` - # @return [Boolean] - attr_accessor :done - alias_method :done?, :done - - # 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). - # Corresponds to the JSON property `error` - # @return [Google::Apis::SecuritycenterV1p1alpha1::Status] - attr_accessor :error - - # 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. - # Corresponds to the JSON property `metadata` - # @return [Hash] - attr_accessor :metadata - - # 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``. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # 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`. - # Corresponds to the JSON property `response` - # @return [Hash] - attr_accessor :response - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @done = args[:done] if args.key?(:done) - @error = args[:error] if args.key?(:error) - @metadata = args[:metadata] if args.key?(:metadata) - @name = args[:name] if args.key?(:name) - @response = args[:response] if args.key?(:response) - end - end - - # User specified security marks that are attached to the parent Security Command - # Center resource. Security marks are scoped within a Security Command Center - # organization -- they can be modified and viewed by all users who have proper - # permissions on the organization. - class SecurityMarks - include Google::Apis::Core::Hashable - - # Mutable user specified security marks belonging to the parent resource. - # Constraints are as follows: * Keys and values are treated as case insensitive * - # Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, - # numbers, underscores, or dashes * Values have leading and trailing whitespace - # trimmed, remaining characters must be between 1 - 4096 characters (inclusive) - # Corresponds to the JSON property `marks` - # @return [Hash] - attr_accessor :marks - - # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ - # apis/design/resource_names#relative_resource_name Examples: "organizations/` - # organization_id`/assets/`asset_id`/securityMarks" "organizations/` - # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @marks = args[:marks] if args.key?(:marks) - @name = args[:name] if args.key?(:name) - end - end - - # 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). - class Status - include Google::Apis::Core::Hashable - - # The status code, which should be an enum value of google.rpc.Code. - # Corresponds to the JSON property `code` - # @return [Fixnum] - attr_accessor :code - - # A list of messages that carry the error details. There is a common set of - # message types for APIs to use. - # Corresponds to the JSON property `details` - # @return [Array>] - attr_accessor :details - - # 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. - # Corresponds to the JSON property `message` - # @return [String] - attr_accessor :message - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @code = args[:code] if args.key?(:code) - @details = args[:details] if args.key?(:details) - @message = args[:message] if args.key?(:message) - end - end - end - end -end diff --git a/generated/google/apis/securitycenter_v1p1alpha1/representations.rb b/generated/google/apis/securitycenter_v1p1alpha1/representations.rb deleted file mode 100644 index 5c13701cb..000000000 --- a/generated/google/apis/securitycenter_v1p1alpha1/representations.rb +++ /dev/null @@ -1,343 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module SecuritycenterV1p1alpha1 - - class Empty - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Finding - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1NotificationMessage - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1Resource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1Asset - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1Finding - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1IamPolicy - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1NotificationMessage - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1Resource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1SecurityMarks - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1TemporalAsset - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListOperationsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Operation - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SecurityMarks - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Status - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Empty - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class Finding - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :category, as: 'category' - property :create_time, as: 'createTime' - property :event_time, as: 'eventTime' - property :external_uri, as: 'externalUri' - property :name, as: 'name' - property :parent, as: 'parent' - property :resource_name, as: 'resourceName' - property :security_marks, as: 'securityMarks', class: Google::Apis::SecuritycenterV1p1alpha1::SecurityMarks, decorator: Google::Apis::SecuritycenterV1p1alpha1::SecurityMarks::Representation - - hash :source_properties, as: 'sourceProperties' - property :state, as: 'state' - end - end - - class GoogleCloudSecuritycenterV1NotificationMessage - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :finding, as: 'finding', class: Google::Apis::SecuritycenterV1p1alpha1::Finding, decorator: Google::Apis::SecuritycenterV1p1alpha1::Finding::Representation - - property :notification_config_name, as: 'notificationConfigName' - property :resource, as: 'resource', class: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1Resource, decorator: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1Resource::Representation - - end - end - - class GoogleCloudSecuritycenterV1Resource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - property :parent, as: 'parent' - property :parent_display_name, as: 'parentDisplayName' - property :project, as: 'project' - property :project_display_name, as: 'projectDisplayName' - end - end - - class GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :duration, as: 'duration' - property :state, as: 'state' - end - end - - class GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :duration, as: 'duration' - property :state, as: 'state' - end - end - - class GoogleCloudSecuritycenterV1p1beta1Asset - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' - property :iam_policy, as: 'iamPolicy', class: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1IamPolicy, decorator: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1IamPolicy::Representation - - property :name, as: 'name' - hash :resource_properties, as: 'resourceProperties' - property :security_center_properties, as: 'securityCenterProperties', class: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties, decorator: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties::Representation - - property :security_marks, as: 'securityMarks', class: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks, decorator: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation - - property :update_time, as: 'updateTime' - end - end - - class GoogleCloudSecuritycenterV1p1beta1Finding - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :category, as: 'category' - property :create_time, as: 'createTime' - property :event_time, as: 'eventTime' - property :external_uri, as: 'externalUri' - property :name, as: 'name' - property :parent, as: 'parent' - property :resource_name, as: 'resourceName' - property :security_marks, as: 'securityMarks', class: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks, decorator: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation - - property :severity, as: 'severity' - hash :source_properties, as: 'sourceProperties' - property :state, as: 'state' - end - end - - class GoogleCloudSecuritycenterV1p1beta1IamPolicy - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :policy_blob, as: 'policyBlob' - end - end - - class GoogleCloudSecuritycenterV1p1beta1NotificationMessage - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :finding, as: 'finding', class: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Finding, decorator: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Finding::Representation - - property :notification_config_name, as: 'notificationConfigName' - property :resource, as: 'resource', class: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Resource, decorator: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Resource::Representation - - property :temporal_asset, as: 'temporalAsset', class: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1TemporalAsset, decorator: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1TemporalAsset::Representation - - end - end - - class GoogleCloudSecuritycenterV1p1beta1Resource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - property :parent, as: 'parent' - property :parent_display_name, as: 'parentDisplayName' - property :project, as: 'project' - property :project_display_name, as: 'projectDisplayName' - end - end - - class GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :duration, as: 'duration' - property :state, as: 'state' - end - end - - class GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :resource_display_name, as: 'resourceDisplayName' - property :resource_name, as: 'resourceName' - collection :resource_owners, as: 'resourceOwners' - property :resource_parent, as: 'resourceParent' - property :resource_parent_display_name, as: 'resourceParentDisplayName' - property :resource_project, as: 'resourceProject' - property :resource_project_display_name, as: 'resourceProjectDisplayName' - property :resource_type, as: 'resourceType' - end - end - - class GoogleCloudSecuritycenterV1p1beta1SecurityMarks - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :marks, as: 'marks' - property :name, as: 'name' - end - end - - class GoogleCloudSecuritycenterV1p1beta1TemporalAsset - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :asset, as: 'asset', class: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Asset, decorator: Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Asset::Representation - - property :change_type, as: 'changeType' - end - end - - class ListOperationsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :operations, as: 'operations', class: Google::Apis::SecuritycenterV1p1alpha1::Operation, decorator: Google::Apis::SecuritycenterV1p1alpha1::Operation::Representation - - end - end - - class Operation - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :done, as: 'done' - property :error, as: 'error', class: Google::Apis::SecuritycenterV1p1alpha1::Status, decorator: Google::Apis::SecuritycenterV1p1alpha1::Status::Representation - - hash :metadata, as: 'metadata' - property :name, as: 'name' - hash :response, as: 'response' - end - end - - class SecurityMarks - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :marks, as: 'marks' - property :name, as: 'name' - end - end - - class Status - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :code, as: 'code' - collection :details, as: 'details' - property :message, as: 'message' - end - end - end - end -end diff --git a/generated/google/apis/securitycenter_v1p1alpha1/service.rb b/generated/google/apis/securitycenter_v1p1alpha1/service.rb deleted file mode 100644 index 1ff65a03d..000000000 --- a/generated/google/apis/securitycenter_v1p1alpha1/service.rb +++ /dev/null @@ -1,207 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module SecuritycenterV1p1alpha1 - # Security Command Center API - # - # Security Command Center API provides access to temporal views of assets and - # findings within an organization. - # - # @example - # require 'google/apis/securitycenter_v1p1alpha1' - # - # Securitycenter = Google::Apis::SecuritycenterV1p1alpha1 # Alias the module - # service = Securitycenter::SecurityCommandCenterService.new - # - # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview - class SecurityCommandCenterService < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - - # @return [String] - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - attr_accessor :quota_user - - def initialize - super('https://securitycenter.googleapis.com/', '') - @batch_path = 'batch' - end - - # 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`. - # @param [String] name - # The name of the operation resource to be cancelled. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1alpha1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1alpha1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def cancel_organization_operation(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1p1alpha1/{+name}:cancel', options) - command.response_representation = Google::Apis::SecuritycenterV1p1alpha1::Empty::Representation - command.response_class = Google::Apis::SecuritycenterV1p1alpha1::Empty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a long-running operation. This method indicates that the client is no - # longer interested in the operation result. It does not cancel the operation. - # If the server doesn't support this method, it returns `google.rpc.Code. - # UNIMPLEMENTED`. - # @param [String] name - # The name of the operation resource to be deleted. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1alpha1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1alpha1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_organization_operation(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v1p1alpha1/{+name}', options) - command.response_representation = Google::Apis::SecuritycenterV1p1alpha1::Empty::Representation - command.response_class = Google::Apis::SecuritycenterV1p1alpha1::Empty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # 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. - # @param [String] name - # The name of the operation resource. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1alpha1::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1alpha1::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_organization_operation(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1p1alpha1/{+name}', options) - command.response_representation = Google::Apis::SecuritycenterV1p1alpha1::Operation::Representation - command.response_class = Google::Apis::SecuritycenterV1p1alpha1::Operation - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # 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. - # @param [String] name - # The name of the operation's parent resource. - # @param [String] filter - # The standard list filter. - # @param [Fixnum] page_size - # The standard list page size. - # @param [String] page_token - # The standard list page token. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1alpha1::ListOperationsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1alpha1::ListOperationsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_organization_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1p1alpha1/{+name}', options) - command.response_representation = Google::Apis::SecuritycenterV1p1alpha1::ListOperationsResponse::Representation - command.response_class = Google::Apis::SecuritycenterV1p1alpha1::ListOperationsResponse - command.params['name'] = name unless name.nil? - command.query['filter'] = filter unless filter.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - end - end - end - end -end diff --git a/generated/google/apis/securitycenter_v1p1beta1.rb b/generated/google/apis/securitycenter_v1p1beta1.rb deleted file mode 100644 index d9d697c16..000000000 --- a/generated/google/apis/securitycenter_v1p1beta1.rb +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'google/apis/securitycenter_v1p1beta1/service.rb' -require 'google/apis/securitycenter_v1p1beta1/classes.rb' -require 'google/apis/securitycenter_v1p1beta1/representations.rb' - -module Google - module Apis - # Security Command Center API - # - # Security Command Center API provides access to temporal views of assets and - # findings within an organization. - # - # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview - module SecuritycenterV1p1beta1 - VERSION = 'V1p1beta1' - REVISION = '20200820' - - # View and manage your data across Google Cloud Platform services - AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' - end - end -end diff --git a/generated/google/apis/securitycenter_v1p1beta1/classes.rb b/generated/google/apis/securitycenter_v1p1beta1/classes.rb deleted file mode 100644 index fbed3aeec..000000000 --- a/generated/google/apis/securitycenter_v1p1beta1/classes.rb +++ /dev/null @@ -1,2069 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module SecuritycenterV1p1beta1 - - # The configuration used for Asset Discovery runs. - class AssetDiscoveryConfig - include Google::Apis::Core::Hashable - - # The mode to use for filtering asset discovery. - # Corresponds to the JSON property `inclusionMode` - # @return [String] - attr_accessor :inclusion_mode - - # The project ids to use for filtering asset discovery. - # Corresponds to the JSON property `projectIds` - # @return [Array] - attr_accessor :project_ids - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @inclusion_mode = args[:inclusion_mode] if args.key?(:inclusion_mode) - @project_ids = args[:project_ids] if args.key?(:project_ids) - end - end - - # 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. - class AuditConfig - include Google::Apis::Core::Hashable - - # The configuration for logging of each type of permission. - # Corresponds to the JSON property `auditLogConfigs` - # @return [Array] - attr_accessor :audit_log_configs - - # 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. - # Corresponds to the JSON property `service` - # @return [String] - attr_accessor :service - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @audit_log_configs = args[:audit_log_configs] if args.key?(:audit_log_configs) - @service = args[:service] if args.key?(:service) - end - end - - # 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. - class AuditLogConfig - include Google::Apis::Core::Hashable - - # Specifies the identities that do not cause logging for this type of permission. - # Follows the same format of Binding.members. - # Corresponds to the JSON property `exemptedMembers` - # @return [Array] - attr_accessor :exempted_members - - # The log type that this config enables. - # Corresponds to the JSON property `logType` - # @return [String] - attr_accessor :log_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @exempted_members = args[:exempted_members] if args.key?(:exempted_members) - @log_type = args[:log_type] if args.key?(:log_type) - end - end - - # Associates `members` with a `role`. - class Binding - include Google::Apis::Core::Hashable - - # 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. - # Corresponds to the JSON property `condition` - # @return [Google::Apis::SecuritycenterV1p1beta1::Expr] - attr_accessor :condition - - # 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`. - # Corresponds to the JSON property `members` - # @return [Array] - attr_accessor :members - - # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor` - # , or `roles/owner`. - # Corresponds to the JSON property `role` - # @return [String] - attr_accessor :role - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @condition = args[:condition] if args.key?(:condition) - @members = args[:members] if args.key?(:members) - @role = args[:role] if args.key?(:role) - end - end - - # 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 ````. - class Empty - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - - # 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. - class Expr - include Google::Apis::Core::Hashable - - # Optional. Description of the expression. This is a longer text which describes - # the expression, e.g. when hovered over it in a UI. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Textual representation of an expression in Common Expression Language syntax. - # Corresponds to the JSON property `expression` - # @return [String] - attr_accessor :expression - - # Optional. String indicating the location of the expression for error reporting, - # e.g. a file name and a position in the file. - # Corresponds to the JSON property `location` - # @return [String] - attr_accessor :location - - # 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. - # Corresponds to the JSON property `title` - # @return [String] - attr_accessor :title - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @description = args[:description] if args.key?(:description) - @expression = args[:expression] if args.key?(:expression) - @location = args[:location] if args.key?(:location) - @title = args[:title] if args.key?(:title) - end - end - - # Security Command Center finding. A finding is a record of assessment data like - # security, risk, health, or privacy, that is ingested into Security Command - # Center for presentation, notification, analysis, policy testing, and - # enforcement. For example, a cross-site scripting (XSS) vulnerability in an App - # Engine application is a finding. - class Finding - include Google::Apis::Core::Hashable - - # The additional taxonomy group within findings from a given source. This field - # is immutable after creation time. Example: "XSS_FLASH_INJECTION" - # Corresponds to the JSON property `category` - # @return [String] - attr_accessor :category - - # The time at which the finding was created in Security Command Center. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # The time at which the event took place, or when an update to the finding - # occurred. For example, if the finding represents an open firewall it would - # capture the time the detector believes the firewall became open. The accuracy - # is determined by the detector. If the finding were to be resolved afterward, - # this time would reflect when the finding was resolved. - # Corresponds to the JSON property `eventTime` - # @return [String] - attr_accessor :event_time - - # The URI that, if available, points to a web page outside of Security Command - # Center where additional information about the finding can be found. This field - # is guaranteed to be either empty or a well formed URL. - # Corresponds to the JSON property `externalUri` - # @return [String] - attr_accessor :external_uri - - # The relative resource name of this finding. See: https://cloud.google.com/apis/ - # design/resource_names#relative_resource_name Example: "organizations/` - # organization_id`/sources/`source_id`/findings/`finding_id`" - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The relative resource name of the source the finding belongs to. See: https:// - # cloud.google.com/apis/design/resource_names#relative_resource_name This field - # is immutable after creation time. For example: "organizations/`organization_id` - # /sources/`source_id`" - # Corresponds to the JSON property `parent` - # @return [String] - attr_accessor :parent - - # For findings on Google Cloud resources, the full resource name of the Google - # Cloud resource this finding is for. See: https://cloud.google.com/apis/design/ - # resource_names#full_resource_name When the finding is for a non-Google Cloud - # resource, the resourceName can be a customer or partner defined string. This - # field is immutable after creation time. - # Corresponds to the JSON property `resourceName` - # @return [String] - attr_accessor :resource_name - - # User specified security marks that are attached to the parent Security Command - # Center resource. Security marks are scoped within a Security Command Center - # organization -- they can be modified and viewed by all users who have proper - # permissions on the organization. - # Corresponds to the JSON property `securityMarks` - # @return [Google::Apis::SecuritycenterV1p1beta1::SecurityMarks] - attr_accessor :security_marks - - # Source specific properties. These properties are managed by the source that - # writes the finding. The key names in the source_properties map must be between - # 1 and 255 characters, and must start with a letter and contain alphanumeric - # characters or underscores only. - # Corresponds to the JSON property `sourceProperties` - # @return [Hash] - attr_accessor :source_properties - - # The state of the finding. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @category = args[:category] if args.key?(:category) - @create_time = args[:create_time] if args.key?(:create_time) - @event_time = args[:event_time] if args.key?(:event_time) - @external_uri = args[:external_uri] if args.key?(:external_uri) - @name = args[:name] if args.key?(:name) - @parent = args[:parent] if args.key?(:parent) - @resource_name = args[:resource_name] if args.key?(:resource_name) - @security_marks = args[:security_marks] if args.key?(:security_marks) - @source_properties = args[:source_properties] if args.key?(:source_properties) - @state = args[:state] if args.key?(:state) - end - end - - # Request message for `GetIamPolicy` method. - class GetIamPolicyRequest - include Google::Apis::Core::Hashable - - # Encapsulates settings provided to GetIamPolicy. - # Corresponds to the JSON property `options` - # @return [Google::Apis::SecuritycenterV1p1beta1::GetPolicyOptions] - attr_accessor :options - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @options = args[:options] if args.key?(:options) - end - end - - # Encapsulates settings provided to GetIamPolicy. - class GetPolicyOptions - include Google::Apis::Core::Hashable - - # Optional. 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). - # Corresponds to the JSON property `requestedPolicyVersion` - # @return [Fixnum] - attr_accessor :requested_policy_version - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @requested_policy_version = args[:requested_policy_version] if args.key?(:requested_policy_version) - end - end - - # Cloud SCC's Notification - class GoogleCloudSecuritycenterV1NotificationMessage - include Google::Apis::Core::Hashable - - # Security Command Center finding. A finding is a record of assessment data like - # security, risk, health, or privacy, that is ingested into Security Command - # Center for presentation, notification, analysis, policy testing, and - # enforcement. For example, a cross-site scripting (XSS) vulnerability in an App - # Engine application is a finding. - # Corresponds to the JSON property `finding` - # @return [Google::Apis::SecuritycenterV1p1beta1::Finding] - attr_accessor :finding - - # Name of the notification config that generated current notification. - # Corresponds to the JSON property `notificationConfigName` - # @return [String] - attr_accessor :notification_config_name - - # Information related to the Google Cloud resource. - # Corresponds to the JSON property `resource` - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1Resource] - attr_accessor :resource - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @finding = args[:finding] if args.key?(:finding) - @notification_config_name = args[:notification_config_name] if args.key?(:notification_config_name) - @resource = args[:resource] if args.key?(:resource) - end - end - - # Information related to the Google Cloud resource. - class GoogleCloudSecuritycenterV1Resource - include Google::Apis::Core::Hashable - - # The full resource name of the resource. See: https://cloud.google.com/apis/ - # design/resource_names#full_resource_name - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The full resource name of resource's parent. - # Corresponds to the JSON property `parent` - # @return [String] - attr_accessor :parent - - # The human readable name of resource's parent. - # Corresponds to the JSON property `parentDisplayName` - # @return [String] - attr_accessor :parent_display_name - - # The full resource name of project that the resource belongs to. - # Corresponds to the JSON property `project` - # @return [String] - attr_accessor :project - - # The human readable name of project that the resource belongs to. - # Corresponds to the JSON property `projectDisplayName` - # @return [String] - attr_accessor :project_display_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - @parent = args[:parent] if args.key?(:parent) - @parent_display_name = args[:parent_display_name] if args.key?(:parent_display_name) - @project = args[:project] if args.key?(:project) - @project_display_name = args[:project_display_name] if args.key?(:project_display_name) - end - end - - # Response of asset discovery run - class GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse - include Google::Apis::Core::Hashable - - # The duration between asset discovery run start and end - # Corresponds to the JSON property `duration` - # @return [String] - attr_accessor :duration - - # The state of an asset discovery run. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @duration = args[:duration] if args.key?(:duration) - @state = args[:state] if args.key?(:state) - end - end - - # Response of asset discovery run - class GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse - include Google::Apis::Core::Hashable - - # The duration between asset discovery run start and end - # Corresponds to the JSON property `duration` - # @return [String] - attr_accessor :duration - - # The state of an asset discovery run. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @duration = args[:duration] if args.key?(:duration) - @state = args[:state] if args.key?(:state) - end - end - - # Security Command Center representation of a Google Cloud resource. The Asset - # is a Security Command Center resource that captures information about a single - # Google Cloud resource. All modifications to an Asset are only within the - # context of Security Command Center and don't affect the referenced Google - # Cloud resource. - class GoogleCloudSecuritycenterV1p1beta1Asset - include Google::Apis::Core::Hashable - - # The time at which the asset was created in Security Command Center. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # Cloud IAM Policy information associated with the Google Cloud resource - # described by the Security Command Center asset. This information is managed - # and defined by the Google Cloud resource and cannot be modified by the user. - # Corresponds to the JSON property `iamPolicy` - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1IamPolicy] - attr_accessor :iam_policy - - # The relative resource name of this asset. See: https://cloud.google.com/apis/ - # design/resource_names#relative_resource_name Example: "organizations/` - # organization_id`/assets/`asset_id`". - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Resource managed properties. These properties are managed and defined by the - # Google Cloud resource and cannot be modified by the user. - # Corresponds to the JSON property `resourceProperties` - # @return [Hash] - attr_accessor :resource_properties - - # Security Command Center managed properties. These properties are managed by - # Security Command Center and cannot be modified by the user. - # Corresponds to the JSON property `securityCenterProperties` - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties] - attr_accessor :security_center_properties - - # User specified security marks that are attached to the parent Security Command - # Center resource. Security marks are scoped within a Security Command Center - # organization -- they can be modified and viewed by all users who have proper - # permissions on the organization. - # Corresponds to the JSON property `securityMarks` - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] - attr_accessor :security_marks - - # The time at which the asset was last updated, added, or deleted in Cloud SCC. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @create_time = args[:create_time] if args.key?(:create_time) - @iam_policy = args[:iam_policy] if args.key?(:iam_policy) - @name = args[:name] if args.key?(:name) - @resource_properties = args[:resource_properties] if args.key?(:resource_properties) - @security_center_properties = args[:security_center_properties] if args.key?(:security_center_properties) - @security_marks = args[:security_marks] if args.key?(:security_marks) - @update_time = args[:update_time] if args.key?(:update_time) - end - end - - # Security Command Center finding. A finding is a record of assessment data ( - # security, risk, health or privacy) ingested into Security Command Center for - # presentation, notification, analysis, policy testing, and enforcement. For - # example, an XSS vulnerability in an App Engine application is a finding. - class GoogleCloudSecuritycenterV1p1beta1Finding - include Google::Apis::Core::Hashable - - # The additional taxonomy group within findings from a given source. This field - # is immutable after creation time. Example: "XSS_FLASH_INJECTION" - # Corresponds to the JSON property `category` - # @return [String] - attr_accessor :category - - # The time at which the finding was created in Security Command Center. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - - # The time at which the event took place, or when an update to the finding - # occurred. For example, if the finding represents an open firewall it would - # capture the time the detector believes the firewall became open. The accuracy - # is determined by the detector. If the finding were to be resolved afterward, - # this time would reflect when the finding was resolved. - # Corresponds to the JSON property `eventTime` - # @return [String] - attr_accessor :event_time - - # The URI that, if available, points to a web page outside of Security Command - # Center where additional information about the finding can be found. This field - # is guaranteed to be either empty or a well formed URL. - # Corresponds to the JSON property `externalUri` - # @return [String] - attr_accessor :external_uri - - # The relative resource name of this finding. See: https://cloud.google.com/apis/ - # design/resource_names#relative_resource_name Example: "organizations/` - # organization_id`/sources/`source_id`/findings/`finding_id`" - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The relative resource name of the source the finding belongs to. See: https:// - # cloud.google.com/apis/design/resource_names#relative_resource_name This field - # is immutable after creation time. For example: "organizations/`organization_id` - # /sources/`source_id`" - # Corresponds to the JSON property `parent` - # @return [String] - attr_accessor :parent - - # For findings on Google Cloud resources, the full resource name of the Google - # Cloud resource this finding is for. See: https://cloud.google.com/apis/design/ - # resource_names#full_resource_name When the finding is for a non-Google Cloud - # resource, the resourceName can be a customer or partner defined string. This - # field is immutable after creation time. - # Corresponds to the JSON property `resourceName` - # @return [String] - attr_accessor :resource_name - - # User specified security marks that are attached to the parent Security Command - # Center resource. Security marks are scoped within a Security Command Center - # organization -- they can be modified and viewed by all users who have proper - # permissions on the organization. - # Corresponds to the JSON property `securityMarks` - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] - attr_accessor :security_marks - - # The severity of the finding. - # Corresponds to the JSON property `severity` - # @return [String] - attr_accessor :severity - - # Source specific properties. These properties are managed by the source that - # writes the finding. The key names in the source_properties map must be between - # 1 and 255 characters, and must start with a letter and contain alphanumeric - # characters or underscores only. - # Corresponds to the JSON property `sourceProperties` - # @return [Hash] - attr_accessor :source_properties - - # The state of the finding. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @category = args[:category] if args.key?(:category) - @create_time = args[:create_time] if args.key?(:create_time) - @event_time = args[:event_time] if args.key?(:event_time) - @external_uri = args[:external_uri] if args.key?(:external_uri) - @name = args[:name] if args.key?(:name) - @parent = args[:parent] if args.key?(:parent) - @resource_name = args[:resource_name] if args.key?(:resource_name) - @security_marks = args[:security_marks] if args.key?(:security_marks) - @severity = args[:severity] if args.key?(:severity) - @source_properties = args[:source_properties] if args.key?(:source_properties) - @state = args[:state] if args.key?(:state) - end - end - - # Cloud IAM Policy information associated with the Google Cloud resource - # described by the Security Command Center asset. This information is managed - # and defined by the Google Cloud resource and cannot be modified by the user. - class GoogleCloudSecuritycenterV1p1beta1IamPolicy - include Google::Apis::Core::Hashable - - # The JSON representation of the Policy associated with the asset. See https:// - # cloud.google.com/iam/docs/reference/rest/v1/Policy for format details. - # Corresponds to the JSON property `policyBlob` - # @return [String] - attr_accessor :policy_blob - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @policy_blob = args[:policy_blob] if args.key?(:policy_blob) - end - end - - # Security Command Center's Notification - class GoogleCloudSecuritycenterV1p1beta1NotificationMessage - include Google::Apis::Core::Hashable - - # Security Command Center finding. A finding is a record of assessment data ( - # security, risk, health or privacy) ingested into Security Command Center for - # presentation, notification, analysis, policy testing, and enforcement. For - # example, an XSS vulnerability in an App Engine application is a finding. - # Corresponds to the JSON property `finding` - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] - attr_accessor :finding - - # Name of the notification config that generated current notification. - # Corresponds to the JSON property `notificationConfigName` - # @return [String] - attr_accessor :notification_config_name - - # Information related to the Google Cloud resource. - # Corresponds to the JSON property `resource` - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Resource] - attr_accessor :resource - - # Wrapper over asset object that also captures the state change for the asset e. - # g. if it was a newly created asset vs updated or deleted asset. - # Corresponds to the JSON property `temporalAsset` - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1TemporalAsset] - attr_accessor :temporal_asset - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @finding = args[:finding] if args.key?(:finding) - @notification_config_name = args[:notification_config_name] if args.key?(:notification_config_name) - @resource = args[:resource] if args.key?(:resource) - @temporal_asset = args[:temporal_asset] if args.key?(:temporal_asset) - end - end - - # Information related to the Google Cloud resource. - class GoogleCloudSecuritycenterV1p1beta1Resource - include Google::Apis::Core::Hashable - - # The full resource name of the resource. See: https://cloud.google.com/apis/ - # design/resource_names#full_resource_name - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The full resource name of resource's parent. - # Corresponds to the JSON property `parent` - # @return [String] - attr_accessor :parent - - # The human readable name of resource's parent. - # Corresponds to the JSON property `parentDisplayName` - # @return [String] - attr_accessor :parent_display_name - - # The full resource name of project that the resource belongs to. - # Corresponds to the JSON property `project` - # @return [String] - attr_accessor :project - - # The human readable name of project that the resource belongs to. - # Corresponds to the JSON property `projectDisplayName` - # @return [String] - attr_accessor :project_display_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - @parent = args[:parent] if args.key?(:parent) - @parent_display_name = args[:parent_display_name] if args.key?(:parent_display_name) - @project = args[:project] if args.key?(:project) - @project_display_name = args[:project_display_name] if args.key?(:project_display_name) - end - end - - # Response of asset discovery run - class GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse - include Google::Apis::Core::Hashable - - # The duration between asset discovery run start and end - # Corresponds to the JSON property `duration` - # @return [String] - attr_accessor :duration - - # The state of an asset discovery run. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @duration = args[:duration] if args.key?(:duration) - @state = args[:state] if args.key?(:state) - end - end - - # Security Command Center managed properties. These properties are managed by - # Security Command Center and cannot be modified by the user. - class GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties - include Google::Apis::Core::Hashable - - # The user defined display name for this resource. - # Corresponds to the JSON property `resourceDisplayName` - # @return [String] - attr_accessor :resource_display_name - - # The full resource name of the Google Cloud resource this asset represents. - # This field is immutable after create time. See: https://cloud.google.com/apis/ - # design/resource_names#full_resource_name - # Corresponds to the JSON property `resourceName` - # @return [String] - attr_accessor :resource_name - - # Owners of the Google Cloud resource. - # Corresponds to the JSON property `resourceOwners` - # @return [Array] - attr_accessor :resource_owners - - # The full resource name of the immediate parent of the resource. See: https:// - # cloud.google.com/apis/design/resource_names#full_resource_name - # Corresponds to the JSON property `resourceParent` - # @return [String] - attr_accessor :resource_parent - - # The user defined display name for the parent of this resource. - # Corresponds to the JSON property `resourceParentDisplayName` - # @return [String] - attr_accessor :resource_parent_display_name - - # The full resource name of the project the resource belongs to. See: https:// - # cloud.google.com/apis/design/resource_names#full_resource_name - # Corresponds to the JSON property `resourceProject` - # @return [String] - attr_accessor :resource_project - - # The user defined display name for the project of this resource. - # Corresponds to the JSON property `resourceProjectDisplayName` - # @return [String] - attr_accessor :resource_project_display_name - - # The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT, - # and ORGANIZATION. This is a case insensitive field defined by Security Command - # Center and/or the producer of the resource and is immutable after create time. - # Corresponds to the JSON property `resourceType` - # @return [String] - attr_accessor :resource_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @resource_display_name = args[:resource_display_name] if args.key?(:resource_display_name) - @resource_name = args[:resource_name] if args.key?(:resource_name) - @resource_owners = args[:resource_owners] if args.key?(:resource_owners) - @resource_parent = args[:resource_parent] if args.key?(:resource_parent) - @resource_parent_display_name = args[:resource_parent_display_name] if args.key?(:resource_parent_display_name) - @resource_project = args[:resource_project] if args.key?(:resource_project) - @resource_project_display_name = args[:resource_project_display_name] if args.key?(:resource_project_display_name) - @resource_type = args[:resource_type] if args.key?(:resource_type) - end - end - - # User specified security marks that are attached to the parent Security Command - # Center resource. Security marks are scoped within a Security Command Center - # organization -- they can be modified and viewed by all users who have proper - # permissions on the organization. - class GoogleCloudSecuritycenterV1p1beta1SecurityMarks - include Google::Apis::Core::Hashable - - # Mutable user specified security marks belonging to the parent resource. - # Constraints are as follows: * Keys and values are treated as case insensitive * - # Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, - # numbers, underscores, or dashes * Values have leading and trailing whitespace - # trimmed, remaining characters must be between 1 - 4096 characters (inclusive) - # Corresponds to the JSON property `marks` - # @return [Hash] - attr_accessor :marks - - # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ - # apis/design/resource_names#relative_resource_name Examples: "organizations/` - # organization_id`/assets/`asset_id`/securityMarks" "organizations/` - # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @marks = args[:marks] if args.key?(:marks) - @name = args[:name] if args.key?(:name) - end - end - - # Wrapper over asset object that also captures the state change for the asset e. - # g. if it was a newly created asset vs updated or deleted asset. - class GoogleCloudSecuritycenterV1p1beta1TemporalAsset - include Google::Apis::Core::Hashable - - # Security Command Center representation of a Google Cloud resource. The Asset - # is a Security Command Center resource that captures information about a single - # Google Cloud resource. All modifications to an Asset are only within the - # context of Security Command Center and don't affect the referenced Google - # Cloud resource. - # Corresponds to the JSON property `asset` - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Asset] - attr_accessor :asset - - # Represents if the asset was created/updated/deleted. - # Corresponds to the JSON property `changeType` - # @return [String] - attr_accessor :change_type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @asset = args[:asset] if args.key?(:asset) - @change_type = args[:change_type] if args.key?(:change_type) - end - end - - # Request message for grouping by assets. - class GroupAssetsRequest - include Google::Apis::Core::Hashable - - # When compare_duration is set, the GroupResult's "state_change" property is - # updated to indicate whether the asset was added, removed, or remained present - # during the compare_duration period of time that precedes the read_time. This - # is the time between (read_time - compare_duration) and read_time. The state - # change value is derived based on the presence of the asset at the two points - # in time. Intermediate state changes between the two times don't affect the - # result. For example, the results aren't affected if the asset is removed and - # re-created again. Possible "state_change" values when compare_duration is - # specified: * "ADDED": indicates that the asset was not present at the start of - # compare_duration, but present at reference_time. * "REMOVED": indicates that - # the asset was present at the start of compare_duration, but not present at - # reference_time. * "ACTIVE": indicates that the asset was present at both the - # start and the end of the time period defined by compare_duration and - # reference_time. If compare_duration is not specified, then the only possible - # state_change is "UNUSED", which will be the state_change set for all assets - # present at read_time. If this field is set then `state_change` must be a - # specified field in `group_by`. - # Corresponds to the JSON property `compareDuration` - # @return [String] - attr_accessor :compare_duration - - # Expression that defines the filter to apply across assets. The expression is a - # list of zero or more restrictions combined via logical operators `AND` and `OR` - # . Parentheses are supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` character in front of them - # to indicate negation. The fields map to those defined in the Asset resource. - # Examples include: * name * security_center_properties.resource_name * - # resource_properties.a_property * security_marks.marks.marka The supported - # operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer - # values. * `:`, meaning substring matching, for strings. The supported value - # types are: * string literals in quotes. * integer literals without quotes. * - # boolean literals `true` and `false` without quotes. The following field and - # operator combinations are supported: * name: `=` * update_time: `=`, `>`, `<`, - # `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. - # Examples: `update_time = "2019-06-10T16:07:18-07:00"` `update_time = - # 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be - # milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019- - # 06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_policy.policy_blob: - # `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * - # security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, - # `:` * security_center_properties.resource_name_display_name: `=`, `:` * - # security_center_properties.resource_type: `=`, `:` * - # security_center_properties.resource_parent: `=`, `:` * - # security_center_properties.resource_parent_display_name: `=`, `:` * - # security_center_properties.resource_project: `=`, `:` * - # security_center_properties.resource_project_display_name: `=`, `:` * - # security_center_properties.resource_owners: `=`, `:` For example, ` - # resource_properties.size = 100` is a valid filter string. Use a partial match - # on the empty string to filter based on a property existing: ` - # resource_properties.my_property : ""` Use a negated partial match on the empty - # string to filter based on a property not existing: `-resource_properties. - # my_property : ""` - # Corresponds to the JSON property `filter` - # @return [String] - attr_accessor :filter - - # Required. Expression that defines what assets fields to use for grouping. The - # string value should follow SQL syntax: comma separated list of fields. For - # example: "security_center_properties.resource_project, - # security_center_properties.project". The following fields are supported when - # compare_duration is not set: * security_center_properties.resource_project * - # security_center_properties.resource_project_display_name * - # security_center_properties.resource_type * security_center_properties. - # resource_parent * security_center_properties.resource_parent_display_name The - # following fields are supported when compare_duration is set: * - # security_center_properties.resource_type * security_center_properties. - # resource_project_display_name * security_center_properties. - # resource_parent_display_name - # Corresponds to the JSON property `groupBy` - # @return [String] - attr_accessor :group_by - - # The maximum number of results to return in a single response. Default is 10, - # minimum is 1, maximum is 1000. - # Corresponds to the JSON property `pageSize` - # @return [Fixnum] - attr_accessor :page_size - - # The value returned by the last `GroupAssetsResponse`; indicates that this is a - # continuation of a prior `GroupAssets` call, and that the system should return - # the next page of data. - # Corresponds to the JSON property `pageToken` - # @return [String] - attr_accessor :page_token - - # Time used as a reference point when filtering assets. The filter is limited to - # assets existing at the supplied time and their values are those at that - # specific time. Absence of this field will default to the API's version of NOW. - # Corresponds to the JSON property `readTime` - # @return [String] - attr_accessor :read_time - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @compare_duration = args[:compare_duration] if args.key?(:compare_duration) - @filter = args[:filter] if args.key?(:filter) - @group_by = args[:group_by] if args.key?(:group_by) - @page_size = args[:page_size] if args.key?(:page_size) - @page_token = args[:page_token] if args.key?(:page_token) - @read_time = args[:read_time] if args.key?(:read_time) - end - end - - # Response message for grouping by assets. - class GroupAssetsResponse - include Google::Apis::Core::Hashable - - # Group results. There exists an element for each existing unique combination of - # property/values. The element contains a count for the number of times those - # specific property/values appear. - # Corresponds to the JSON property `groupByResults` - # @return [Array] - attr_accessor :group_by_results - - # Token to retrieve the next page of results, or empty if there are no more - # results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # Time used for executing the groupBy request. - # Corresponds to the JSON property `readTime` - # @return [String] - attr_accessor :read_time - - # The total number of results matching the query. - # Corresponds to the JSON property `totalSize` - # @return [Fixnum] - attr_accessor :total_size - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @group_by_results = args[:group_by_results] if args.key?(:group_by_results) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @read_time = args[:read_time] if args.key?(:read_time) - @total_size = args[:total_size] if args.key?(:total_size) - end - end - - # Request message for grouping by findings. - class GroupFindingsRequest - include Google::Apis::Core::Hashable - - # When compare_duration is set, the GroupResult's "state_change" attribute is - # updated to indicate whether the finding had its state changed, the finding's - # state remained unchanged, or if the finding was added during the - # compare_duration period of time that precedes the read_time. This is the time - # between (read_time - compare_duration) and read_time. The state_change value - # is derived based on the presence and state of the finding at the two points in - # time. Intermediate state changes between the two times don't affect the result. - # For example, the results aren't affected if the finding is made inactive and - # then active again. Possible "state_change" values when compare_duration is - # specified: * "CHANGED": indicates that the finding was present and matched the - # given filter at the start of compare_duration, but changed its state at - # read_time. * "UNCHANGED": indicates that the finding was present and matched - # the given filter at the start of compare_duration and did not change state at - # read_time. * "ADDED": indicates that the finding did not match the given - # filter or was not present at the start of compare_duration, but was present at - # read_time. * "REMOVED": indicates that the finding was present and matched the - # filter at the start of compare_duration, but did not match the filter at - # read_time. If compare_duration is not specified, then the only possible - # state_change is "UNUSED", which will be the state_change set for all findings - # present at read_time. If this field is set then `state_change` must be a - # specified field in `group_by`. - # Corresponds to the JSON property `compareDuration` - # @return [String] - attr_accessor :compare_duration - - # Expression that defines the filter to apply across findings. The expression is - # a list of one or more restrictions combined via logical operators `AND` and ` - # OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` character in front of them - # to indicate negation. Examples include: * name * source_properties.a_property * - # security_marks.marks.marka The supported operators are: * `=` for all value - # types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring - # matching, for strings. The supported value types are: * string literals in - # quotes. * integer literals without quotes. * boolean literals `true` and ` - # false` without quotes. The following field and operator combinations are - # supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `= - # `, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `< - # `, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 - # string. Examples: `event_time = "2019-06-10T16:07:18-07:00"` `event_time = - # 1560208038000` * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, - # `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid - # filter string. Use a partial match on the empty string to filter based on a - # property existing: `source_properties.my_property : ""` Use a negated partial - # match on the empty string to filter based on a property not existing: `- - # source_properties.my_property : ""` - # Corresponds to the JSON property `filter` - # @return [String] - attr_accessor :filter - - # Required. Expression that defines what assets fields to use for grouping ( - # including `state_change`). The string value should follow SQL syntax: comma - # separated list of fields. For example: "parent,resource_name". The following - # fields are supported: * resource_name * category * state * parent The - # following fields are supported when compare_duration is set: * state_change - # Corresponds to the JSON property `groupBy` - # @return [String] - attr_accessor :group_by - - # The maximum number of results to return in a single response. Default is 10, - # minimum is 1, maximum is 1000. - # Corresponds to the JSON property `pageSize` - # @return [Fixnum] - attr_accessor :page_size - - # The value returned by the last `GroupFindingsResponse`; indicates that this is - # a continuation of a prior `GroupFindings` call, and that the system should - # return the next page of data. - # Corresponds to the JSON property `pageToken` - # @return [String] - attr_accessor :page_token - - # Time used as a reference point when filtering findings. The filter is limited - # to findings existing at the supplied time and their values are those at that - # specific time. Absence of this field will default to the API's version of NOW. - # Corresponds to the JSON property `readTime` - # @return [String] - attr_accessor :read_time - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @compare_duration = args[:compare_duration] if args.key?(:compare_duration) - @filter = args[:filter] if args.key?(:filter) - @group_by = args[:group_by] if args.key?(:group_by) - @page_size = args[:page_size] if args.key?(:page_size) - @page_token = args[:page_token] if args.key?(:page_token) - @read_time = args[:read_time] if args.key?(:read_time) - end - end - - # Response message for group by findings. - class GroupFindingsResponse - include Google::Apis::Core::Hashable - - # Group results. There exists an element for each existing unique combination of - # property/values. The element contains a count for the number of times those - # specific property/values appear. - # Corresponds to the JSON property `groupByResults` - # @return [Array] - attr_accessor :group_by_results - - # Token to retrieve the next page of results, or empty if there are no more - # results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # Time used for executing the groupBy request. - # Corresponds to the JSON property `readTime` - # @return [String] - attr_accessor :read_time - - # The total number of results matching the query. - # Corresponds to the JSON property `totalSize` - # @return [Fixnum] - attr_accessor :total_size - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @group_by_results = args[:group_by_results] if args.key?(:group_by_results) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @read_time = args[:read_time] if args.key?(:read_time) - @total_size = args[:total_size] if args.key?(:total_size) - end - end - - # Result containing the properties and count of a groupBy request. - class GroupResult - include Google::Apis::Core::Hashable - - # Total count of resources for the given properties. - # Corresponds to the JSON property `count` - # @return [Fixnum] - attr_accessor :count - - # Properties matching the groupBy fields in the request. - # Corresponds to the JSON property `properties` - # @return [Hash] - attr_accessor :properties - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @count = args[:count] if args.key?(:count) - @properties = args[:properties] if args.key?(:properties) - end - end - - # Response message for listing assets. - class ListAssetsResponse - include Google::Apis::Core::Hashable - - # Assets matching the list request. - # Corresponds to the JSON property `listAssetsResults` - # @return [Array] - attr_accessor :list_assets_results - - # Token to retrieve the next page of results, or empty if there are no more - # results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # Time used for executing the list request. - # Corresponds to the JSON property `readTime` - # @return [String] - attr_accessor :read_time - - # The total number of assets matching the query. - # Corresponds to the JSON property `totalSize` - # @return [Fixnum] - attr_accessor :total_size - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @list_assets_results = args[:list_assets_results] if args.key?(:list_assets_results) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @read_time = args[:read_time] if args.key?(:read_time) - @total_size = args[:total_size] if args.key?(:total_size) - end - end - - # Result containing the Asset and its State. - class ListAssetsResult - include Google::Apis::Core::Hashable - - # Security Command Center representation of a Google Cloud resource. The Asset - # is a Security Command Center resource that captures information about a single - # Google Cloud resource. All modifications to an Asset are only within the - # context of Security Command Center and don't affect the referenced Google - # Cloud resource. - # Corresponds to the JSON property `asset` - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Asset] - attr_accessor :asset - - # State change of the asset between the points in time. - # Corresponds to the JSON property `stateChange` - # @return [String] - attr_accessor :state_change - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @asset = args[:asset] if args.key?(:asset) - @state_change = args[:state_change] if args.key?(:state_change) - end - end - - # Response message for listing findings. - class ListFindingsResponse - include Google::Apis::Core::Hashable - - # Findings matching the list request. - # Corresponds to the JSON property `listFindingsResults` - # @return [Array] - attr_accessor :list_findings_results - - # Token to retrieve the next page of results, or empty if there are no more - # results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # Time used for executing the list request. - # Corresponds to the JSON property `readTime` - # @return [String] - attr_accessor :read_time - - # The total number of findings matching the query. - # Corresponds to the JSON property `totalSize` - # @return [Fixnum] - attr_accessor :total_size - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @list_findings_results = args[:list_findings_results] if args.key?(:list_findings_results) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @read_time = args[:read_time] if args.key?(:read_time) - @total_size = args[:total_size] if args.key?(:total_size) - end - end - - # Result containing the Finding and its StateChange. - class ListFindingsResult - include Google::Apis::Core::Hashable - - # Security Command Center finding. A finding is a record of assessment data ( - # security, risk, health or privacy) ingested into Security Command Center for - # presentation, notification, analysis, policy testing, and enforcement. For - # example, an XSS vulnerability in an App Engine application is a finding. - # Corresponds to the JSON property `finding` - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] - attr_accessor :finding - - # Information related to the Google Cloud resource that is associated with this - # finding. - # Corresponds to the JSON property `resource` - # @return [Google::Apis::SecuritycenterV1p1beta1::Resource] - attr_accessor :resource - - # State change of the finding between the points in time. - # Corresponds to the JSON property `stateChange` - # @return [String] - attr_accessor :state_change - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @finding = args[:finding] if args.key?(:finding) - @resource = args[:resource] if args.key?(:resource) - @state_change = args[:state_change] if args.key?(:state_change) - end - end - - # Response message for listing notification configs. - class ListNotificationConfigsResponse - include Google::Apis::Core::Hashable - - # Token to retrieve the next page of results, or empty if there are no more - # results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # Notification configs belonging to the requested parent. - # Corresponds to the JSON property `notificationConfigs` - # @return [Array] - attr_accessor :notification_configs - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @notification_configs = args[:notification_configs] if args.key?(:notification_configs) - end - end - - # The response message for Operations.ListOperations. - class ListOperationsResponse - include Google::Apis::Core::Hashable - - # The standard List next-page token. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # A list of operations that matches the specified filter in the request. - # Corresponds to the JSON property `operations` - # @return [Array] - attr_accessor :operations - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @operations = args[:operations] if args.key?(:operations) - end - end - - # Response message for listing sources. - class ListSourcesResponse - include Google::Apis::Core::Hashable - - # Token to retrieve the next page of results, or empty if there are no more - # results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # Sources belonging to the requested parent. - # Corresponds to the JSON property `sources` - # @return [Array] - attr_accessor :sources - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @sources = args[:sources] if args.key?(:sources) - end - end - - # Security Command Center notification configs. A notification config is a - # Security Command Center resource that contains the configuration to send - # notifications for create/update events of findings, assets and etc. - class NotificationConfig - include Google::Apis::Core::Hashable - - # The description of the notification config (max of 1024 characters). - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # The type of events the config is for, e.g. FINDING. - # Corresponds to the JSON property `eventType` - # @return [String] - attr_accessor :event_type - - # The relative resource name of this notification config. See: https://cloud. - # google.com/apis/design/resource_names#relative_resource_name Example: " - # organizations/`organization_id`/notificationConfigs/notify_public_bucket". - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The Pub/Sub topic to send notifications to. Its format is "projects/[ - # project_id]/topics/[topic]". - # Corresponds to the JSON property `pubsubTopic` - # @return [String] - attr_accessor :pubsub_topic - - # Output only. The service account that needs "pubsub.topics.publish" permission - # to publish to the Pub/Sub topic. - # Corresponds to the JSON property `serviceAccount` - # @return [String] - attr_accessor :service_account - - # The config for streaming-based notifications, which send each event as soon as - # it is detected. - # Corresponds to the JSON property `streamingConfig` - # @return [Google::Apis::SecuritycenterV1p1beta1::StreamingConfig] - attr_accessor :streaming_config - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @description = args[:description] if args.key?(:description) - @event_type = args[:event_type] if args.key?(:event_type) - @name = args[:name] if args.key?(:name) - @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic) - @service_account = args[:service_account] if args.key?(:service_account) - @streaming_config = args[:streaming_config] if args.key?(:streaming_config) - end - end - - # This resource represents a long-running operation that is the result of a - # network API call. - class Operation - include Google::Apis::Core::Hashable - - # 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. - # Corresponds to the JSON property `done` - # @return [Boolean] - attr_accessor :done - alias_method :done?, :done - - # 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). - # Corresponds to the JSON property `error` - # @return [Google::Apis::SecuritycenterV1p1beta1::Status] - attr_accessor :error - - # 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. - # Corresponds to the JSON property `metadata` - # @return [Hash] - attr_accessor :metadata - - # 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``. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # 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`. - # Corresponds to the JSON property `response` - # @return [Hash] - attr_accessor :response - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @done = args[:done] if args.key?(:done) - @error = args[:error] if args.key?(:error) - @metadata = args[:metadata] if args.key?(:metadata) - @name = args[:name] if args.key?(:name) - @response = args[:response] if args.key?(:response) - end - end - - # User specified settings that are attached to the Security Command Center - # organization. - class OrganizationSettings - include Google::Apis::Core::Hashable - - # The configuration used for Asset Discovery runs. - # Corresponds to the JSON property `assetDiscoveryConfig` - # @return [Google::Apis::SecuritycenterV1p1beta1::AssetDiscoveryConfig] - attr_accessor :asset_discovery_config - - # A flag that indicates if Asset Discovery should be enabled. If the flag is set - # to `true`, then discovery of assets will occur. If it is set to `false, all - # historical assets will remain, but discovery of future assets will not occur. - # Corresponds to the JSON property `enableAssetDiscovery` - # @return [Boolean] - attr_accessor :enable_asset_discovery - alias_method :enable_asset_discovery?, :enable_asset_discovery - - # The relative resource name of the settings. See: https://cloud.google.com/apis/ - # design/resource_names#relative_resource_name Example: "organizations/` - # organization_id`/organizationSettings". - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @asset_discovery_config = args[:asset_discovery_config] if args.key?(:asset_discovery_config) - @enable_asset_discovery = args[:enable_asset_discovery] if args.key?(:enable_asset_discovery) - @name = args[:name] if args.key?(:name) - end - end - - # 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/). - class Policy - include Google::Apis::Core::Hashable - - # Specifies cloud audit logging configuration for this policy. - # Corresponds to the JSON property `auditConfigs` - # @return [Array] - attr_accessor :audit_configs - - # 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. - # Corresponds to the JSON property `bindings` - # @return [Array] - attr_accessor :bindings - - # `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. - # Corresponds to the JSON property `etag` - # NOTE: Values are automatically base64 encoded/decoded in the client library. - # @return [String] - attr_accessor :etag - - # 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). - # Corresponds to the JSON property `version` - # @return [Fixnum] - attr_accessor :version - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @audit_configs = args[:audit_configs] if args.key?(:audit_configs) - @bindings = args[:bindings] if args.key?(:bindings) - @etag = args[:etag] if args.key?(:etag) - @version = args[:version] if args.key?(:version) - end - end - - # Information related to the Google Cloud resource that is associated with this - # finding. - class Resource - include Google::Apis::Core::Hashable - - # The full resource name of the resource. See: https://cloud.google.com/apis/ - # design/resource_names#full_resource_name - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The human readable name of resource's parent. - # Corresponds to the JSON property `parentDisplayName` - # @return [String] - attr_accessor :parent_display_name - - # The full resource name of resource's parent. - # Corresponds to the JSON property `parentName` - # @return [String] - attr_accessor :parent_name - - # The human readable name of project that the resource belongs to. - # Corresponds to the JSON property `projectDisplayName` - # @return [String] - attr_accessor :project_display_name - - # The full resource name of project that the resource belongs to. - # Corresponds to the JSON property `projectName` - # @return [String] - attr_accessor :project_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - @parent_display_name = args[:parent_display_name] if args.key?(:parent_display_name) - @parent_name = args[:parent_name] if args.key?(:parent_name) - @project_display_name = args[:project_display_name] if args.key?(:project_display_name) - @project_name = args[:project_name] if args.key?(:project_name) - end - end - - # Request message for running asset discovery for an organization. - class RunAssetDiscoveryRequest - include Google::Apis::Core::Hashable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - end - end - - # User specified security marks that are attached to the parent Security Command - # Center resource. Security marks are scoped within a Security Command Center - # organization -- they can be modified and viewed by all users who have proper - # permissions on the organization. - class SecurityMarks - include Google::Apis::Core::Hashable - - # Mutable user specified security marks belonging to the parent resource. - # Constraints are as follows: * Keys and values are treated as case insensitive * - # Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, - # numbers, underscores, or dashes * Values have leading and trailing whitespace - # trimmed, remaining characters must be between 1 - 4096 characters (inclusive) - # Corresponds to the JSON property `marks` - # @return [Hash] - attr_accessor :marks - - # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ - # apis/design/resource_names#relative_resource_name Examples: "organizations/` - # organization_id`/assets/`asset_id`/securityMarks" "organizations/` - # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @marks = args[:marks] if args.key?(:marks) - @name = args[:name] if args.key?(:name) - end - end - - # Request message for updating a finding's state. - class SetFindingStateRequest - include Google::Apis::Core::Hashable - - # Required. The time at which the updated state takes effect. - # Corresponds to the JSON property `startTime` - # @return [String] - attr_accessor :start_time - - # Required. The desired State of the finding. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @start_time = args[:start_time] if args.key?(:start_time) - @state = args[:state] if args.key?(:state) - end - end - - # Request message for `SetIamPolicy` method. - class SetIamPolicyRequest - include Google::Apis::Core::Hashable - - # 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/). - # Corresponds to the JSON property `policy` - # @return [Google::Apis::SecuritycenterV1p1beta1::Policy] - attr_accessor :policy - - # 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"` - # Corresponds to the JSON property `updateMask` - # @return [String] - attr_accessor :update_mask - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @policy = args[:policy] if args.key?(:policy) - @update_mask = args[:update_mask] if args.key?(:update_mask) - end - end - - # Security Command Center finding source. A finding source is an entity or a - # mechanism that can produce a finding. A source is like a container of findings - # that come from the same scanner, logger, monitor, etc. - class Source - include Google::Apis::Core::Hashable - - # The description of the source (max of 1024 characters). Example: "Web Security - # Scanner is a web security scanner for common vulnerabilities in App Engine - # applications. It can automatically scan and detect four common vulnerabilities, - # including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in - # HTTPS), and outdated/insecure libraries." - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # The source's display name. A source's display name must be unique amongst its - # siblings, for example, two sources with the same parent can't share the same - # display name. The display name must have a length between 1 and 64 characters ( - # inclusive). - # Corresponds to the JSON property `displayName` - # @return [String] - attr_accessor :display_name - - # The relative resource name of this source. See: https://cloud.google.com/apis/ - # design/resource_names#relative_resource_name Example: "organizations/` - # organization_id`/sources/`source_id`" - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @description = args[:description] if args.key?(:description) - @display_name = args[:display_name] if args.key?(:display_name) - @name = args[:name] if args.key?(:name) - end - end - - # 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). - class Status - include Google::Apis::Core::Hashable - - # The status code, which should be an enum value of google.rpc.Code. - # Corresponds to the JSON property `code` - # @return [Fixnum] - attr_accessor :code - - # A list of messages that carry the error details. There is a common set of - # message types for APIs to use. - # Corresponds to the JSON property `details` - # @return [Array>] - attr_accessor :details - - # 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. - # Corresponds to the JSON property `message` - # @return [String] - attr_accessor :message - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @code = args[:code] if args.key?(:code) - @details = args[:details] if args.key?(:details) - @message = args[:message] if args.key?(:message) - end - end - - # The config for streaming-based notifications, which send each event as soon as - # it is detected. - class StreamingConfig - include Google::Apis::Core::Hashable - - # Expression that defines the filter to apply across create/update events of - # assets or findings as specified by the event type. The expression is a list of - # zero or more restrictions combined via logical operators `AND` and `OR`. - # Parentheses are supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` character in front of them - # to indicate negation. The fields map to those defined in the corresponding - # resource. The supported operators are: * `=` for all value types. * `>`, `<`, ` - # >=`, `<=` for integer values. * `:`, meaning substring matching, for strings. - # The supported value types are: * string literals in quotes. * integer literals - # without quotes. * boolean literals `true` and `false` without quotes. - # Corresponds to the JSON property `filter` - # @return [String] - attr_accessor :filter - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @filter = args[:filter] if args.key?(:filter) - end - end - - # Request message for `TestIamPermissions` method. - class TestIamPermissionsRequest - include Google::Apis::Core::Hashable - - # 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). - # Corresponds to the JSON property `permissions` - # @return [Array] - attr_accessor :permissions - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @permissions = args[:permissions] if args.key?(:permissions) - end - end - - # Response message for `TestIamPermissions` method. - class TestIamPermissionsResponse - include Google::Apis::Core::Hashable - - # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. - # Corresponds to the JSON property `permissions` - # @return [Array] - attr_accessor :permissions - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @permissions = args[:permissions] if args.key?(:permissions) - end - end - end - end -end diff --git a/generated/google/apis/securitycenter_v1p1beta1/representations.rb b/generated/google/apis/securitycenter_v1p1beta1/representations.rb deleted file mode 100644 index 6a9a332d2..000000000 --- a/generated/google/apis/securitycenter_v1p1beta1/representations.rb +++ /dev/null @@ -1,790 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module SecuritycenterV1p1beta1 - - class AssetDiscoveryConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AuditConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AuditLogConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Binding - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Empty - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Expr - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Finding - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GetIamPolicyRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GetPolicyOptions - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1NotificationMessage - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1Resource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1Asset - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1Finding - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1IamPolicy - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1NotificationMessage - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1Resource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1SecurityMarks - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GoogleCloudSecuritycenterV1p1beta1TemporalAsset - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GroupAssetsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GroupAssetsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GroupFindingsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GroupFindingsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GroupResult - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListAssetsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListAssetsResult - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListFindingsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListFindingsResult - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListNotificationConfigsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListOperationsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListSourcesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class NotificationConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Operation - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class OrganizationSettings - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Policy - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Resource - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RunAssetDiscoveryRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SecurityMarks - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SetFindingStateRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SetIamPolicyRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Source - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Status - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class StreamingConfig - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TestIamPermissionsRequest - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TestIamPermissionsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AssetDiscoveryConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :inclusion_mode, as: 'inclusionMode' - collection :project_ids, as: 'projectIds' - end - end - - class AuditConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::SecuritycenterV1p1beta1::AuditLogConfig, decorator: Google::Apis::SecuritycenterV1p1beta1::AuditLogConfig::Representation - - property :service, as: 'service' - end - end - - class AuditLogConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :exempted_members, as: 'exemptedMembers' - property :log_type, as: 'logType' - end - end - - class Binding - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :condition, as: 'condition', class: Google::Apis::SecuritycenterV1p1beta1::Expr, decorator: Google::Apis::SecuritycenterV1p1beta1::Expr::Representation - - collection :members, as: 'members' - property :role, as: 'role' - end - end - - class Empty - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class Expr - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :description, as: 'description' - property :expression, as: 'expression' - property :location, as: 'location' - property :title, as: 'title' - end - end - - class Finding - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :category, as: 'category' - property :create_time, as: 'createTime' - property :event_time, as: 'eventTime' - property :external_uri, as: 'externalUri' - property :name, as: 'name' - property :parent, as: 'parent' - property :resource_name, as: 'resourceName' - property :security_marks, as: 'securityMarks', class: Google::Apis::SecuritycenterV1p1beta1::SecurityMarks, decorator: Google::Apis::SecuritycenterV1p1beta1::SecurityMarks::Representation - - hash :source_properties, as: 'sourceProperties' - property :state, as: 'state' - end - end - - class GetIamPolicyRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :options, as: 'options', class: Google::Apis::SecuritycenterV1p1beta1::GetPolicyOptions, decorator: Google::Apis::SecuritycenterV1p1beta1::GetPolicyOptions::Representation - - end - end - - class GetPolicyOptions - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :requested_policy_version, as: 'requestedPolicyVersion' - end - end - - class GoogleCloudSecuritycenterV1NotificationMessage - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :finding, as: 'finding', class: Google::Apis::SecuritycenterV1p1beta1::Finding, decorator: Google::Apis::SecuritycenterV1p1beta1::Finding::Representation - - property :notification_config_name, as: 'notificationConfigName' - property :resource, as: 'resource', class: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1Resource, decorator: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1Resource::Representation - - end - end - - class GoogleCloudSecuritycenterV1Resource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - property :parent, as: 'parent' - property :parent_display_name, as: 'parentDisplayName' - property :project, as: 'project' - property :project_display_name, as: 'projectDisplayName' - end - end - - class GoogleCloudSecuritycenterV1RunAssetDiscoveryResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :duration, as: 'duration' - property :state, as: 'state' - end - end - - class GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :duration, as: 'duration' - property :state, as: 'state' - end - end - - class GoogleCloudSecuritycenterV1p1beta1Asset - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :create_time, as: 'createTime' - property :iam_policy, as: 'iamPolicy', class: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1IamPolicy, decorator: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1IamPolicy::Representation - - property :name, as: 'name' - hash :resource_properties, as: 'resourceProperties' - property :security_center_properties, as: 'securityCenterProperties', class: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties, decorator: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties::Representation - - property :security_marks, as: 'securityMarks', class: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks, decorator: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation - - property :update_time, as: 'updateTime' - end - end - - class GoogleCloudSecuritycenterV1p1beta1Finding - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :category, as: 'category' - property :create_time, as: 'createTime' - property :event_time, as: 'eventTime' - property :external_uri, as: 'externalUri' - property :name, as: 'name' - property :parent, as: 'parent' - property :resource_name, as: 'resourceName' - property :security_marks, as: 'securityMarks', class: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks, decorator: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation - - property :severity, as: 'severity' - hash :source_properties, as: 'sourceProperties' - property :state, as: 'state' - end - end - - class GoogleCloudSecuritycenterV1p1beta1IamPolicy - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :policy_blob, as: 'policyBlob' - end - end - - class GoogleCloudSecuritycenterV1p1beta1NotificationMessage - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :finding, as: 'finding', class: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding, decorator: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding::Representation - - property :notification_config_name, as: 'notificationConfigName' - property :resource, as: 'resource', class: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Resource, decorator: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Resource::Representation - - property :temporal_asset, as: 'temporalAsset', class: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1TemporalAsset, decorator: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1TemporalAsset::Representation - - end - end - - class GoogleCloudSecuritycenterV1p1beta1Resource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - property :parent, as: 'parent' - property :parent_display_name, as: 'parentDisplayName' - property :project, as: 'project' - property :project_display_name, as: 'projectDisplayName' - end - end - - class GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :duration, as: 'duration' - property :state, as: 'state' - end - end - - class GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :resource_display_name, as: 'resourceDisplayName' - property :resource_name, as: 'resourceName' - collection :resource_owners, as: 'resourceOwners' - property :resource_parent, as: 'resourceParent' - property :resource_parent_display_name, as: 'resourceParentDisplayName' - property :resource_project, as: 'resourceProject' - property :resource_project_display_name, as: 'resourceProjectDisplayName' - property :resource_type, as: 'resourceType' - end - end - - class GoogleCloudSecuritycenterV1p1beta1SecurityMarks - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :marks, as: 'marks' - property :name, as: 'name' - end - end - - class GoogleCloudSecuritycenterV1p1beta1TemporalAsset - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :asset, as: 'asset', class: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Asset, decorator: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Asset::Representation - - property :change_type, as: 'changeType' - end - end - - class GroupAssetsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :compare_duration, as: 'compareDuration' - property :filter, as: 'filter' - property :group_by, as: 'groupBy' - property :page_size, as: 'pageSize' - property :page_token, as: 'pageToken' - property :read_time, as: 'readTime' - end - end - - class GroupAssetsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :group_by_results, as: 'groupByResults', class: Google::Apis::SecuritycenterV1p1beta1::GroupResult, decorator: Google::Apis::SecuritycenterV1p1beta1::GroupResult::Representation - - property :next_page_token, as: 'nextPageToken' - property :read_time, as: 'readTime' - property :total_size, as: 'totalSize' - end - end - - class GroupFindingsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :compare_duration, as: 'compareDuration' - property :filter, as: 'filter' - property :group_by, as: 'groupBy' - property :page_size, as: 'pageSize' - property :page_token, as: 'pageToken' - property :read_time, as: 'readTime' - end - end - - class GroupFindingsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :group_by_results, as: 'groupByResults', class: Google::Apis::SecuritycenterV1p1beta1::GroupResult, decorator: Google::Apis::SecuritycenterV1p1beta1::GroupResult::Representation - - property :next_page_token, as: 'nextPageToken' - property :read_time, as: 'readTime' - property :total_size, as: 'totalSize' - end - end - - class GroupResult - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :count, :numeric_string => true, as: 'count' - hash :properties, as: 'properties' - end - end - - class ListAssetsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :list_assets_results, as: 'listAssetsResults', class: Google::Apis::SecuritycenterV1p1beta1::ListAssetsResult, decorator: Google::Apis::SecuritycenterV1p1beta1::ListAssetsResult::Representation - - property :next_page_token, as: 'nextPageToken' - property :read_time, as: 'readTime' - property :total_size, as: 'totalSize' - end - end - - class ListAssetsResult - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :asset, as: 'asset', class: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Asset, decorator: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Asset::Representation - - property :state_change, as: 'stateChange' - end - end - - class ListFindingsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :list_findings_results, as: 'listFindingsResults', class: Google::Apis::SecuritycenterV1p1beta1::ListFindingsResult, decorator: Google::Apis::SecuritycenterV1p1beta1::ListFindingsResult::Representation - - property :next_page_token, as: 'nextPageToken' - property :read_time, as: 'readTime' - property :total_size, as: 'totalSize' - end - end - - class ListFindingsResult - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :finding, as: 'finding', class: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding, decorator: Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding::Representation - - property :resource, as: 'resource', class: Google::Apis::SecuritycenterV1p1beta1::Resource, decorator: Google::Apis::SecuritycenterV1p1beta1::Resource::Representation - - property :state_change, as: 'stateChange' - end - end - - class ListNotificationConfigsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :notification_configs, as: 'notificationConfigs', class: Google::Apis::SecuritycenterV1p1beta1::NotificationConfig, decorator: Google::Apis::SecuritycenterV1p1beta1::NotificationConfig::Representation - - end - end - - class ListOperationsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :operations, as: 'operations', class: Google::Apis::SecuritycenterV1p1beta1::Operation, decorator: Google::Apis::SecuritycenterV1p1beta1::Operation::Representation - - end - end - - class ListSourcesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :sources, as: 'sources', class: Google::Apis::SecuritycenterV1p1beta1::Source, decorator: Google::Apis::SecuritycenterV1p1beta1::Source::Representation - - end - end - - class NotificationConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :description, as: 'description' - property :event_type, as: 'eventType' - property :name, as: 'name' - property :pubsub_topic, as: 'pubsubTopic' - property :service_account, as: 'serviceAccount' - property :streaming_config, as: 'streamingConfig', class: Google::Apis::SecuritycenterV1p1beta1::StreamingConfig, decorator: Google::Apis::SecuritycenterV1p1beta1::StreamingConfig::Representation - - end - end - - class Operation - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :done, as: 'done' - property :error, as: 'error', class: Google::Apis::SecuritycenterV1p1beta1::Status, decorator: Google::Apis::SecuritycenterV1p1beta1::Status::Representation - - hash :metadata, as: 'metadata' - property :name, as: 'name' - hash :response, as: 'response' - end - end - - class OrganizationSettings - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :asset_discovery_config, as: 'assetDiscoveryConfig', class: Google::Apis::SecuritycenterV1p1beta1::AssetDiscoveryConfig, decorator: Google::Apis::SecuritycenterV1p1beta1::AssetDiscoveryConfig::Representation - - property :enable_asset_discovery, as: 'enableAssetDiscovery' - property :name, as: 'name' - end - end - - class Policy - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :audit_configs, as: 'auditConfigs', class: Google::Apis::SecuritycenterV1p1beta1::AuditConfig, decorator: Google::Apis::SecuritycenterV1p1beta1::AuditConfig::Representation - - collection :bindings, as: 'bindings', class: Google::Apis::SecuritycenterV1p1beta1::Binding, decorator: Google::Apis::SecuritycenterV1p1beta1::Binding::Representation - - property :etag, :base64 => true, as: 'etag' - property :version, as: 'version' - end - end - - class Resource - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - property :parent_display_name, as: 'parentDisplayName' - property :parent_name, as: 'parentName' - property :project_display_name, as: 'projectDisplayName' - property :project_name, as: 'projectName' - end - end - - class RunAssetDiscoveryRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - end - end - - class SecurityMarks - # @private - class Representation < Google::Apis::Core::JsonRepresentation - hash :marks, as: 'marks' - property :name, as: 'name' - end - end - - class SetFindingStateRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :start_time, as: 'startTime' - property :state, as: 'state' - end - end - - class SetIamPolicyRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :policy, as: 'policy', class: Google::Apis::SecuritycenterV1p1beta1::Policy, decorator: Google::Apis::SecuritycenterV1p1beta1::Policy::Representation - - property :update_mask, as: 'updateMask' - end - end - - class Source - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :description, as: 'description' - property :display_name, as: 'displayName' - property :name, as: 'name' - end - end - - class Status - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :code, as: 'code' - collection :details, as: 'details' - property :message, as: 'message' - end - end - - class StreamingConfig - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :filter, as: 'filter' - end - end - - class TestIamPermissionsRequest - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :permissions, as: 'permissions' - end - end - - class TestIamPermissionsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :permissions, as: 'permissions' - end - end - end - end -end diff --git a/generated/google/apis/securitycenter_v1p1beta1/service.rb b/generated/google/apis/securitycenter_v1p1beta1/service.rb deleted file mode 100644 index 92fda07e8..000000000 --- a/generated/google/apis/securitycenter_v1p1beta1/service.rb +++ /dev/null @@ -1,1243 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module SecuritycenterV1p1beta1 - # Security Command Center API - # - # Security Command Center API provides access to temporal views of assets and - # findings within an organization. - # - # @example - # require 'google/apis/securitycenter_v1p1beta1' - # - # Securitycenter = Google::Apis::SecuritycenterV1p1beta1 # Alias the module - # service = Securitycenter::SecurityCommandCenterService.new - # - # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview - class SecurityCommandCenterService < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - - # @return [String] - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - attr_accessor :quota_user - - def initialize - super('https://securitycenter.googleapis.com/', '') - @batch_path = 'batch' - end - - # Gets the settings for an organization. - # @param [String] name - # Required. Name of the organization to get organization settings for. Its - # format is "organizations/[organization_id]/organizationSettings". - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::OrganizationSettings] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::OrganizationSettings] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_organization_organization_settings(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1p1beta1/{+name}', options) - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::OrganizationSettings::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::OrganizationSettings - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates an organization's settings. - # @param [String] name - # The relative resource name of the settings. See: https://cloud.google.com/apis/ - # design/resource_names#relative_resource_name Example: "organizations/` - # organization_id`/organizationSettings". - # @param [Google::Apis::SecuritycenterV1p1beta1::OrganizationSettings] organization_settings_object - # @param [String] update_mask - # The FieldMask to use when updating the settings resource. If empty all mutable - # fields will be updated. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::OrganizationSettings] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::OrganizationSettings] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_organization_organization_settings(name, organization_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v1p1beta1/{+name}', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::OrganizationSettings::Representation - command.request_object = organization_settings_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::OrganizationSettings::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::OrganizationSettings - command.params['name'] = name unless name.nil? - command.query['updateMask'] = update_mask unless update_mask.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Filters an organization's assets and groups them by their specified properties. - # @param [String] parent - # Required. Name of the organization to groupBy. Its format is "organizations/[ - # organization_id]". - # @param [Google::Apis::SecuritycenterV1p1beta1::GroupAssetsRequest] group_assets_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::GroupAssetsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::GroupAssetsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def group_assets(parent, group_assets_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1p1beta1/{+parent}/assets:group', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::GroupAssetsRequest::Representation - command.request_object = group_assets_request_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::GroupAssetsResponse::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::GroupAssetsResponse - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists an organization's assets. - # @param [String] parent - # Required. Name of the organization assets should belong to. Its format is " - # organizations/[organization_id]". - # @param [String] compare_duration - # When compare_duration is set, the ListAssetsResult's "state_change" attribute - # is updated to indicate whether the asset was added, removed, or remained - # present during the compare_duration period of time that precedes the read_time. - # This is the time between (read_time - compare_duration) and read_time. The - # state_change value is derived based on the presence of the asset at the two - # points in time. Intermediate state changes between the two times don't affect - # the result. For example, the results aren't affected if the asset is removed - # and re-created again. Possible "state_change" values when compare_duration is - # specified: * "ADDED": indicates that the asset was not present at the start of - # compare_duration, but present at read_time. * "REMOVED": indicates that the - # asset was present at the start of compare_duration, but not present at - # read_time. * "ACTIVE": indicates that the asset was present at both the start - # and the end of the time period defined by compare_duration and read_time. If - # compare_duration is not specified, then the only possible state_change is " - # UNUSED", which will be the state_change set for all assets present at - # read_time. - # @param [String] field_mask - # A field mask to specify the ListAssetsResult fields to be listed in the - # response. An empty field mask will list all fields. - # @param [String] filter - # Expression that defines the filter to apply across assets. The expression is a - # list of zero or more restrictions combined via logical operators `AND` and `OR` - # . Parentheses are supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` character in front of them - # to indicate negation. The fields map to those defined in the Asset resource. - # Examples include: * name * security_center_properties.resource_name * - # resource_properties.a_property * security_marks.marks.marka The supported - # operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer - # values. * `:`, meaning substring matching, for strings. The supported value - # types are: * string literals in quotes. * integer literals without quotes. * - # boolean literals `true` and `false` without quotes. The following are the - # allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, ` - # <`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 - # string. Examples: `update_time = "2019-06-10T16:07:18-07:00"` `update_time = - # 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be - # milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019- - # 06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_policy.policy_blob: - # `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * - # security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, - # `:` * security_center_properties.resource_display_name: `=`, `:` * - # security_center_properties.resource_type: `=`, `:` * - # security_center_properties.resource_parent: `=`, `:` * - # security_center_properties.resource_parent_display_name: `=`, `:` * - # security_center_properties.resource_project: `=`, `:` * - # security_center_properties.resource_project_display_name: `=`, `:` * - # security_center_properties.resource_owners: `=`, `:` For example, ` - # resource_properties.size = 100` is a valid filter string. Use a partial match - # on the empty string to filter based on a property existing: ` - # resource_properties.my_property : ""` Use a negated partial match on the empty - # string to filter based on a property not existing: `-resource_properties. - # my_property : ""` - # @param [String] order_by - # Expression that defines what fields and order to use for sorting. The string - # value should follow SQL syntax: comma separated list of fields. For example: " - # name,resource_properties.a_property". The default sorting order is ascending. - # To specify descending order for a field, a suffix " desc" should be appended - # to the field name. For example: "name desc,resource_properties.a_property". - # Redundant space characters in the syntax are insignificant. "name desc, - # resource_properties.a_property" and " name desc , resource_properties. - # a_property " are equivalent. The following fields are supported: name - # update_time resource_properties security_marks.marks - # security_center_properties.resource_name security_center_properties. - # resource_display_name security_center_properties.resource_parent - # security_center_properties.resource_parent_display_name - # security_center_properties.resource_project security_center_properties. - # resource_project_display_name security_center_properties.resource_type - # @param [Fixnum] page_size - # The maximum number of results to return in a single response. Default is 10, - # minimum is 1, maximum is 1000. - # @param [String] page_token - # The value returned by the last `ListAssetsResponse`; indicates that this is a - # continuation of a prior `ListAssets` call, and that the system should return - # the next page of data. - # @param [String] read_time - # Time used as a reference point when filtering assets. The filter is limited to - # assets existing at the supplied time and their values are those at that - # specific time. Absence of this field will default to the API's version of NOW. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::ListAssetsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::ListAssetsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_organization_assets(parent, compare_duration: nil, field_mask: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_time: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1p1beta1/{+parent}/assets', options) - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::ListAssetsResponse::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::ListAssetsResponse - command.params['parent'] = parent unless parent.nil? - command.query['compareDuration'] = compare_duration unless compare_duration.nil? - command.query['fieldMask'] = field_mask unless field_mask.nil? - command.query['filter'] = filter unless filter.nil? - command.query['orderBy'] = order_by unless order_by.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['readTime'] = read_time unless read_time.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Runs asset discovery. The discovery is tracked with a long-running operation. - # This API can only be called with limited frequency for an organization. If it - # is called too frequently the caller will receive a TOO_MANY_REQUESTS error. - # @param [String] parent - # Required. Name of the organization to run asset discovery for. Its format is " - # organizations/[organization_id]". - # @param [Google::Apis::SecuritycenterV1p1beta1::RunAssetDiscoveryRequest] run_asset_discovery_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def run_organization_asset_discovery(parent, run_asset_discovery_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1p1beta1/{+parent}/assets:runDiscovery', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::RunAssetDiscoveryRequest::Representation - command.request_object = run_asset_discovery_request_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::Operation::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::Operation - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates security marks. - # @param [String] name - # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ - # apis/design/resource_names#relative_resource_name Examples: "organizations/` - # organization_id`/assets/`asset_id`/securityMarks" "organizations/` - # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". - # @param [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] google_cloud_securitycenter_v1p1beta1_security_marks_object - # @param [String] start_time - # The time at which the updated SecurityMarks take effect. If not set uses - # current server time. Updates will be applied to the SecurityMarks that are - # active immediately preceding this time. - # @param [String] update_mask - # The FieldMask to use when updating the security marks resource. The field mask - # must not contain duplicate fields. If empty or set to "marks", all marks will - # be replaced. Individual marks can be updated using "marks.". - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_organization_asset_security_marks(name, google_cloud_securitycenter_v1p1beta1_security_marks_object = nil, start_time: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v1p1beta1/{+name}', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation - command.request_object = google_cloud_securitycenter_v1p1beta1_security_marks_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks - command.params['name'] = name unless name.nil? - command.query['startTime'] = start_time unless start_time.nil? - command.query['updateMask'] = update_mask unless update_mask.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a notification config. - # @param [String] parent - # Required. Resource name of the new notification config's parent. Its format is - # "organizations/[organization_id]". - # @param [Google::Apis::SecuritycenterV1p1beta1::NotificationConfig] notification_config_object - # @param [String] config_id - # Required. Unique identifier provided by the client within the parent scope. It - # must be between 1 and 128 characters, and contains alphanumeric characters, - # underscores or hyphens only. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::NotificationConfig] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::NotificationConfig] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_organization_notification_config(parent, notification_config_object = nil, config_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1p1beta1/{+parent}/notificationConfigs', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::NotificationConfig::Representation - command.request_object = notification_config_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::NotificationConfig::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::NotificationConfig - command.params['parent'] = parent unless parent.nil? - command.query['configId'] = config_id unless config_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a notification config. - # @param [String] name - # Required. Name of the notification config to delete. Its format is " - # organizations/[organization_id]/notificationConfigs/[config_id]". - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_organization_notification_config(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v1p1beta1/{+name}', options) - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::Empty::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::Empty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a notification config. - # @param [String] name - # Required. Name of the notification config to get. Its format is "organizations/ - # [organization_id]/notificationConfigs/[config_id]". - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::NotificationConfig] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::NotificationConfig] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_organization_notification_config(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1p1beta1/{+name}', options) - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::NotificationConfig::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::NotificationConfig - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists notification configs. - # @param [String] parent - # Required. Name of the organization to list notification configs. Its format is - # "organizations/[organization_id]". - # @param [Fixnum] page_size - # The maximum number of results to return in a single response. Default is 10, - # minimum is 1, maximum is 1000. - # @param [String] page_token - # The value returned by the last `ListNotificationConfigsResponse`; indicates - # that this is a continuation of a prior `ListNotificationConfigs` call, and - # that the system should return the next page of data. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::ListNotificationConfigsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::ListNotificationConfigsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_organization_notification_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1p1beta1/{+parent}/notificationConfigs', options) - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::ListNotificationConfigsResponse::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::ListNotificationConfigsResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a notification config. The following update fields are allowed: - # description, pubsub_topic, streaming_config.filter - # @param [String] name - # The relative resource name of this notification config. See: https://cloud. - # google.com/apis/design/resource_names#relative_resource_name Example: " - # organizations/`organization_id`/notificationConfigs/notify_public_bucket". - # @param [Google::Apis::SecuritycenterV1p1beta1::NotificationConfig] notification_config_object - # @param [String] update_mask - # The FieldMask to use when updating the notification config. If empty all - # mutable fields will be updated. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::NotificationConfig] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::NotificationConfig] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_organization_notification_config(name, notification_config_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v1p1beta1/{+name}', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::NotificationConfig::Representation - command.request_object = notification_config_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::NotificationConfig::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::NotificationConfig - command.params['name'] = name unless name.nil? - command.query['updateMask'] = update_mask unless update_mask.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # 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`. - # @param [String] name - # The name of the operation resource to be cancelled. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def cancel_organization_operation(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1p1beta1/{+name}:cancel', options) - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::Empty::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::Empty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a long-running operation. This method indicates that the client is no - # longer interested in the operation result. It does not cancel the operation. - # If the server doesn't support this method, it returns `google.rpc.Code. - # UNIMPLEMENTED`. - # @param [String] name - # The name of the operation resource to be deleted. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::Empty] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::Empty] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_organization_operation(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'v1p1beta1/{+name}', options) - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::Empty::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::Empty - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # 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. - # @param [String] name - # The name of the operation resource. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::Operation] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::Operation] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_organization_operation(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1p1beta1/{+name}', options) - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::Operation::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::Operation - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # 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. - # @param [String] name - # The name of the operation's parent resource. - # @param [String] filter - # The standard list filter. - # @param [Fixnum] page_size - # The standard list page size. - # @param [String] page_token - # The standard list page token. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::ListOperationsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::ListOperationsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_organization_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1p1beta1/{+name}', options) - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::ListOperationsResponse::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::ListOperationsResponse - command.params['name'] = name unless name.nil? - command.query['filter'] = filter unless filter.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a source. - # @param [String] parent - # Required. Resource name of the new source's parent. Its format should be " - # organizations/[organization_id]". - # @param [Google::Apis::SecuritycenterV1p1beta1::Source] source_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::Source] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::Source] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_organization_source(parent, source_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1p1beta1/{+parent}/sources', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::Source::Representation - command.request_object = source_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::Source::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::Source - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a source. - # @param [String] name - # Required. Relative resource name of the source. Its format is "organizations/[ - # organization_id]/source/[source_id]". - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::Source] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::Source] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_organization_source(name, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1p1beta1/{+name}', options) - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::Source::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::Source - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets the access control policy on the specified Source. - # @param [String] resource - # REQUIRED: The resource for which the policy is being requested. See the - # operation documentation for the appropriate value for this field. - # @param [Google::Apis::SecuritycenterV1p1beta1::GetIamPolicyRequest] get_iam_policy_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::Policy] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::Policy] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_source_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1p1beta1/{+resource}:getIamPolicy', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::GetIamPolicyRequest::Representation - command.request_object = get_iam_policy_request_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::Policy::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::Policy - command.params['resource'] = resource unless resource.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all sources belonging to an organization. - # @param [String] parent - # Required. Resource name of the parent of sources to list. Its format should be - # "organizations/[organization_id]". - # @param [Fixnum] page_size - # The maximum number of results to return in a single response. Default is 10, - # minimum is 1, maximum is 1000. - # @param [String] page_token - # The value returned by the last `ListSourcesResponse`; indicates that this is a - # continuation of a prior `ListSources` call, and that the system should return - # the next page of data. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::ListSourcesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::ListSourcesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_organization_sources(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1p1beta1/{+parent}/sources', options) - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::ListSourcesResponse::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::ListSourcesResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a source. - # @param [String] name - # The relative resource name of this source. See: https://cloud.google.com/apis/ - # design/resource_names#relative_resource_name Example: "organizations/` - # organization_id`/sources/`source_id`" - # @param [Google::Apis::SecuritycenterV1p1beta1::Source] source_object - # @param [String] update_mask - # The FieldMask to use when updating the source resource. If empty all mutable - # fields will be updated. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::Source] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::Source] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_organization_source(name, source_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v1p1beta1/{+name}', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::Source::Representation - command.request_object = source_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::Source::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::Source - command.params['name'] = name unless name.nil? - command.query['updateMask'] = update_mask unless update_mask.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Sets the access control policy on the specified Source. - # @param [String] resource - # REQUIRED: The resource for which the policy is being specified. See the - # operation documentation for the appropriate value for this field. - # @param [Google::Apis::SecuritycenterV1p1beta1::SetIamPolicyRequest] set_iam_policy_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::Policy] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::Policy] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def set_source_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1p1beta1/{+resource}:setIamPolicy', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::SetIamPolicyRequest::Representation - command.request_object = set_iam_policy_request_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::Policy::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::Policy - command.params['resource'] = resource unless resource.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Returns the permissions that a caller has on the specified source. - # @param [String] resource - # REQUIRED: The resource for which the policy detail is being requested. See the - # operation documentation for the appropriate value for this field. - # @param [Google::Apis::SecuritycenterV1p1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::TestIamPermissionsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::TestIamPermissionsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def test_source_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1p1beta1/{+resource}:testIamPermissions', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::TestIamPermissionsRequest::Representation - command.request_object = test_iam_permissions_request_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::TestIamPermissionsResponse::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::TestIamPermissionsResponse - command.params['resource'] = resource unless resource.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a finding. The corresponding source must exist for finding creation to - # succeed. - # @param [String] parent - # Required. Resource name of the new finding's parent. Its format should be " - # organizations/[organization_id]/sources/[source_id]". - # @param [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] google_cloud_securitycenter_v1p1beta1_finding_object - # @param [String] finding_id - # Required. Unique identifier provided by the client within the parent scope. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_organization_source_finding(parent, google_cloud_securitycenter_v1p1beta1_finding_object = nil, finding_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1p1beta1/{+parent}/findings', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding::Representation - command.request_object = google_cloud_securitycenter_v1p1beta1_finding_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding - command.params['parent'] = parent unless parent.nil? - command.query['findingId'] = finding_id unless finding_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Filters an organization or source's findings and groups them by their - # specified properties. To group across all sources provide a `-` as the source - # id. Example: /v1p1beta1/organizations/`organization_id`/sources/-/findings - # @param [String] parent - # Required. Name of the source to groupBy. Its format is "organizations/[ - # organization_id]/sources/[source_id]". To groupBy across all sources provide a - # source_id of `-`. For example: organizations/`organization_id`/sources/- - # @param [Google::Apis::SecuritycenterV1p1beta1::GroupFindingsRequest] group_findings_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::GroupFindingsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::GroupFindingsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def group_findings(parent, group_findings_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1p1beta1/{+parent}/findings:group', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::GroupFindingsRequest::Representation - command.request_object = group_findings_request_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::GroupFindingsResponse::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::GroupFindingsResponse - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists an organization or source's findings. To list across all sources provide - # a `-` as the source id. Example: /v1p1beta1/organizations/`organization_id`/ - # sources/-/findings - # @param [String] parent - # Required. Name of the source the findings belong to. Its format is " - # organizations/[organization_id]/sources/[source_id]". To list across all - # sources provide a source_id of `-`. For example: organizations/` - # organization_id`/sources/- - # @param [String] compare_duration - # When compare_duration is set, the ListFindingsResult's "state_change" - # attribute is updated to indicate whether the finding had its state changed, - # the finding's state remained unchanged, or if the finding was added in any - # state during the compare_duration period of time that precedes the read_time. - # This is the time between (read_time - compare_duration) and read_time. The - # state_change value is derived based on the presence and state of the finding - # at the two points in time. Intermediate state changes between the two times - # don't affect the result. For example, the results aren't affected if the - # finding is made inactive and then active again. Possible "state_change" values - # when compare_duration is specified: * "CHANGED": indicates that the finding - # was present and matched the given filter at the start of compare_duration, but - # changed its state at read_time. * "UNCHANGED": indicates that the finding was - # present and matched the given filter at the start of compare_duration and did - # not change state at read_time. * "ADDED": indicates that the finding did not - # match the given filter or was not present at the start of compare_duration, - # but was present at read_time. * "REMOVED": indicates that the finding was - # present and matched the filter at the start of compare_duration, but did not - # match the filter at read_time. If compare_duration is not specified, then the - # only possible state_change is "UNUSED", which will be the state_change set for - # all findings present at read_time. - # @param [String] field_mask - # A field mask to specify the Finding fields to be listed in the response. An - # empty field mask will list all fields. - # @param [String] filter - # Expression that defines the filter to apply across findings. The expression is - # a list of one or more restrictions combined via logical operators `AND` and ` - # OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. - # Restrictions have the form ` ` and may have a `-` character in front of them - # to indicate negation. Examples include: * name * source_properties.a_property * - # security_marks.marks.marka The supported operators are: * `=` for all value - # types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring - # matching, for strings. The supported value types are: * string literals in - # quotes. * integer literals without quotes. * boolean literals `true` and ` - # false` without quotes. The following field and operator combinations are - # supported: name: `=` parent: `=`, `:` resource_name: `=`, `:` state: `=`, `:` - # category: `=`, `:` external_uri: `=`, `:` event_time: `=`, `>`, `<`, `>=`, `<=` - # Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: - # `event_time = "2019-06-10T16:07:18-07:00"` `event_time = 1560208038000` - # security_marks.marks: `=`, `:` source_properties: `=`, `:`, `>`, `<`, `>=`, `<= - # ` For example, `source_properties.size = 100` is a valid filter string. Use a - # partial match on the empty string to filter based on a property existing: ` - # source_properties.my_property : ""` Use a negated partial match on the empty - # string to filter based on a property not existing: `-source_properties. - # my_property : ""` - # @param [String] order_by - # Expression that defines what fields and order to use for sorting. The string - # value should follow SQL syntax: comma separated list of fields. For example: " - # name,resource_properties.a_property". The default sorting order is ascending. - # To specify descending order for a field, a suffix " desc" should be appended - # to the field name. For example: "name desc,source_properties.a_property". - # Redundant space characters in the syntax are insignificant. "name desc, - # source_properties.a_property" and " name desc , source_properties.a_property " - # are equivalent. The following fields are supported: name parent state category - # resource_name event_time source_properties security_marks.marks - # @param [Fixnum] page_size - # The maximum number of results to return in a single response. Default is 10, - # minimum is 1, maximum is 1000. - # @param [String] page_token - # The value returned by the last `ListFindingsResponse`; indicates that this is - # a continuation of a prior `ListFindings` call, and that the system should - # return the next page of data. - # @param [String] read_time - # Time used as a reference point when filtering findings. The filter is limited - # to findings existing at the supplied time and their values are those at that - # specific time. Absence of this field will default to the API's version of NOW. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::ListFindingsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::ListFindingsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_organization_source_findings(parent, compare_duration: nil, field_mask: nil, filter: nil, order_by: nil, page_size: nil, page_token: nil, read_time: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'v1p1beta1/{+parent}/findings', options) - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::ListFindingsResponse::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::ListFindingsResponse - command.params['parent'] = parent unless parent.nil? - command.query['compareDuration'] = compare_duration unless compare_duration.nil? - command.query['fieldMask'] = field_mask unless field_mask.nil? - command.query['filter'] = filter unless filter.nil? - command.query['orderBy'] = order_by unless order_by.nil? - command.query['pageSize'] = page_size unless page_size.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['readTime'] = read_time unless read_time.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates or updates a finding. The corresponding source must exist for a - # finding creation to succeed. - # @param [String] name - # The relative resource name of this finding. See: https://cloud.google.com/apis/ - # design/resource_names#relative_resource_name Example: "organizations/` - # organization_id`/sources/`source_id`/findings/`finding_id`" - # @param [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] google_cloud_securitycenter_v1p1beta1_finding_object - # @param [String] update_mask - # The FieldMask to use when updating the finding resource. This field should not - # be specified when creating a finding. When updating a finding, an empty mask - # is treated as updating all mutable fields and replacing source_properties. - # Individual source_properties can be added/updated by using "source_properties." - # in the field mask. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def patch_organization_source_finding(name, google_cloud_securitycenter_v1p1beta1_finding_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v1p1beta1/{+name}', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding::Representation - command.request_object = google_cloud_securitycenter_v1p1beta1_finding_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding - command.params['name'] = name unless name.nil? - command.query['updateMask'] = update_mask unless update_mask.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates the state of a finding. - # @param [String] name - # Required. The relative resource name of the finding. See: https://cloud.google. - # com/apis/design/resource_names#relative_resource_name Example: "organizations/` - # organization_id`/sources/`source_id`/finding/`finding_id`". - # @param [Google::Apis::SecuritycenterV1p1beta1::SetFindingStateRequest] set_finding_state_request_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def set_organization_source_finding_state(name, set_finding_state_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'v1p1beta1/{+name}:setState', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::SetFindingStateRequest::Representation - command.request_object = set_finding_state_request_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding - command.params['name'] = name unless name.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates security marks. - # @param [String] name - # The relative resource name of the SecurityMarks. See: https://cloud.google.com/ - # apis/design/resource_names#relative_resource_name Examples: "organizations/` - # organization_id`/assets/`asset_id`/securityMarks" "organizations/` - # organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks". - # @param [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] google_cloud_securitycenter_v1p1beta1_security_marks_object - # @param [String] start_time - # The time at which the updated SecurityMarks take effect. If not set uses - # current server time. Updates will be applied to the SecurityMarks that are - # active immediately preceding this time. - # @param [String] update_mask - # The FieldMask to use when updating the security marks resource. The field mask - # must not contain duplicate fields. If empty or set to "marks", all marks will - # be replaced. Individual marks can be updated using "marks.". - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_organization_source_finding_security_marks(name, google_cloud_securitycenter_v1p1beta1_security_marks_object = nil, start_time: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:patch, 'v1p1beta1/{+name}', options) - command.request_representation = Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation - command.request_object = google_cloud_securitycenter_v1p1beta1_security_marks_object - command.response_representation = Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks::Representation - command.response_class = Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks - command.params['name'] = name unless name.nil? - command.query['startTime'] = start_time unless start_time.nil? - command.query['updateMask'] = update_mask unless update_mask.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - end - end - end - end -end diff --git a/generated/google/apis/servicemanagement_v1.rb b/generated/google/apis/servicemanagement_v1.rb index f6416cfe6..effcfe4af 100644 --- a/generated/google/apis/servicemanagement_v1.rb +++ b/generated/google/apis/servicemanagement_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/service-management/ module ServicemanagementV1 VERSION = 'V1' - REVISION = '20200807' + REVISION = '20200824' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/servicemanagement_v1/classes.rb b/generated/google/apis/servicemanagement_v1/classes.rb index be7eedaea..c1b4d9f9d 100644 --- a/generated/google/apis/servicemanagement_v1/classes.rb +++ b/generated/google/apis/servicemanagement_v1/classes.rb @@ -2450,7 +2450,7 @@ module Google # AccessControl The mixin construct implies that all methods in `AccessControl` # are also declared with same name and request/response types in `Storage`. A # documentation generator or annotation processor will see the effective ` - # Storage.GetAcl` method after inherting documentation and annotations as + # Storage.GetAcl` method after inheriting documentation and annotations as # follows: service Storage ` // Get the underlying ACL object. rpc GetAcl( # GetAclRequest) returns (Acl) ` option (google.api.http).get = "/v2/`resource=** # `:getAcl"; ` ... ` Note how the version in the path pattern changed from `v1` diff --git a/generated/google/apis/tagmanager_v1.rb b/generated/google/apis/tagmanager_v1.rb deleted file mode 100644 index 4b93cb4b6..000000000 --- a/generated/google/apis/tagmanager_v1.rb +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'google/apis/tagmanager_v1/service.rb' -require 'google/apis/tagmanager_v1/classes.rb' -require 'google/apis/tagmanager_v1/representations.rb' - -module Google - module Apis - # Tag Manager API - # - # This API allows clients to access and modify container and tag configuration. - # - # @see https://developers.google.com/tag-manager - module TagmanagerV1 - VERSION = 'V1' - REVISION = '20200803' - - # Delete your Google Tag Manager containers - AUTH_TAGMANAGER_DELETE_CONTAINERS = 'https://www.googleapis.com/auth/tagmanager.delete.containers' - - # Manage your Google Tag Manager container and its subcomponents, excluding versioning and publishing - AUTH_TAGMANAGER_EDIT_CONTAINERS = 'https://www.googleapis.com/auth/tagmanager.edit.containers' - - # Manage your Google Tag Manager container versions - AUTH_TAGMANAGER_EDIT_CONTAINERVERSIONS = 'https://www.googleapis.com/auth/tagmanager.edit.containerversions' - - # View and manage your Google Tag Manager accounts - AUTH_TAGMANAGER_MANAGE_ACCOUNTS = 'https://www.googleapis.com/auth/tagmanager.manage.accounts' - - # Manage user permissions of your Google Tag Manager account and container - AUTH_TAGMANAGER_MANAGE_USERS = 'https://www.googleapis.com/auth/tagmanager.manage.users' - - # Publish your Google Tag Manager container versions - AUTH_TAGMANAGER_PUBLISH = 'https://www.googleapis.com/auth/tagmanager.publish' - - # View your Google Tag Manager container and its subcomponents - AUTH_TAGMANAGER_READONLY = 'https://www.googleapis.com/auth/tagmanager.readonly' - end - end -end diff --git a/generated/google/apis/tagmanager_v1/classes.rb b/generated/google/apis/tagmanager_v1/classes.rb deleted file mode 100644 index 434491200..000000000 --- a/generated/google/apis/tagmanager_v1/classes.rb +++ /dev/null @@ -1,1663 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module TagmanagerV1 - - # Represents a Google Tag Manager Account. - class Account - include Google::Apis::Core::Hashable - - # The Account ID uniquely identifies the GTM Account. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # The fingerprint of the GTM Account as computed at storage time. This value is - # recomputed whenever the account is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # Account display name. @mutable tagmanager.accounts.create @mutable tagmanager. - # accounts.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Whether the account shares data anonymously with Google and others. @mutable - # tagmanager.accounts.create @mutable tagmanager.accounts.update - # Corresponds to the JSON property `shareData` - # @return [Boolean] - attr_accessor :share_data - alias_method :share_data?, :share_data - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @name = args[:name] if args.key?(:name) - @share_data = args[:share_data] if args.key?(:share_data) - end - end - - # Defines the Google Tag Manager Account access permissions. - class AccountAccess - include Google::Apis::Core::Hashable - - # List of Account permissions. Valid account permissions are read and manage. @ - # mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts. - # permissions.update - # Corresponds to the JSON property `permission` - # @return [Array] - attr_accessor :permission - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @permission = args[:permission] if args.key?(:permission) - end - end - - # Represents a predicate. - class Condition - include Google::Apis::Core::Hashable - - # A list of named parameters (key/value), depending on the condition's type. - # Notes: - For binary operators, include parameters named arg0 and arg1 for - # specifying the left and right operands, respectively. - At this time, the left - # operand (arg0) must be a reference to a variable. - For case-insensitive Regex - # matching, include a boolean parameter named ignore_case that is set to true. - # If not specified or set to any other value, the matching will be case - # sensitive. - To negate an operator, include a boolean parameter named negate - # boolean parameter that is set to true. @mutable tagmanager.accounts.containers. - # triggers.create @mutable tagmanager.accounts.containers.triggers.update - # Corresponds to the JSON property `parameter` - # @return [Array] - attr_accessor :parameter - - # The type of operator for this condition. @mutable tagmanager.accounts. - # containers.triggers.create @mutable tagmanager.accounts.containers.triggers. - # update - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @parameter = args[:parameter] if args.key?(:parameter) - @type = args[:type] if args.key?(:type) - end - end - - # Represents a Google Tag Manager Container. - class Container - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # The Container ID uniquely identifies the GTM Container. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # Optional list of domain names associated with the Container. @mutable - # tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers. - # update - # Corresponds to the JSON property `domainName` - # @return [Array] - attr_accessor :domain_name - - # List of enabled built-in variables. Valid values include: pageUrl, - # pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, - # clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, - # formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, - # oldHistoryFragment, newHistoryState, oldHistoryState, historySource, - # containerVersion, debugMode, randomNumber, containerId. @mutable tagmanager. - # accounts.containers.create @mutable tagmanager.accounts.containers.update - # Corresponds to the JSON property `enabledBuiltInVariable` - # @return [Array] - attr_accessor :enabled_built_in_variable - - # The fingerprint of the GTM Container as computed at storage time. This value - # is recomputed whenever the account is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # Container display name. @mutable tagmanager.accounts.containers.create @ - # mutable tagmanager.accounts.containers.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Container Notes. @mutable tagmanager.accounts.containers.create @mutable - # tagmanager.accounts.containers.update - # Corresponds to the JSON property `notes` - # @return [String] - attr_accessor :notes - - # Container Public ID. - # Corresponds to the JSON property `publicId` - # @return [String] - attr_accessor :public_id - - # Container Country ID. @mutable tagmanager.accounts.containers.create @mutable - # tagmanager.accounts.containers.update - # Corresponds to the JSON property `timeZoneCountryId` - # @return [String] - attr_accessor :time_zone_country_id - - # Container Time Zone ID. @mutable tagmanager.accounts.containers.create @ - # mutable tagmanager.accounts.containers.update - # Corresponds to the JSON property `timeZoneId` - # @return [String] - attr_accessor :time_zone_id - - # List of Usage Contexts for the Container. Valid values include: web, android, - # ios. @mutable tagmanager.accounts.containers.create @mutable tagmanager. - # accounts.containers.update - # Corresponds to the JSON property `usageContext` - # @return [Array] - attr_accessor :usage_context - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @container_id = args[:container_id] if args.key?(:container_id) - @domain_name = args[:domain_name] if args.key?(:domain_name) - @enabled_built_in_variable = args[:enabled_built_in_variable] if args.key?(:enabled_built_in_variable) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @name = args[:name] if args.key?(:name) - @notes = args[:notes] if args.key?(:notes) - @public_id = args[:public_id] if args.key?(:public_id) - @time_zone_country_id = args[:time_zone_country_id] if args.key?(:time_zone_country_id) - @time_zone_id = args[:time_zone_id] if args.key?(:time_zone_id) - @usage_context = args[:usage_context] if args.key?(:usage_context) - end - end - - # Defines the Google Tag Manager Container access permissions. - class ContainerAccess - include Google::Apis::Core::Hashable - - # GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable - # tagmanager.accounts.permissions.update - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # List of Container permissions. Valid container permissions are: read, edit, - # delete, publish. @mutable tagmanager.accounts.permissions.create @mutable - # tagmanager.accounts.permissions.update - # Corresponds to the JSON property `permission` - # @return [Array] - attr_accessor :permission - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @container_id = args[:container_id] if args.key?(:container_id) - @permission = args[:permission] if args.key?(:permission) - end - end - - # Represents a Google Tag Manager Container Version. - class ContainerVersion - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # Represents a Google Tag Manager Container. - # Corresponds to the JSON property `container` - # @return [Google::Apis::TagmanagerV1::Container] - attr_accessor :container - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # The Container Version ID uniquely identifies the GTM Container Version. - # Corresponds to the JSON property `containerVersionId` - # @return [String] - attr_accessor :container_version_id - - # A value of true indicates this container version has been deleted. - # Corresponds to the JSON property `deleted` - # @return [Boolean] - attr_accessor :deleted - alias_method :deleted?, :deleted - - # The fingerprint of the GTM Container Version as computed at storage time. This - # value is recomputed whenever the container version is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # The folders in the container that this version was taken from. - # Corresponds to the JSON property `folder` - # @return [Array] - attr_accessor :folder - - # The macros in the container that this version was taken from. - # Corresponds to the JSON property `macro` - # @return [Array] - attr_accessor :macro - - # Container version display name. @mutable tagmanager.accounts.containers. - # versions.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # User notes on how to apply this container version in the container. @mutable - # tagmanager.accounts.containers.versions.update - # Corresponds to the JSON property `notes` - # @return [String] - attr_accessor :notes - - # The rules in the container that this version was taken from. - # Corresponds to the JSON property `rule` - # @return [Array] - attr_accessor :rule - - # The tags in the container that this version was taken from. - # Corresponds to the JSON property `tag` - # @return [Array] - attr_accessor :tag - - # The triggers in the container that this version was taken from. - # Corresponds to the JSON property `trigger` - # @return [Array] - attr_accessor :trigger - - # The variables in the container that this version was taken from. - # Corresponds to the JSON property `variable` - # @return [Array] - attr_accessor :variable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @container = args[:container] if args.key?(:container) - @container_id = args[:container_id] if args.key?(:container_id) - @container_version_id = args[:container_version_id] if args.key?(:container_version_id) - @deleted = args[:deleted] if args.key?(:deleted) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @folder = args[:folder] if args.key?(:folder) - @macro = args[:macro] if args.key?(:macro) - @name = args[:name] if args.key?(:name) - @notes = args[:notes] if args.key?(:notes) - @rule = args[:rule] if args.key?(:rule) - @tag = args[:tag] if args.key?(:tag) - @trigger = args[:trigger] if args.key?(:trigger) - @variable = args[:variable] if args.key?(:variable) - end - end - - # Represents a Google Tag Manager Container Version Header. - class ContainerVersionHeader - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # The Container Version ID uniquely identifies the GTM Container Version. - # Corresponds to the JSON property `containerVersionId` - # @return [String] - attr_accessor :container_version_id - - # A value of true indicates this container version has been deleted. - # Corresponds to the JSON property `deleted` - # @return [Boolean] - attr_accessor :deleted - alias_method :deleted?, :deleted - - # Container version display name. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Number of macros in the container version. - # Corresponds to the JSON property `numMacros` - # @return [String] - attr_accessor :num_macros - - # Number of rules in the container version. - # Corresponds to the JSON property `numRules` - # @return [String] - attr_accessor :num_rules - - # Number of tags in the container version. - # Corresponds to the JSON property `numTags` - # @return [String] - attr_accessor :num_tags - - # Number of triggers in the container version. - # Corresponds to the JSON property `numTriggers` - # @return [String] - attr_accessor :num_triggers - - # Number of variables in the container version. - # Corresponds to the JSON property `numVariables` - # @return [String] - attr_accessor :num_variables - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @container_id = args[:container_id] if args.key?(:container_id) - @container_version_id = args[:container_version_id] if args.key?(:container_version_id) - @deleted = args[:deleted] if args.key?(:deleted) - @name = args[:name] if args.key?(:name) - @num_macros = args[:num_macros] if args.key?(:num_macros) - @num_rules = args[:num_rules] if args.key?(:num_rules) - @num_tags = args[:num_tags] if args.key?(:num_tags) - @num_triggers = args[:num_triggers] if args.key?(:num_triggers) - @num_variables = args[:num_variables] if args.key?(:num_variables) - end - end - - # Options for new container versions. - class CreateContainerVersionRequestVersionOptions - include Google::Apis::Core::Hashable - - # The name of the container version to be created. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The notes of the container version to be created. - # Corresponds to the JSON property `notes` - # @return [String] - attr_accessor :notes - - # The creation of this version may be for quick preview and shouldn't be saved. - # Corresponds to the JSON property `quickPreview` - # @return [Boolean] - attr_accessor :quick_preview - alias_method :quick_preview?, :quick_preview - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - @notes = args[:notes] if args.key?(:notes) - @quick_preview = args[:quick_preview] if args.key?(:quick_preview) - end - end - - # Create container versions response. - class CreateContainerVersionResponse - include Google::Apis::Core::Hashable - - # Compiler errors or not. - # Corresponds to the JSON property `compilerError` - # @return [Boolean] - attr_accessor :compiler_error - alias_method :compiler_error?, :compiler_error - - # Represents a Google Tag Manager Container Version. - # Corresponds to the JSON property `containerVersion` - # @return [Google::Apis::TagmanagerV1::ContainerVersion] - attr_accessor :container_version - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @compiler_error = args[:compiler_error] if args.key?(:compiler_error) - @container_version = args[:container_version] if args.key?(:container_version) - end - end - - # Represents a Google Tag Manager Environment. Note that a user can create, - # delete and update environments of type USER, but can only update the - # enable_debug and url fields of environments of other types. - class Environment - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # The environment authorization code. - # Corresponds to the JSON property `authorizationCode` - # @return [String] - attr_accessor :authorization_code - - # The last update time-stamp for the authorization code. - # Corresponds to the JSON property `authorizationTimestampMs` - # @return [Fixnum] - attr_accessor :authorization_timestamp_ms - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # - # Corresponds to the JSON property `containerVersionId` - # @return [String] - attr_accessor :container_version_id - - # The environment description. Can be set or changed only on USER type - # environments. @mutable tagmanager.accounts.containers.environments.create @ - # mutable tagmanager.accounts.containers.environments.update - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Whether or not to enable debug by default on for the environment. @mutable - # tagmanager.accounts.containers.environments.create @mutable tagmanager. - # accounts.containers.environments.update - # Corresponds to the JSON property `enableDebug` - # @return [Boolean] - attr_accessor :enable_debug - alias_method :enable_debug?, :enable_debug - - # GTM Environment ID uniquely identifies the GTM Environment. - # Corresponds to the JSON property `environmentId` - # @return [String] - attr_accessor :environment_id - - # The fingerprint of the GTM environment as computed at storage time. This value - # is recomputed whenever the environment is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # The environment display name. Can be set or changed only on USER type - # environments. @mutable tagmanager.accounts.containers.environments.create @ - # mutable tagmanager.accounts.containers.environments.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The type of this environment. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # Default preview page url for the environment. @mutable tagmanager.accounts. - # containers.environments.create @mutable tagmanager.accounts.containers. - # environments.update - # Corresponds to the JSON property `url` - # @return [String] - attr_accessor :url - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @authorization_code = args[:authorization_code] if args.key?(:authorization_code) - @authorization_timestamp_ms = args[:authorization_timestamp_ms] if args.key?(:authorization_timestamp_ms) - @container_id = args[:container_id] if args.key?(:container_id) - @container_version_id = args[:container_version_id] if args.key?(:container_version_id) - @description = args[:description] if args.key?(:description) - @enable_debug = args[:enable_debug] if args.key?(:enable_debug) - @environment_id = args[:environment_id] if args.key?(:environment_id) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @name = args[:name] if args.key?(:name) - @type = args[:type] if args.key?(:type) - @url = args[:url] if args.key?(:url) - end - end - - # Represents a Google Tag Manager Folder. - class Folder - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # The fingerprint of the GTM Folder as computed at storage time. This value is - # recomputed whenever the folder is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # The Folder ID uniquely identifies the GTM Folder. - # Corresponds to the JSON property `folderId` - # @return [String] - attr_accessor :folder_id - - # Folder display name. @mutable tagmanager.accounts.containers.folders.create @ - # mutable tagmanager.accounts.containers.folders.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @container_id = args[:container_id] if args.key?(:container_id) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @folder_id = args[:folder_id] if args.key?(:folder_id) - @name = args[:name] if args.key?(:name) - end - end - - # Represents a Google Tag Manager Folder's contents. - class FolderEntities - include Google::Apis::Core::Hashable - - # The list of tags inside the folder. - # Corresponds to the JSON property `tag` - # @return [Array] - attr_accessor :tag - - # The list of triggers inside the folder. - # Corresponds to the JSON property `trigger` - # @return [Array] - attr_accessor :trigger - - # The list of variables inside the folder. - # Corresponds to the JSON property `variable` - # @return [Array] - attr_accessor :variable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @tag = args[:tag] if args.key?(:tag) - @trigger = args[:trigger] if args.key?(:trigger) - @variable = args[:variable] if args.key?(:variable) - end - end - - # List AccountUsers Response. - class ListAccountUsersResponse - include Google::Apis::Core::Hashable - - # All GTM AccountUsers of a GTM Account. - # Corresponds to the JSON property `userAccess` - # @return [Array] - attr_accessor :user_access - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @user_access = args[:user_access] if args.key?(:user_access) - end - end - - # List Accounts Response. - class ListAccountsResponse - include Google::Apis::Core::Hashable - - # List of GTM Accounts that a user has access to. - # Corresponds to the JSON property `accounts` - # @return [Array] - attr_accessor :accounts - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @accounts = args[:accounts] if args.key?(:accounts) - end - end - - # List container versions response. - class ListContainerVersionsResponse - include Google::Apis::Core::Hashable - - # All versions of a GTM Container. - # Corresponds to the JSON property `containerVersion` - # @return [Array] - attr_accessor :container_version - - # All container version headers of a GTM Container. - # Corresponds to the JSON property `containerVersionHeader` - # @return [Array] - attr_accessor :container_version_header - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @container_version = args[:container_version] if args.key?(:container_version) - @container_version_header = args[:container_version_header] if args.key?(:container_version_header) - end - end - - # List Containers Response. - class ListContainersResponse - include Google::Apis::Core::Hashable - - # All Containers of a GTM Account. - # Corresponds to the JSON property `containers` - # @return [Array] - attr_accessor :containers - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @containers = args[:containers] if args.key?(:containers) - end - end - - # List Environments Response. - class ListEnvironmentsResponse - include Google::Apis::Core::Hashable - - # All Environments of a GTM Container. - # Corresponds to the JSON property `environments` - # @return [Array] - attr_accessor :environments - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @environments = args[:environments] if args.key?(:environments) - end - end - - # List Folders Response. - class ListFoldersResponse - include Google::Apis::Core::Hashable - - # All GTM Folders of a GTM Container. - # Corresponds to the JSON property `folders` - # @return [Array] - attr_accessor :folders - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @folders = args[:folders] if args.key?(:folders) - end - end - - # List Tags Response. - class ListTagsResponse - include Google::Apis::Core::Hashable - - # All GTM Tags of a GTM Container. - # Corresponds to the JSON property `tags` - # @return [Array] - attr_accessor :tags - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @tags = args[:tags] if args.key?(:tags) - end - end - - # List triggers response. - class ListTriggersResponse - include Google::Apis::Core::Hashable - - # All GTM Triggers of a GTM Container. - # Corresponds to the JSON property `triggers` - # @return [Array] - attr_accessor :triggers - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @triggers = args[:triggers] if args.key?(:triggers) - end - end - - # List Variables Response. - class ListVariablesResponse - include Google::Apis::Core::Hashable - - # All GTM Variables of a GTM Container. - # Corresponds to the JSON property `variables` - # @return [Array] - attr_accessor :variables - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @variables = args[:variables] if args.key?(:variables) - end - end - - # Represents a Google Tag Manager Macro. - class Macro - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # For mobile containers only: A list of rule IDs for disabling conditional - # macros; the macro is enabled if one of the enabling rules is true while all - # the disabling rules are false. Treated as an unordered set. @mutable - # tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts. - # containers.macros.update - # Corresponds to the JSON property `disablingRuleId` - # @return [Array] - attr_accessor :disabling_rule_id - - # For mobile containers only: A list of rule IDs for enabling conditional macros; - # the macro is enabled if one of the enabling rules is true while all the - # disabling rules are false. Treated as an unordered set. @mutable tagmanager. - # accounts.containers.macros.create @mutable tagmanager.accounts.containers. - # macros.update - # Corresponds to the JSON property `enablingRuleId` - # @return [Array] - attr_accessor :enabling_rule_id - - # The fingerprint of the GTM Macro as computed at storage time. This value is - # recomputed whenever the macro is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # The Macro ID uniquely identifies the GTM Macro. - # Corresponds to the JSON property `macroId` - # @return [String] - attr_accessor :macro_id - - # Macro display name. @mutable tagmanager.accounts.containers.macros.create @ - # mutable tagmanager.accounts.containers.macros.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # User notes on how to apply this macro in the container. @mutable tagmanager. - # accounts.containers.macros.create @mutable tagmanager.accounts.containers. - # macros.update - # Corresponds to the JSON property `notes` - # @return [String] - attr_accessor :notes - - # The macro's parameters. @mutable tagmanager.accounts.containers.macros.create @ - # mutable tagmanager.accounts.containers.macros.update - # Corresponds to the JSON property `parameter` - # @return [Array] - attr_accessor :parameter - - # Parent folder id. - # Corresponds to the JSON property `parentFolderId` - # @return [String] - attr_accessor :parent_folder_id - - # The end timestamp in milliseconds to schedule a macro. @mutable tagmanager. - # accounts.containers.macros.create @mutable tagmanager.accounts.containers. - # macros.update - # Corresponds to the JSON property `scheduleEndMs` - # @return [Fixnum] - attr_accessor :schedule_end_ms - - # The start timestamp in milliseconds to schedule a macro. @mutable tagmanager. - # accounts.containers.macros.create @mutable tagmanager.accounts.containers. - # macros.update - # Corresponds to the JSON property `scheduleStartMs` - # @return [Fixnum] - attr_accessor :schedule_start_ms - - # GTM Macro Type. @mutable tagmanager.accounts.containers.macros.create @mutable - # tagmanager.accounts.containers.macros.update - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @container_id = args[:container_id] if args.key?(:container_id) - @disabling_rule_id = args[:disabling_rule_id] if args.key?(:disabling_rule_id) - @enabling_rule_id = args[:enabling_rule_id] if args.key?(:enabling_rule_id) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @macro_id = args[:macro_id] if args.key?(:macro_id) - @name = args[:name] if args.key?(:name) - @notes = args[:notes] if args.key?(:notes) - @parameter = args[:parameter] if args.key?(:parameter) - @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id) - @schedule_end_ms = args[:schedule_end_ms] if args.key?(:schedule_end_ms) - @schedule_start_ms = args[:schedule_start_ms] if args.key?(:schedule_start_ms) - @type = args[:type] if args.key?(:type) - end - end - - # Represents a Google Tag Manager Parameter. - class Parameter - include Google::Apis::Core::Hashable - - # The named key that uniquely identifies a parameter. Required for top-level - # parameters, as well as map values. Ignored for list values. @mutable - # tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts. - # containers.variables.update @mutable tagmanager.accounts.containers.triggers. - # create @mutable tagmanager.accounts.containers.triggers.update @mutable - # tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts. - # containers.tags.update - # Corresponds to the JSON property `key` - # @return [String] - attr_accessor :key - - # This list parameter's parameters (keys will be ignored). @mutable tagmanager. - # accounts.containers.variables.create @mutable tagmanager.accounts.containers. - # variables.update @mutable tagmanager.accounts.containers.triggers.create @ - # mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager. - # accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags. - # update - # Corresponds to the JSON property `list` - # @return [Array] - attr_accessor :list - - # This map parameter's parameters (must have keys; keys must be unique). @ - # mutable tagmanager.accounts.containers.variables.create @mutable tagmanager. - # accounts.containers.variables.update @mutable tagmanager.accounts.containers. - # triggers.create @mutable tagmanager.accounts.containers.triggers.update @ - # mutable tagmanager.accounts.containers.tags.create @mutable tagmanager. - # accounts.containers.tags.update - # Corresponds to the JSON property `map` - # @return [Array] - attr_accessor :map - - # The parameter type. Valid values are: - boolean: The value represents a - # boolean, represented as 'true' or 'false' - integer: The value represents a 64- - # bit signed integer value, in base 10 - list: A list of parameters should be - # specified - map: A map of parameters should be specified - template: The value - # represents any text; this can include variable references (even variable - # references that might return non-string types) - trigger_reference: The value - # represents a trigger, represented as the trigger id - tag_reference: The value - # represents a tag, represented as the tag name @mutable tagmanager.accounts. - # containers.variables.create @mutable tagmanager.accounts.containers.variables. - # update @mutable tagmanager.accounts.containers.triggers.create @mutable - # tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts. - # containers.tags.create @mutable tagmanager.accounts.containers.tags.update - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # A parameter's value (may contain variable references such as "``myVariable``") - # as appropriate to the specified type. @mutable tagmanager.accounts.containers. - # variables.create @mutable tagmanager.accounts.containers.variables.update @ - # mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager. - # accounts.containers.triggers.update @mutable tagmanager.accounts.containers. - # tags.create @mutable tagmanager.accounts.containers.tags.update - # Corresponds to the JSON property `value` - # @return [String] - attr_accessor :value - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @key = args[:key] if args.key?(:key) - @list = args[:list] if args.key?(:list) - @map = args[:map] if args.key?(:map) - @type = args[:type] if args.key?(:type) - @value = args[:value] if args.key?(:value) - end - end - - # Publish container version response. - class PublishContainerVersionResponse - include Google::Apis::Core::Hashable - - # Compiler errors or not. - # Corresponds to the JSON property `compilerError` - # @return [Boolean] - attr_accessor :compiler_error - alias_method :compiler_error?, :compiler_error - - # Represents a Google Tag Manager Container Version. - # Corresponds to the JSON property `containerVersion` - # @return [Google::Apis::TagmanagerV1::ContainerVersion] - attr_accessor :container_version - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @compiler_error = args[:compiler_error] if args.key?(:compiler_error) - @container_version = args[:container_version] if args.key?(:container_version) - end - end - - # Represents a Google Tag Manager Rule. - class Rule - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # The list of conditions that make up this rule (implicit AND between them). @ - # mutable tagmanager.accounts.containers.rules.create @mutable tagmanager. - # accounts.containers.rules.update - # Corresponds to the JSON property `condition` - # @return [Array] - attr_accessor :condition - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # The fingerprint of the GTM Rule as computed at storage time. This value is - # recomputed whenever the rule is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # Rule display name. @mutable tagmanager.accounts.containers.rules.create @ - # mutable tagmanager.accounts.containers.rules.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # User notes on how to apply this rule in the container. @mutable tagmanager. - # accounts.containers.rules.create @mutable tagmanager.accounts.containers.rules. - # update - # Corresponds to the JSON property `notes` - # @return [String] - attr_accessor :notes - - # The Rule ID uniquely identifies the GTM Rule. - # Corresponds to the JSON property `ruleId` - # @return [String] - attr_accessor :rule_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @condition = args[:condition] if args.key?(:condition) - @container_id = args[:container_id] if args.key?(:container_id) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @name = args[:name] if args.key?(:name) - @notes = args[:notes] if args.key?(:notes) - @rule_id = args[:rule_id] if args.key?(:rule_id) - end - end - - # - class SetupTag - include Google::Apis::Core::Hashable - - # If true, fire the main tag if and only if the setup tag fires successfully. If - # false, fire the main tag regardless of setup tag firing status. - # Corresponds to the JSON property `stopOnSetupFailure` - # @return [Boolean] - attr_accessor :stop_on_setup_failure - alias_method :stop_on_setup_failure?, :stop_on_setup_failure - - # The name of the setup tag. - # Corresponds to the JSON property `tagName` - # @return [String] - attr_accessor :tag_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @stop_on_setup_failure = args[:stop_on_setup_failure] if args.key?(:stop_on_setup_failure) - @tag_name = args[:tag_name] if args.key?(:tag_name) - end - end - - # Represents a Google Tag Manager Tag. - class Tag - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will - # not fire. @mutable tagmanager.accounts.containers.tags.create @mutable - # tagmanager.accounts.containers.tags.update - # Corresponds to the JSON property `blockingRuleId` - # @return [Array] - attr_accessor :blocking_rule_id - - # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag - # will not fire. @mutable tagmanager.accounts.containers.tags.create @mutable - # tagmanager.accounts.containers.tags.update - # Corresponds to the JSON property `blockingTriggerId` - # @return [Array] - attr_accessor :blocking_trigger_id - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # The fingerprint of the GTM Tag as computed at storage time. This value is - # recomputed whenever the tag is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # Firing rule IDs. A tag will fire when any of the listed rules are true and all - # of its blockingRuleIds (if any specified) are false. @mutable tagmanager. - # accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags. - # update - # Corresponds to the JSON property `firingRuleId` - # @return [Array] - attr_accessor :firing_rule_id - - # Firing trigger IDs. A tag will fire when any of the listed triggers are true - # and all of its blockingTriggerIds (if any specified) are false. @mutable - # tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts. - # containers.tags.update - # Corresponds to the JSON property `firingTriggerId` - # @return [Array] - attr_accessor :firing_trigger_id - - # If set to true, this tag will only fire in the live environment (e.g. not in - # preview or debug mode). @mutable tagmanager.accounts.containers.tags.create @ - # mutable tagmanager.accounts.containers.tags.update - # Corresponds to the JSON property `liveOnly` - # @return [Boolean] - attr_accessor :live_only - alias_method :live_only?, :live_only - - # Tag display name. @mutable tagmanager.accounts.containers.tags.create @mutable - # tagmanager.accounts.containers.tags.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # User notes on how to apply this tag in the container. @mutable tagmanager. - # accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags. - # update - # Corresponds to the JSON property `notes` - # @return [String] - attr_accessor :notes - - # The tag's parameters. @mutable tagmanager.accounts.containers.tags.create @ - # mutable tagmanager.accounts.containers.tags.update - # Corresponds to the JSON property `parameter` - # @return [Array] - attr_accessor :parameter - - # Parent folder id. - # Corresponds to the JSON property `parentFolderId` - # @return [String] - attr_accessor :parent_folder_id - - # True if the tag is paused. @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update - # Corresponds to the JSON property `paused` - # @return [Boolean] - attr_accessor :paused - alias_method :paused?, :paused - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `priority` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :priority - - # The end timestamp in milliseconds to schedule a tag. @mutable tagmanager. - # accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags. - # update - # Corresponds to the JSON property `scheduleEndMs` - # @return [Fixnum] - attr_accessor :schedule_end_ms - - # The start timestamp in milliseconds to schedule a tag. @mutable tagmanager. - # accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags. - # update - # Corresponds to the JSON property `scheduleStartMs` - # @return [Fixnum] - attr_accessor :schedule_start_ms - - # The list of setup tags. Currently we only allow one. - # Corresponds to the JSON property `setupTag` - # @return [Array] - attr_accessor :setup_tag - - # Option to fire this tag. - # Corresponds to the JSON property `tagFiringOption` - # @return [String] - attr_accessor :tag_firing_option - - # The Tag ID uniquely identifies the GTM Tag. - # Corresponds to the JSON property `tagId` - # @return [String] - attr_accessor :tag_id - - # The list of teardown tags. Currently we only allow one. - # Corresponds to the JSON property `teardownTag` - # @return [Array] - attr_accessor :teardown_tag - - # GTM Tag Type. @mutable tagmanager.accounts.containers.tags.create @mutable - # tagmanager.accounts.containers.tags.update - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @blocking_rule_id = args[:blocking_rule_id] if args.key?(:blocking_rule_id) - @blocking_trigger_id = args[:blocking_trigger_id] if args.key?(:blocking_trigger_id) - @container_id = args[:container_id] if args.key?(:container_id) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @firing_rule_id = args[:firing_rule_id] if args.key?(:firing_rule_id) - @firing_trigger_id = args[:firing_trigger_id] if args.key?(:firing_trigger_id) - @live_only = args[:live_only] if args.key?(:live_only) - @name = args[:name] if args.key?(:name) - @notes = args[:notes] if args.key?(:notes) - @parameter = args[:parameter] if args.key?(:parameter) - @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id) - @paused = args[:paused] if args.key?(:paused) - @priority = args[:priority] if args.key?(:priority) - @schedule_end_ms = args[:schedule_end_ms] if args.key?(:schedule_end_ms) - @schedule_start_ms = args[:schedule_start_ms] if args.key?(:schedule_start_ms) - @setup_tag = args[:setup_tag] if args.key?(:setup_tag) - @tag_firing_option = args[:tag_firing_option] if args.key?(:tag_firing_option) - @tag_id = args[:tag_id] if args.key?(:tag_id) - @teardown_tag = args[:teardown_tag] if args.key?(:teardown_tag) - @type = args[:type] if args.key?(:type) - end - end - - # - class TeardownTag - include Google::Apis::Core::Hashable - - # If true, fire the teardown tag if and only if the main tag fires successfully. - # If false, fire the teardown tag regardless of main tag firing status. - # Corresponds to the JSON property `stopTeardownOnFailure` - # @return [Boolean] - attr_accessor :stop_teardown_on_failure - alias_method :stop_teardown_on_failure?, :stop_teardown_on_failure - - # The name of the teardown tag. - # Corresponds to the JSON property `tagName` - # @return [String] - attr_accessor :tag_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @stop_teardown_on_failure = args[:stop_teardown_on_failure] if args.key?(:stop_teardown_on_failure) - @tag_name = args[:tag_name] if args.key?(:tag_name) - end - end - - # Represents a Google Tag Manager Trigger - class Trigger - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # Used in the case of auto event tracking. @mutable tagmanager.accounts. - # containers.triggers.create @mutable tagmanager.accounts.containers.triggers. - # update - # Corresponds to the JSON property `autoEventFilter` - # @return [Array] - attr_accessor :auto_event_filter - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `checkValidation` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :check_validation - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `continuousTimeMinMilliseconds` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :continuous_time_min_milliseconds - - # Used in the case of custom event, which is fired iff all Conditions are true. @ - # mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager. - # accounts.containers.triggers.update - # Corresponds to the JSON property `customEventFilter` - # @return [Array] - attr_accessor :custom_event_filter - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `eventName` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :event_name - - # The trigger will only fire iff all Conditions are true. @mutable tagmanager. - # accounts.containers.triggers.create @mutable tagmanager.accounts.containers. - # triggers.update - # Corresponds to the JSON property `filter` - # @return [Array] - attr_accessor :filter - - # The fingerprint of the GTM Trigger as computed at storage time. This value is - # recomputed whenever the trigger is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `horizontalScrollPercentageList` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :horizontal_scroll_percentage_list - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `interval` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :interval - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `intervalSeconds` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :interval_seconds - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `limit` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :limit - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `maxTimerLengthSeconds` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :max_timer_length_seconds - - # Trigger display name. @mutable tagmanager.accounts.containers.triggers.create @ - # mutable tagmanager.accounts.containers.triggers.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Additional parameters. @mutable tagmanager.accounts.containers.workspaces. - # triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers. - # update - # Corresponds to the JSON property `parameter` - # @return [Array] - attr_accessor :parameter - - # Parent folder id. - # Corresponds to the JSON property `parentFolderId` - # @return [String] - attr_accessor :parent_folder_id - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `selector` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :selector - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `totalTimeMinMilliseconds` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :total_time_min_milliseconds - - # The Trigger ID uniquely identifies the GTM Trigger. - # Corresponds to the JSON property `triggerId` - # @return [String] - attr_accessor :trigger_id - - # Defines the data layer event that causes this trigger. @mutable tagmanager. - # accounts.containers.triggers.create @mutable tagmanager.accounts.containers. - # triggers.update - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `uniqueTriggerId` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :unique_trigger_id - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `verticalScrollPercentageList` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :vertical_scroll_percentage_list - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `visibilitySelector` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :visibility_selector - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `visiblePercentageMax` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :visible_percentage_max - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `visiblePercentageMin` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :visible_percentage_min - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `waitForTags` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :wait_for_tags - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `waitForTagsTimeout` - # @return [Google::Apis::TagmanagerV1::Parameter] - attr_accessor :wait_for_tags_timeout - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @auto_event_filter = args[:auto_event_filter] if args.key?(:auto_event_filter) - @check_validation = args[:check_validation] if args.key?(:check_validation) - @container_id = args[:container_id] if args.key?(:container_id) - @continuous_time_min_milliseconds = args[:continuous_time_min_milliseconds] if args.key?(:continuous_time_min_milliseconds) - @custom_event_filter = args[:custom_event_filter] if args.key?(:custom_event_filter) - @event_name = args[:event_name] if args.key?(:event_name) - @filter = args[:filter] if args.key?(:filter) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @horizontal_scroll_percentage_list = args[:horizontal_scroll_percentage_list] if args.key?(:horizontal_scroll_percentage_list) - @interval = args[:interval] if args.key?(:interval) - @interval_seconds = args[:interval_seconds] if args.key?(:interval_seconds) - @limit = args[:limit] if args.key?(:limit) - @max_timer_length_seconds = args[:max_timer_length_seconds] if args.key?(:max_timer_length_seconds) - @name = args[:name] if args.key?(:name) - @parameter = args[:parameter] if args.key?(:parameter) - @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id) - @selector = args[:selector] if args.key?(:selector) - @total_time_min_milliseconds = args[:total_time_min_milliseconds] if args.key?(:total_time_min_milliseconds) - @trigger_id = args[:trigger_id] if args.key?(:trigger_id) - @type = args[:type] if args.key?(:type) - @unique_trigger_id = args[:unique_trigger_id] if args.key?(:unique_trigger_id) - @vertical_scroll_percentage_list = args[:vertical_scroll_percentage_list] if args.key?(:vertical_scroll_percentage_list) - @visibility_selector = args[:visibility_selector] if args.key?(:visibility_selector) - @visible_percentage_max = args[:visible_percentage_max] if args.key?(:visible_percentage_max) - @visible_percentage_min = args[:visible_percentage_min] if args.key?(:visible_percentage_min) - @wait_for_tags = args[:wait_for_tags] if args.key?(:wait_for_tags) - @wait_for_tags_timeout = args[:wait_for_tags_timeout] if args.key?(:wait_for_tags_timeout) - end - end - - # Represents a user's permissions to an account and its container. - class UserAccess - include Google::Apis::Core::Hashable - - # Defines the Google Tag Manager Account access permissions. - # Corresponds to the JSON property `accountAccess` - # @return [Google::Apis::TagmanagerV1::AccountAccess] - attr_accessor :account_access - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # GTM Container access permissions. @mutable tagmanager.accounts.permissions. - # create @mutable tagmanager.accounts.permissions.update - # Corresponds to the JSON property `containerAccess` - # @return [Array] - attr_accessor :container_access - - # User's email address. @mutable tagmanager.accounts.permissions.create - # Corresponds to the JSON property `emailAddress` - # @return [String] - attr_accessor :email_address - - # Account Permission ID. - # Corresponds to the JSON property `permissionId` - # @return [String] - attr_accessor :permission_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_access = args[:account_access] if args.key?(:account_access) - @account_id = args[:account_id] if args.key?(:account_id) - @container_access = args[:container_access] if args.key?(:container_access) - @email_address = args[:email_address] if args.key?(:email_address) - @permission_id = args[:permission_id] if args.key?(:permission_id) - end - end - - # Represents a Google Tag Manager Variable. - class Variable - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # For mobile containers only: A list of trigger IDs for disabling conditional - # variables; the variable is enabled if one of the enabling trigger is true - # while all the disabling trigger are false. Treated as an unordered set. @ - # mutable tagmanager.accounts.containers.variables.create @mutable tagmanager. - # accounts.containers.variables.update - # Corresponds to the JSON property `disablingTriggerId` - # @return [Array] - attr_accessor :disabling_trigger_id - - # For mobile containers only: A list of trigger IDs for enabling conditional - # variables; the variable is enabled if one of the enabling triggers is true - # while all the disabling triggers are false. Treated as an unordered set. @ - # mutable tagmanager.accounts.containers.variables.create @mutable tagmanager. - # accounts.containers.variables.update - # Corresponds to the JSON property `enablingTriggerId` - # @return [Array] - attr_accessor :enabling_trigger_id - - # The fingerprint of the GTM Variable as computed at storage time. This value is - # recomputed whenever the variable is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # Variable display name. @mutable tagmanager.accounts.containers.variables. - # create @mutable tagmanager.accounts.containers.variables.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # User notes on how to apply this variable in the container. @mutable tagmanager. - # accounts.containers.variables.create @mutable tagmanager.accounts.containers. - # variables.update - # Corresponds to the JSON property `notes` - # @return [String] - attr_accessor :notes - - # The variable's parameters. @mutable tagmanager.accounts.containers.variables. - # create @mutable tagmanager.accounts.containers.variables.update - # Corresponds to the JSON property `parameter` - # @return [Array] - attr_accessor :parameter - - # Parent folder id. - # Corresponds to the JSON property `parentFolderId` - # @return [String] - attr_accessor :parent_folder_id - - # The end timestamp in milliseconds to schedule a variable. @mutable tagmanager. - # accounts.containers.variables.create @mutable tagmanager.accounts.containers. - # variables.update - # Corresponds to the JSON property `scheduleEndMs` - # @return [Fixnum] - attr_accessor :schedule_end_ms - - # The start timestamp in milliseconds to schedule a variable. @mutable - # tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts. - # containers.variables.update - # Corresponds to the JSON property `scheduleStartMs` - # @return [Fixnum] - attr_accessor :schedule_start_ms - - # GTM Variable Type. @mutable tagmanager.accounts.containers.variables.create @ - # mutable tagmanager.accounts.containers.variables.update - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # The Variable ID uniquely identifies the GTM Variable. - # Corresponds to the JSON property `variableId` - # @return [String] - attr_accessor :variable_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @container_id = args[:container_id] if args.key?(:container_id) - @disabling_trigger_id = args[:disabling_trigger_id] if args.key?(:disabling_trigger_id) - @enabling_trigger_id = args[:enabling_trigger_id] if args.key?(:enabling_trigger_id) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @name = args[:name] if args.key?(:name) - @notes = args[:notes] if args.key?(:notes) - @parameter = args[:parameter] if args.key?(:parameter) - @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id) - @schedule_end_ms = args[:schedule_end_ms] if args.key?(:schedule_end_ms) - @schedule_start_ms = args[:schedule_start_ms] if args.key?(:schedule_start_ms) - @type = args[:type] if args.key?(:type) - @variable_id = args[:variable_id] if args.key?(:variable_id) - end - end - end - end -end diff --git a/generated/google/apis/tagmanager_v1/representations.rb b/generated/google/apis/tagmanager_v1/representations.rb deleted file mode 100644 index ddb9637e3..000000000 --- a/generated/google/apis/tagmanager_v1/representations.rb +++ /dev/null @@ -1,630 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module TagmanagerV1 - - class Account - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AccountAccess - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Condition - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Container - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ContainerAccess - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ContainerVersion - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ContainerVersionHeader - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CreateContainerVersionRequestVersionOptions - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CreateContainerVersionResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Environment - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Folder - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class FolderEntities - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListAccountUsersResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListAccountsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListContainerVersionsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListContainersResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListEnvironmentsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListFoldersResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListTagsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListTriggersResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListVariablesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Macro - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Parameter - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PublishContainerVersionResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Rule - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SetupTag - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Tag - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TeardownTag - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Trigger - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UserAccess - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Variable - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Account - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :fingerprint, as: 'fingerprint' - property :name, as: 'name' - property :share_data, as: 'shareData' - end - end - - class AccountAccess - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :permission, as: 'permission' - end - end - - class Condition - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :type, as: 'type' - end - end - - class Container - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :container_id, as: 'containerId' - collection :domain_name, as: 'domainName' - collection :enabled_built_in_variable, as: 'enabledBuiltInVariable' - property :fingerprint, as: 'fingerprint' - property :name, as: 'name' - property :notes, as: 'notes' - property :public_id, as: 'publicId' - property :time_zone_country_id, as: 'timeZoneCountryId' - property :time_zone_id, as: 'timeZoneId' - collection :usage_context, as: 'usageContext' - end - end - - class ContainerAccess - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :container_id, as: 'containerId' - collection :permission, as: 'permission' - end - end - - class ContainerVersion - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :container, as: 'container', class: Google::Apis::TagmanagerV1::Container, decorator: Google::Apis::TagmanagerV1::Container::Representation - - property :container_id, as: 'containerId' - property :container_version_id, as: 'containerVersionId' - property :deleted, as: 'deleted' - property :fingerprint, as: 'fingerprint' - collection :folder, as: 'folder', class: Google::Apis::TagmanagerV1::Folder, decorator: Google::Apis::TagmanagerV1::Folder::Representation - - collection :macro, as: 'macro', class: Google::Apis::TagmanagerV1::Macro, decorator: Google::Apis::TagmanagerV1::Macro::Representation - - property :name, as: 'name' - property :notes, as: 'notes' - collection :rule, as: 'rule', class: Google::Apis::TagmanagerV1::Rule, decorator: Google::Apis::TagmanagerV1::Rule::Representation - - collection :tag, as: 'tag', class: Google::Apis::TagmanagerV1::Tag, decorator: Google::Apis::TagmanagerV1::Tag::Representation - - collection :trigger, as: 'trigger', class: Google::Apis::TagmanagerV1::Trigger, decorator: Google::Apis::TagmanagerV1::Trigger::Representation - - collection :variable, as: 'variable', class: Google::Apis::TagmanagerV1::Variable, decorator: Google::Apis::TagmanagerV1::Variable::Representation - - end - end - - class ContainerVersionHeader - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :container_id, as: 'containerId' - property :container_version_id, as: 'containerVersionId' - property :deleted, as: 'deleted' - property :name, as: 'name' - property :num_macros, as: 'numMacros' - property :num_rules, as: 'numRules' - property :num_tags, as: 'numTags' - property :num_triggers, as: 'numTriggers' - property :num_variables, as: 'numVariables' - end - end - - class CreateContainerVersionRequestVersionOptions - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - property :notes, as: 'notes' - property :quick_preview, as: 'quickPreview' - end - end - - class CreateContainerVersionResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :compiler_error, as: 'compilerError' - property :container_version, as: 'containerVersion', class: Google::Apis::TagmanagerV1::ContainerVersion, decorator: Google::Apis::TagmanagerV1::ContainerVersion::Representation - - end - end - - class Environment - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :authorization_code, as: 'authorizationCode' - property :authorization_timestamp_ms, :numeric_string => true, as: 'authorizationTimestampMs' - property :container_id, as: 'containerId' - property :container_version_id, as: 'containerVersionId' - property :description, as: 'description' - property :enable_debug, as: 'enableDebug' - property :environment_id, as: 'environmentId' - property :fingerprint, as: 'fingerprint' - property :name, as: 'name' - property :type, as: 'type' - property :url, as: 'url' - end - end - - class Folder - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :container_id, as: 'containerId' - property :fingerprint, as: 'fingerprint' - property :folder_id, as: 'folderId' - property :name, as: 'name' - end - end - - class FolderEntities - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :tag, as: 'tag', class: Google::Apis::TagmanagerV1::Tag, decorator: Google::Apis::TagmanagerV1::Tag::Representation - - collection :trigger, as: 'trigger', class: Google::Apis::TagmanagerV1::Trigger, decorator: Google::Apis::TagmanagerV1::Trigger::Representation - - collection :variable, as: 'variable', class: Google::Apis::TagmanagerV1::Variable, decorator: Google::Apis::TagmanagerV1::Variable::Representation - - end - end - - class ListAccountUsersResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :user_access, as: 'userAccess', class: Google::Apis::TagmanagerV1::UserAccess, decorator: Google::Apis::TagmanagerV1::UserAccess::Representation - - end - end - - class ListAccountsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :accounts, as: 'accounts', class: Google::Apis::TagmanagerV1::Account, decorator: Google::Apis::TagmanagerV1::Account::Representation - - end - end - - class ListContainerVersionsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :container_version, as: 'containerVersion', class: Google::Apis::TagmanagerV1::ContainerVersion, decorator: Google::Apis::TagmanagerV1::ContainerVersion::Representation - - collection :container_version_header, as: 'containerVersionHeader', class: Google::Apis::TagmanagerV1::ContainerVersionHeader, decorator: Google::Apis::TagmanagerV1::ContainerVersionHeader::Representation - - end - end - - class ListContainersResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :containers, as: 'containers', class: Google::Apis::TagmanagerV1::Container, decorator: Google::Apis::TagmanagerV1::Container::Representation - - end - end - - class ListEnvironmentsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :environments, as: 'environments', class: Google::Apis::TagmanagerV1::Environment, decorator: Google::Apis::TagmanagerV1::Environment::Representation - - end - end - - class ListFoldersResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :folders, as: 'folders', class: Google::Apis::TagmanagerV1::Folder, decorator: Google::Apis::TagmanagerV1::Folder::Representation - - end - end - - class ListTagsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :tags, as: 'tags', class: Google::Apis::TagmanagerV1::Tag, decorator: Google::Apis::TagmanagerV1::Tag::Representation - - end - end - - class ListTriggersResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :triggers, as: 'triggers', class: Google::Apis::TagmanagerV1::Trigger, decorator: Google::Apis::TagmanagerV1::Trigger::Representation - - end - end - - class ListVariablesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :variables, as: 'variables', class: Google::Apis::TagmanagerV1::Variable, decorator: Google::Apis::TagmanagerV1::Variable::Representation - - end - end - - class Macro - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :container_id, as: 'containerId' - collection :disabling_rule_id, as: 'disablingRuleId' - collection :enabling_rule_id, as: 'enablingRuleId' - property :fingerprint, as: 'fingerprint' - property :macro_id, as: 'macroId' - property :name, as: 'name' - property :notes, as: 'notes' - collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :parent_folder_id, as: 'parentFolderId' - property :schedule_end_ms, :numeric_string => true, as: 'scheduleEndMs' - property :schedule_start_ms, :numeric_string => true, as: 'scheduleStartMs' - property :type, as: 'type' - end - end - - class Parameter - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :key, as: 'key' - collection :list, as: 'list', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - collection :map, as: 'map', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :type, as: 'type' - property :value, as: 'value' - end - end - - class PublishContainerVersionResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :compiler_error, as: 'compilerError' - property :container_version, as: 'containerVersion', class: Google::Apis::TagmanagerV1::ContainerVersion, decorator: Google::Apis::TagmanagerV1::ContainerVersion::Representation - - end - end - - class Rule - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - collection :condition, as: 'condition', class: Google::Apis::TagmanagerV1::Condition, decorator: Google::Apis::TagmanagerV1::Condition::Representation - - property :container_id, as: 'containerId' - property :fingerprint, as: 'fingerprint' - property :name, as: 'name' - property :notes, as: 'notes' - property :rule_id, as: 'ruleId' - end - end - - class SetupTag - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :stop_on_setup_failure, as: 'stopOnSetupFailure' - property :tag_name, as: 'tagName' - end - end - - class Tag - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - collection :blocking_rule_id, as: 'blockingRuleId' - collection :blocking_trigger_id, as: 'blockingTriggerId' - property :container_id, as: 'containerId' - property :fingerprint, as: 'fingerprint' - collection :firing_rule_id, as: 'firingRuleId' - collection :firing_trigger_id, as: 'firingTriggerId' - property :live_only, as: 'liveOnly' - property :name, as: 'name' - property :notes, as: 'notes' - collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :parent_folder_id, as: 'parentFolderId' - property :paused, as: 'paused' - property :priority, as: 'priority', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :schedule_end_ms, :numeric_string => true, as: 'scheduleEndMs' - property :schedule_start_ms, :numeric_string => true, as: 'scheduleStartMs' - collection :setup_tag, as: 'setupTag', class: Google::Apis::TagmanagerV1::SetupTag, decorator: Google::Apis::TagmanagerV1::SetupTag::Representation - - property :tag_firing_option, as: 'tagFiringOption' - property :tag_id, as: 'tagId' - collection :teardown_tag, as: 'teardownTag', class: Google::Apis::TagmanagerV1::TeardownTag, decorator: Google::Apis::TagmanagerV1::TeardownTag::Representation - - property :type, as: 'type' - end - end - - class TeardownTag - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :stop_teardown_on_failure, as: 'stopTeardownOnFailure' - property :tag_name, as: 'tagName' - end - end - - class Trigger - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - collection :auto_event_filter, as: 'autoEventFilter', class: Google::Apis::TagmanagerV1::Condition, decorator: Google::Apis::TagmanagerV1::Condition::Representation - - property :check_validation, as: 'checkValidation', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :container_id, as: 'containerId' - property :continuous_time_min_milliseconds, as: 'continuousTimeMinMilliseconds', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - collection :custom_event_filter, as: 'customEventFilter', class: Google::Apis::TagmanagerV1::Condition, decorator: Google::Apis::TagmanagerV1::Condition::Representation - - property :event_name, as: 'eventName', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - collection :filter, as: 'filter', class: Google::Apis::TagmanagerV1::Condition, decorator: Google::Apis::TagmanagerV1::Condition::Representation - - property :fingerprint, as: 'fingerprint' - property :horizontal_scroll_percentage_list, as: 'horizontalScrollPercentageList', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :interval, as: 'interval', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :interval_seconds, as: 'intervalSeconds', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :limit, as: 'limit', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :max_timer_length_seconds, as: 'maxTimerLengthSeconds', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :name, as: 'name' - collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :parent_folder_id, as: 'parentFolderId' - property :selector, as: 'selector', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :total_time_min_milliseconds, as: 'totalTimeMinMilliseconds', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :trigger_id, as: 'triggerId' - property :type, as: 'type' - property :unique_trigger_id, as: 'uniqueTriggerId', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :vertical_scroll_percentage_list, as: 'verticalScrollPercentageList', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :visibility_selector, as: 'visibilitySelector', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :visible_percentage_max, as: 'visiblePercentageMax', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :visible_percentage_min, as: 'visiblePercentageMin', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :wait_for_tags, as: 'waitForTags', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :wait_for_tags_timeout, as: 'waitForTagsTimeout', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - end - end - - class UserAccess - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_access, as: 'accountAccess', class: Google::Apis::TagmanagerV1::AccountAccess, decorator: Google::Apis::TagmanagerV1::AccountAccess::Representation - - property :account_id, as: 'accountId' - collection :container_access, as: 'containerAccess', class: Google::Apis::TagmanagerV1::ContainerAccess, decorator: Google::Apis::TagmanagerV1::ContainerAccess::Representation - - property :email_address, as: 'emailAddress' - property :permission_id, as: 'permissionId' - end - end - - class Variable - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :container_id, as: 'containerId' - collection :disabling_trigger_id, as: 'disablingTriggerId' - collection :enabling_trigger_id, as: 'enablingTriggerId' - property :fingerprint, as: 'fingerprint' - property :name, as: 'name' - property :notes, as: 'notes' - collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV1::Parameter, decorator: Google::Apis::TagmanagerV1::Parameter::Representation - - property :parent_folder_id, as: 'parentFolderId' - property :schedule_end_ms, :numeric_string => true, as: 'scheduleEndMs' - property :schedule_start_ms, :numeric_string => true, as: 'scheduleStartMs' - property :type, as: 'type' - property :variable_id, as: 'variableId' - end - end - end - end -end diff --git a/generated/google/apis/tagmanager_v1/service.rb b/generated/google/apis/tagmanager_v1/service.rb deleted file mode 100644 index b6682aa36..000000000 --- a/generated/google/apis/tagmanager_v1/service.rb +++ /dev/null @@ -1,1820 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module TagmanagerV1 - # Tag Manager API - # - # This API allows clients to access and modify container and tag configuration. - # - # @example - # require 'google/apis/tagmanager_v1' - # - # Tagmanager = Google::Apis::TagmanagerV1 # Alias the module - # service = Tagmanager::TagManagerService.new - # - # @see https://developers.google.com/tag-manager - class TagManagerService < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - - # @return [String] - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - attr_accessor :quota_user - - def initialize - super('https://www.googleapis.com/', '') - @batch_path = 'batch/tagmanager/v1' - end - - # Gets a GTM Account. - # @param [String] account_id - # The GTM Account ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Account] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Account] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account(account_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}', options) - command.response_representation = Google::Apis::TagmanagerV1::Account::Representation - command.response_class = Google::Apis::TagmanagerV1::Account - command.params['accountId'] = account_id unless account_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all GTM Accounts that a user has access to. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::ListAccountsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::ListAccountsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_accounts(fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts', options) - command.response_representation = Google::Apis::TagmanagerV1::ListAccountsResponse::Representation - command.response_class = Google::Apis::TagmanagerV1::ListAccountsResponse - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a GTM Account. - # @param [String] account_id - # The GTM Account ID. - # @param [Google::Apis::TagmanagerV1::Account] account_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the account in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Account] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Account] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account(account_id, account_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v1/accounts/{accountId}', options) - command.request_representation = Google::Apis::TagmanagerV1::Account::Representation - command.request_object = account_object - command.response_representation = Google::Apis::TagmanagerV1::Account::Representation - command.response_class = Google::Apis::TagmanagerV1::Account - command.params['accountId'] = account_id unless account_id.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a Container. - # @param [String] account_id - # The GTM Account ID. - # @param [Google::Apis::TagmanagerV1::Container] container_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Container] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Container] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_container(account_id, container_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v1/accounts/{accountId}/containers', options) - command.request_representation = Google::Apis::TagmanagerV1::Container::Representation - command.request_object = container_object - command.response_representation = Google::Apis::TagmanagerV1::Container::Representation - command.response_class = Google::Apis::TagmanagerV1::Container - command.params['accountId'] = account_id unless account_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a Container. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_container(account_id, container_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}', options) - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a Container. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Container] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Container] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_container(account_id, container_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}', options) - command.response_representation = Google::Apis::TagmanagerV1::Container::Representation - command.response_class = Google::Apis::TagmanagerV1::Container - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all Containers that belongs to a GTM Account. - # @param [String] account_id - # The GTM Account ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::ListContainersResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::ListContainersResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_containers(account_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/containers', options) - command.response_representation = Google::Apis::TagmanagerV1::ListContainersResponse::Representation - command.response_class = Google::Apis::TagmanagerV1::ListContainersResponse - command.params['accountId'] = account_id unless account_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a Container. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [Google::Apis::TagmanagerV1::Container] container_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the container in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Container] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Container] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_container(account_id, container_id, container_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}', options) - command.request_representation = Google::Apis::TagmanagerV1::Container::Representation - command.request_object = container_object - command.response_representation = Google::Apis::TagmanagerV1::Container::Representation - command.response_class = Google::Apis::TagmanagerV1::Container - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a GTM Environment. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [Google::Apis::TagmanagerV1::Environment] environment_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Environment] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Environment] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_account_container_environment(account_id, container_id, environment_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments', options) - command.request_representation = Google::Apis::TagmanagerV1::Environment::Representation - command.request_object = environment_object - command.response_representation = Google::Apis::TagmanagerV1::Environment::Representation - command.response_class = Google::Apis::TagmanagerV1::Environment - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a GTM Environment. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] environment_id - # The GTM Environment ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_account_container_environment(account_id, container_id, environment_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments/{environmentId}', options) - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['environmentId'] = environment_id unless environment_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a GTM Environment. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] environment_id - # The GTM Environment ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Environment] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Environment] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_container_environment(account_id, container_id, environment_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments/{environmentId}', options) - command.response_representation = Google::Apis::TagmanagerV1::Environment::Representation - command.response_class = Google::Apis::TagmanagerV1::Environment - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['environmentId'] = environment_id unless environment_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all GTM Environments of a GTM Container. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::ListEnvironmentsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::ListEnvironmentsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_container_environments(account_id, container_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments', options) - command.response_representation = Google::Apis::TagmanagerV1::ListEnvironmentsResponse::Representation - command.response_class = Google::Apis::TagmanagerV1::ListEnvironmentsResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a GTM Environment. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] environment_id - # The GTM Environment ID. - # @param [Google::Apis::TagmanagerV1::Environment] environment_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the environment - # in storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Environment] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Environment] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account_container_environment(account_id, container_id, environment_id, environment_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/environments/{environmentId}', options) - command.request_representation = Google::Apis::TagmanagerV1::Environment::Representation - command.request_object = environment_object - command.response_representation = Google::Apis::TagmanagerV1::Environment::Representation - command.response_class = Google::Apis::TagmanagerV1::Environment - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['environmentId'] = environment_id unless environment_id.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a GTM Folder. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [Google::Apis::TagmanagerV1::Folder] folder_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Folder] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Folder] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_account_container_folder(account_id, container_id, folder_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders', options) - command.request_representation = Google::Apis::TagmanagerV1::Folder::Representation - command.request_object = folder_object - command.response_representation = Google::Apis::TagmanagerV1::Folder::Representation - command.response_class = Google::Apis::TagmanagerV1::Folder - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a GTM Folder. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] folder_id - # The GTM Folder ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_account_container_folder(account_id, container_id, folder_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}', options) - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['folderId'] = folder_id unless folder_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a GTM Folder. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] folder_id - # The GTM Folder ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Folder] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Folder] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_container_folder(account_id, container_id, folder_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}', options) - command.response_representation = Google::Apis::TagmanagerV1::Folder::Representation - command.response_class = Google::Apis::TagmanagerV1::Folder - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['folderId'] = folder_id unless folder_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all GTM Folders of a Container. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::ListFoldersResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::ListFoldersResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_container_folders(account_id, container_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders', options) - command.response_representation = Google::Apis::TagmanagerV1::ListFoldersResponse::Representation - command.response_class = Google::Apis::TagmanagerV1::ListFoldersResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a GTM Folder. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] folder_id - # The GTM Folder ID. - # @param [Google::Apis::TagmanagerV1::Folder] folder_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the folder in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Folder] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Folder] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account_container_folder(account_id, container_id, folder_id, folder_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}', options) - command.request_representation = Google::Apis::TagmanagerV1::Folder::Representation - command.request_object = folder_object - command.response_representation = Google::Apis::TagmanagerV1::Folder::Representation - command.response_class = Google::Apis::TagmanagerV1::Folder - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['folderId'] = folder_id unless folder_id.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # List all entities in a GTM Folder. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] folder_id - # The GTM Folder ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::FolderEntities] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::FolderEntities] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_container_folder_entities(account_id, container_id, folder_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/folders/{folderId}/entities', options) - command.response_representation = Google::Apis::TagmanagerV1::FolderEntities::Representation - command.response_class = Google::Apis::TagmanagerV1::FolderEntities - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['folderId'] = folder_id unless folder_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Moves entities to a GTM Folder. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] folder_id - # The GTM Folder ID. - # @param [Google::Apis::TagmanagerV1::Folder] folder_object - # @param [Array, String] tag_id - # The tags to be moved to the folder. - # @param [Array, String] trigger_id - # The triggers to be moved to the folder. - # @param [Array, String] variable_id - # The variables to be moved to the folder. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account_container_move_folder(account_id, container_id, folder_id, folder_object = nil, tag_id: nil, trigger_id: nil, variable_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/move_folders/{folderId}', options) - command.request_representation = Google::Apis::TagmanagerV1::Folder::Representation - command.request_object = folder_object - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['folderId'] = folder_id unless folder_id.nil? - command.query['tagId'] = tag_id unless tag_id.nil? - command.query['triggerId'] = trigger_id unless trigger_id.nil? - command.query['variableId'] = variable_id unless variable_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Re-generates the authorization code for a GTM Environment. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] environment_id - # The GTM Environment ID. - # @param [Google::Apis::TagmanagerV1::Environment] environment_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Environment] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Environment] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account_container_reauthorize_environment(account_id, container_id, environment_id, environment_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/reauthorize_environments/{environmentId}', options) - command.request_representation = Google::Apis::TagmanagerV1::Environment::Representation - command.request_object = environment_object - command.response_representation = Google::Apis::TagmanagerV1::Environment::Representation - command.response_class = Google::Apis::TagmanagerV1::Environment - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['environmentId'] = environment_id unless environment_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a GTM Tag. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [Google::Apis::TagmanagerV1::Tag] tag_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Tag] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Tag] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_tag(account_id, container_id, tag_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags', options) - command.request_representation = Google::Apis::TagmanagerV1::Tag::Representation - command.request_object = tag_object - command.response_representation = Google::Apis::TagmanagerV1::Tag::Representation - command.response_class = Google::Apis::TagmanagerV1::Tag - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a GTM Tag. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] tag_id - # The GTM Tag ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_tag(account_id, container_id, tag_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags/{tagId}', options) - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['tagId'] = tag_id unless tag_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a GTM Tag. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] tag_id - # The GTM Tag ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Tag] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Tag] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_tag(account_id, container_id, tag_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags/{tagId}', options) - command.response_representation = Google::Apis::TagmanagerV1::Tag::Representation - command.response_class = Google::Apis::TagmanagerV1::Tag - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['tagId'] = tag_id unless tag_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all GTM Tags of a Container. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::ListTagsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::ListTagsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_tags(account_id, container_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags', options) - command.response_representation = Google::Apis::TagmanagerV1::ListTagsResponse::Representation - command.response_class = Google::Apis::TagmanagerV1::ListTagsResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a GTM Tag. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] tag_id - # The GTM Tag ID. - # @param [Google::Apis::TagmanagerV1::Tag] tag_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the tag in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Tag] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Tag] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_tag(account_id, container_id, tag_id, tag_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/tags/{tagId}', options) - command.request_representation = Google::Apis::TagmanagerV1::Tag::Representation - command.request_object = tag_object - command.response_representation = Google::Apis::TagmanagerV1::Tag::Representation - command.response_class = Google::Apis::TagmanagerV1::Tag - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['tagId'] = tag_id unless tag_id.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a GTM Trigger. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [Google::Apis::TagmanagerV1::Trigger] trigger_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Trigger] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Trigger] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_trigger(account_id, container_id, trigger_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers', options) - command.request_representation = Google::Apis::TagmanagerV1::Trigger::Representation - command.request_object = trigger_object - command.response_representation = Google::Apis::TagmanagerV1::Trigger::Representation - command.response_class = Google::Apis::TagmanagerV1::Trigger - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a GTM Trigger. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] trigger_id - # The GTM Trigger ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_trigger(account_id, container_id, trigger_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}', options) - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['triggerId'] = trigger_id unless trigger_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a GTM Trigger. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] trigger_id - # The GTM Trigger ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Trigger] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Trigger] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_trigger(account_id, container_id, trigger_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}', options) - command.response_representation = Google::Apis::TagmanagerV1::Trigger::Representation - command.response_class = Google::Apis::TagmanagerV1::Trigger - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['triggerId'] = trigger_id unless trigger_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all GTM Triggers of a Container. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::ListTriggersResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::ListTriggersResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_triggers(account_id, container_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers', options) - command.response_representation = Google::Apis::TagmanagerV1::ListTriggersResponse::Representation - command.response_class = Google::Apis::TagmanagerV1::ListTriggersResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a GTM Trigger. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] trigger_id - # The GTM Trigger ID. - # @param [Google::Apis::TagmanagerV1::Trigger] trigger_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the trigger in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Trigger] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Trigger] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_trigger(account_id, container_id, trigger_id, trigger_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/triggers/{triggerId}', options) - command.request_representation = Google::Apis::TagmanagerV1::Trigger::Representation - command.request_object = trigger_object - command.response_representation = Google::Apis::TagmanagerV1::Trigger::Representation - command.response_class = Google::Apis::TagmanagerV1::Trigger - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['triggerId'] = trigger_id unless trigger_id.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a GTM Variable. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [Google::Apis::TagmanagerV1::Variable] variable_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Variable] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Variable] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_variable(account_id, container_id, variable_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables', options) - command.request_representation = Google::Apis::TagmanagerV1::Variable::Representation - command.request_object = variable_object - command.response_representation = Google::Apis::TagmanagerV1::Variable::Representation - command.response_class = Google::Apis::TagmanagerV1::Variable - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a GTM Variable. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] variable_id - # The GTM Variable ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_variable(account_id, container_id, variable_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables/{variableId}', options) - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['variableId'] = variable_id unless variable_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a GTM Variable. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] variable_id - # The GTM Variable ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Variable] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Variable] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_variable(account_id, container_id, variable_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables/{variableId}', options) - command.response_representation = Google::Apis::TagmanagerV1::Variable::Representation - command.response_class = Google::Apis::TagmanagerV1::Variable - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['variableId'] = variable_id unless variable_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all GTM Variables of a Container. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::ListVariablesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::ListVariablesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_variables(account_id, container_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables', options) - command.response_representation = Google::Apis::TagmanagerV1::ListVariablesResponse::Representation - command.response_class = Google::Apis::TagmanagerV1::ListVariablesResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a GTM Variable. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] variable_id - # The GTM Variable ID. - # @param [Google::Apis::TagmanagerV1::Variable] variable_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the variable in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::Variable] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::Variable] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_variable(account_id, container_id, variable_id, variable_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/variables/{variableId}', options) - command.request_representation = Google::Apis::TagmanagerV1::Variable::Representation - command.request_object = variable_object - command.response_representation = Google::Apis::TagmanagerV1::Variable::Representation - command.response_class = Google::Apis::TagmanagerV1::Variable - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['variableId'] = variable_id unless variable_id.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a Container Version. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [Google::Apis::TagmanagerV1::CreateContainerVersionRequestVersionOptions] create_container_version_request_version_options_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::CreateContainerVersionResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::CreateContainerVersionResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_version(account_id, container_id, create_container_version_request_version_options_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions', options) - command.request_representation = Google::Apis::TagmanagerV1::CreateContainerVersionRequestVersionOptions::Representation - command.request_object = create_container_version_request_version_options_object - command.response_representation = Google::Apis::TagmanagerV1::CreateContainerVersionResponse::Representation - command.response_class = Google::Apis::TagmanagerV1::CreateContainerVersionResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a Container Version. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] container_version_id - # The GTM Container Version ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_version(account_id, container_id, container_version_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}', options) - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['containerVersionId'] = container_version_id unless container_version_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a Container Version. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] container_version_id - # The GTM Container Version ID. Specify published to retrieve the currently - # published version. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::ContainerVersion] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::ContainerVersion] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_version(account_id, container_id, container_version_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}', options) - command.response_representation = Google::Apis::TagmanagerV1::ContainerVersion::Representation - command.response_class = Google::Apis::TagmanagerV1::ContainerVersion - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['containerVersionId'] = container_version_id unless container_version_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all Container Versions of a GTM Container. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [Boolean] headers - # Retrieve headers only when true. - # @param [Boolean] include_deleted - # Also retrieve deleted (archived) versions when true. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::ListContainerVersionsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::ListContainerVersionsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_versions(account_id, container_id, headers: nil, include_deleted: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions', options) - command.response_representation = Google::Apis::TagmanagerV1::ListContainerVersionsResponse::Representation - command.response_class = Google::Apis::TagmanagerV1::ListContainerVersionsResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.query['headers'] = headers unless headers.nil? - command.query['includeDeleted'] = include_deleted unless include_deleted.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Publishes a Container Version. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] container_version_id - # The GTM Container Version ID. - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the container - # version in storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::PublishContainerVersionResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::PublishContainerVersionResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def publish_version(account_id, container_id, container_version_id, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/publish', options) - command.response_representation = Google::Apis::TagmanagerV1::PublishContainerVersionResponse::Representation - command.response_class = Google::Apis::TagmanagerV1::PublishContainerVersionResponse - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['containerVersionId'] = container_version_id unless container_version_id.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Restores a Container Version. This will overwrite the container's current - # configuration (including its variables, triggers and tags). The operation will - # not have any effect on the version that is being served (i.e. the published - # version). - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] container_version_id - # The GTM Container Version ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::ContainerVersion] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::ContainerVersion] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def restore_version(account_id, container_id, container_version_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/restore', options) - command.response_representation = Google::Apis::TagmanagerV1::ContainerVersion::Representation - command.response_class = Google::Apis::TagmanagerV1::ContainerVersion - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['containerVersionId'] = container_version_id unless container_version_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Undeletes a Container Version. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] container_version_id - # The GTM Container Version ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::ContainerVersion] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::ContainerVersion] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def undelete_version(account_id, container_id, container_version_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}/undelete', options) - command.response_representation = Google::Apis::TagmanagerV1::ContainerVersion::Representation - command.response_class = Google::Apis::TagmanagerV1::ContainerVersion - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['containerVersionId'] = container_version_id unless container_version_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a Container Version. - # @param [String] account_id - # The GTM Account ID. - # @param [String] container_id - # The GTM Container ID. - # @param [String] container_version_id - # The GTM Container Version ID. - # @param [Google::Apis::TagmanagerV1::ContainerVersion] container_version_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the container - # version in storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::ContainerVersion] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::ContainerVersion] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_version(account_id, container_id, container_version_id, container_version_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v1/accounts/{accountId}/containers/{containerId}/versions/{containerVersionId}', options) - command.request_representation = Google::Apis::TagmanagerV1::ContainerVersion::Representation - command.request_object = container_version_object - command.response_representation = Google::Apis::TagmanagerV1::ContainerVersion::Representation - command.response_class = Google::Apis::TagmanagerV1::ContainerVersion - command.params['accountId'] = account_id unless account_id.nil? - command.params['containerId'] = container_id unless container_id.nil? - command.params['containerVersionId'] = container_version_id unless container_version_id.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a user's Account & Container Permissions. - # @param [String] account_id - # The GTM Account ID. - # @param [Google::Apis::TagmanagerV1::UserAccess] user_access_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::UserAccess] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::UserAccess] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_permission(account_id, user_access_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v1/accounts/{accountId}/permissions', options) - command.request_representation = Google::Apis::TagmanagerV1::UserAccess::Representation - command.request_object = user_access_object - command.response_representation = Google::Apis::TagmanagerV1::UserAccess::Representation - command.response_class = Google::Apis::TagmanagerV1::UserAccess - command.params['accountId'] = account_id unless account_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Removes a user from the account, revoking access to it and all of its - # containers. - # @param [String] account_id - # The GTM Account ID. - # @param [String] permission_id - # The GTM User ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_permission(account_id, permission_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v1/accounts/{accountId}/permissions/{permissionId}', options) - command.params['accountId'] = account_id unless account_id.nil? - command.params['permissionId'] = permission_id unless permission_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a user's Account & Container Permissions. - # @param [String] account_id - # The GTM Account ID. - # @param [String] permission_id - # The GTM User ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::UserAccess] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::UserAccess] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_permission(account_id, permission_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/permissions/{permissionId}', options) - command.response_representation = Google::Apis::TagmanagerV1::UserAccess::Representation - command.response_class = Google::Apis::TagmanagerV1::UserAccess - command.params['accountId'] = account_id unless account_id.nil? - command.params['permissionId'] = permission_id unless permission_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # List all users that have access to the account along with Account and - # Container Permissions granted to each of them. - # @param [String] account_id - # The GTM Account ID. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::ListAccountUsersResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::ListAccountUsersResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_permissions(account_id, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v1/accounts/{accountId}/permissions', options) - command.response_representation = Google::Apis::TagmanagerV1::ListAccountUsersResponse::Representation - command.response_class = Google::Apis::TagmanagerV1::ListAccountUsersResponse - command.params['accountId'] = account_id unless account_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a user's Account & Container Permissions. - # @param [String] account_id - # The GTM Account ID. - # @param [String] permission_id - # The GTM User ID. - # @param [Google::Apis::TagmanagerV1::UserAccess] user_access_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV1::UserAccess] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV1::UserAccess] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_permission(account_id, permission_id, user_access_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v1/accounts/{accountId}/permissions/{permissionId}', options) - command.request_representation = Google::Apis::TagmanagerV1::UserAccess::Representation - command.request_object = user_access_object - command.response_representation = Google::Apis::TagmanagerV1::UserAccess::Representation - command.response_class = Google::Apis::TagmanagerV1::UserAccess - command.params['accountId'] = account_id unless account_id.nil? - command.params['permissionId'] = permission_id unless permission_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - end - end - end - end -end diff --git a/generated/google/apis/tagmanager_v2.rb b/generated/google/apis/tagmanager_v2.rb deleted file mode 100644 index 2ee8544f1..000000000 --- a/generated/google/apis/tagmanager_v2.rb +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'google/apis/tagmanager_v2/service.rb' -require 'google/apis/tagmanager_v2/classes.rb' -require 'google/apis/tagmanager_v2/representations.rb' - -module Google - module Apis - # Tag Manager API - # - # This API allows clients to access and modify container and tag configuration. - # - # @see https://developers.google.com/tag-manager - module TagmanagerV2 - VERSION = 'V2' - REVISION = '20200803' - - # Delete your Google Tag Manager containers - AUTH_TAGMANAGER_DELETE_CONTAINERS = 'https://www.googleapis.com/auth/tagmanager.delete.containers' - - # Manage your Google Tag Manager container and its subcomponents, excluding versioning and publishing - AUTH_TAGMANAGER_EDIT_CONTAINERS = 'https://www.googleapis.com/auth/tagmanager.edit.containers' - - # Manage your Google Tag Manager container versions - AUTH_TAGMANAGER_EDIT_CONTAINERVERSIONS = 'https://www.googleapis.com/auth/tagmanager.edit.containerversions' - - # View and manage your Google Tag Manager accounts - AUTH_TAGMANAGER_MANAGE_ACCOUNTS = 'https://www.googleapis.com/auth/tagmanager.manage.accounts' - - # Manage user permissions of your Google Tag Manager account and container - AUTH_TAGMANAGER_MANAGE_USERS = 'https://www.googleapis.com/auth/tagmanager.manage.users' - - # Publish your Google Tag Manager container versions - AUTH_TAGMANAGER_PUBLISH = 'https://www.googleapis.com/auth/tagmanager.publish' - - # View your Google Tag Manager container and its subcomponents - AUTH_TAGMANAGER_READONLY = 'https://www.googleapis.com/auth/tagmanager.readonly' - end - end -end diff --git a/generated/google/apis/tagmanager_v2/classes.rb b/generated/google/apis/tagmanager_v2/classes.rb deleted file mode 100644 index e85ca3d29..000000000 --- a/generated/google/apis/tagmanager_v2/classes.rb +++ /dev/null @@ -1,2717 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module TagmanagerV2 - - # Represents a Google Tag Manager Account. - class Account - include Google::Apis::Core::Hashable - - # The Account ID uniquely identifies the GTM Account. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # The fingerprint of the GTM Account as computed at storage time. This value is - # recomputed whenever the account is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # Account display name. @mutable tagmanager.accounts.create @mutable tagmanager. - # accounts.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # GTM Account's API relative path. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - # Whether the account shares data anonymously with Google and others. This flag - # enables benchmarking by sharing your data in an anonymous form. Google will - # remove all identifiable information about your website, combine the data with - # hundreds of other anonymous sites and report aggregate trends in the - # benchmarking service. @mutable tagmanager.accounts.create @mutable tagmanager. - # accounts.update - # Corresponds to the JSON property `shareData` - # @return [Boolean] - attr_accessor :share_data - alias_method :share_data?, :share_data - - # Auto generated link to the tag manager UI - # Corresponds to the JSON property `tagManagerUrl` - # @return [String] - attr_accessor :tag_manager_url - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @name = args[:name] if args.key?(:name) - @path = args[:path] if args.key?(:path) - @share_data = args[:share_data] if args.key?(:share_data) - @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url) - end - end - - # Defines the Google Tag Manager Account access permissions. - class AccountAccess - include Google::Apis::Core::Hashable - - # Whether the user has no access, user access, or admin access to an account. @ - # mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts. - # permissions.update - # Corresponds to the JSON property `permission` - # @return [String] - attr_accessor :permission - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @permission = args[:permission] if args.key?(:permission) - end - end - - # Built-in variables are a special category of variables that are pre-created - # and non-customizable. They provide common functionality like accessing - # propeties of the gtm data layer, monitoring clicks, or accessing elements of a - # page URL. - class BuiltInVariable - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # Name of the built-in variable to be used to refer to the built-in variable. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # GTM BuiltInVariable's API relative path. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - # Type of built-in variable. @required.tagmanager.accounts.containers.workspaces. - # built_in_variable.update @mutable tagmanager.accounts.containers.workspaces. - # built_in_variable.update - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # GTM Workspace ID. - # Corresponds to the JSON property `workspaceId` - # @return [String] - attr_accessor :workspace_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @container_id = args[:container_id] if args.key?(:container_id) - @name = args[:name] if args.key?(:name) - @path = args[:path] if args.key?(:path) - @type = args[:type] if args.key?(:type) - @workspace_id = args[:workspace_id] if args.key?(:workspace_id) - end - end - - # - class Client - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # The Client ID uniquely identifies the GTM client. - # Corresponds to the JSON property `clientId` - # @return [String] - attr_accessor :client_id - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # The fingerprint of the GTM Client as computed at storage time. This value is - # recomputed whenever the client is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # Client display name. @mutable tagmanager.accounts.containers.workspaces. - # clients.create @mutable tagmanager.accounts.containers.workspaces.clients. - # update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The client's parameters. @mutable tagmanager.accounts.containers.workspaces. - # clients.create @mutable tagmanager.accounts.containers.workspaces.clients. - # update - # Corresponds to the JSON property `parameter` - # @return [Array] - attr_accessor :parameter - - # Parent folder id. - # Corresponds to the JSON property `parentFolderId` - # @return [String] - attr_accessor :parent_folder_id - - # GTM client's API relative path. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - # Priority determines relative firing order. @mutable tagmanager.accounts. - # containers.workspaces.clients.create @mutable tagmanager.accounts.containers. - # workspaces.clients.update - # Corresponds to the JSON property `priority` - # @return [Fixnum] - attr_accessor :priority - - # Auto generated link to the tag manager UI - # Corresponds to the JSON property `tagManagerUrl` - # @return [String] - attr_accessor :tag_manager_url - - # Client type. @mutable tagmanager.accounts.containers.workspaces.clients.create - # @mutable tagmanager.accounts.containers.workspaces.clients.update - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # GTM Workspace ID. - # Corresponds to the JSON property `workspaceId` - # @return [String] - attr_accessor :workspace_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @client_id = args[:client_id] if args.key?(:client_id) - @container_id = args[:container_id] if args.key?(:container_id) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @name = args[:name] if args.key?(:name) - @parameter = args[:parameter] if args.key?(:parameter) - @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id) - @path = args[:path] if args.key?(:path) - @priority = args[:priority] if args.key?(:priority) - @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url) - @type = args[:type] if args.key?(:type) - @workspace_id = args[:workspace_id] if args.key?(:workspace_id) - end - end - - # Represents a predicate. - class Condition - include Google::Apis::Core::Hashable - - # A list of named parameters (key/value), depending on the condition's type. - # Notes: - For binary operators, include parameters named arg0 and arg1 for - # specifying the left and right operands, respectively. - At this time, the left - # operand (arg0) must be a reference to a variable. - For case-insensitive Regex - # matching, include a boolean parameter named ignore_case that is set to true. - # If not specified or set to any other value, the matching will be case - # sensitive. - To negate an operator, include a boolean parameter named negate - # boolean parameter that is set to true. @mutable tagmanager.accounts.containers. - # workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces. - # triggers.update - # Corresponds to the JSON property `parameter` - # @return [Array] - attr_accessor :parameter - - # The type of operator for this condition. @mutable tagmanager.accounts. - # containers.workspaces.triggers.create @mutable tagmanager.accounts.containers. - # workspaces.triggers.update - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @parameter = args[:parameter] if args.key?(:parameter) - @type = args[:type] if args.key?(:type) - end - end - - # Represents a Google Tag Manager Container, which specifies the platform tags - # will run on, manages workspaces, and retains container versions. - class Container - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # The Container ID uniquely identifies the GTM Container. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # List of domain names associated with the Container. @mutable tagmanager. - # accounts.containers.create @mutable tagmanager.accounts.containers.update - # Corresponds to the JSON property `domainName` - # @return [Array] - attr_accessor :domain_name - - # The fingerprint of the GTM Container as computed at storage time. This value - # is recomputed whenever the account is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # Container display name. @mutable tagmanager.accounts.containers.create @ - # mutable tagmanager.accounts.containers.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Container Notes. @mutable tagmanager.accounts.containers.create @mutable - # tagmanager.accounts.containers.update - # Corresponds to the JSON property `notes` - # @return [String] - attr_accessor :notes - - # GTM Container's API relative path. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - # Container Public ID. - # Corresponds to the JSON property `publicId` - # @return [String] - attr_accessor :public_id - - # Auto generated link to the tag manager UI - # Corresponds to the JSON property `tagManagerUrl` - # @return [String] - attr_accessor :tag_manager_url - - # List of Usage Contexts for the Container. Valid values include: web, android, - # or ios. @mutable tagmanager.accounts.containers.create @mutable tagmanager. - # accounts.containers.update - # Corresponds to the JSON property `usageContext` - # @return [Array] - attr_accessor :usage_context - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @container_id = args[:container_id] if args.key?(:container_id) - @domain_name = args[:domain_name] if args.key?(:domain_name) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @name = args[:name] if args.key?(:name) - @notes = args[:notes] if args.key?(:notes) - @path = args[:path] if args.key?(:path) - @public_id = args[:public_id] if args.key?(:public_id) - @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url) - @usage_context = args[:usage_context] if args.key?(:usage_context) - end - end - - # Defines the Google Tag Manager Container access permissions. - class ContainerAccess - include Google::Apis::Core::Hashable - - # GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable - # tagmanager.accounts.permissions.update - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # List of Container permissions. @mutable tagmanager.accounts.permissions.create - # @mutable tagmanager.accounts.permissions.update - # Corresponds to the JSON property `permission` - # @return [String] - attr_accessor :permission - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @container_id = args[:container_id] if args.key?(:container_id) - @permission = args[:permission] if args.key?(:permission) - end - end - - # Represents a Google Tag Manager Container Version. - class ContainerVersion - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # The built-in variables in the container that this version was taken from. - # Corresponds to the JSON property `builtInVariable` - # @return [Array] - attr_accessor :built_in_variable - - # The clients in the container that this version was taken from. - # Corresponds to the JSON property `client` - # @return [Array] - attr_accessor :client - - # Represents a Google Tag Manager Container, which specifies the platform tags - # will run on, manages workspaces, and retains container versions. - # Corresponds to the JSON property `container` - # @return [Google::Apis::TagmanagerV2::Container] - attr_accessor :container - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # The Container Version ID uniquely identifies the GTM Container Version. - # Corresponds to the JSON property `containerVersionId` - # @return [String] - attr_accessor :container_version_id - - # The custom templates in the container that this version was taken from. - # Corresponds to the JSON property `customTemplate` - # @return [Array] - attr_accessor :custom_template - - # A value of true indicates this container version has been deleted. - # Corresponds to the JSON property `deleted` - # @return [Boolean] - attr_accessor :deleted - alias_method :deleted?, :deleted - - # Container version description. @mutable tagmanager.accounts.containers. - # versions.update - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # The fingerprint of the GTM Container Version as computed at storage time. This - # value is recomputed whenever the container version is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # The folders in the container that this version was taken from. - # Corresponds to the JSON property `folder` - # @return [Array] - attr_accessor :folder - - # Container version display name. @mutable tagmanager.accounts.containers. - # versions.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # GTM ContainerVersions's API relative path. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - # The tags in the container that this version was taken from. - # Corresponds to the JSON property `tag` - # @return [Array] - attr_accessor :tag - - # Auto generated link to the tag manager UI - # Corresponds to the JSON property `tagManagerUrl` - # @return [String] - attr_accessor :tag_manager_url - - # The triggers in the container that this version was taken from. - # Corresponds to the JSON property `trigger` - # @return [Array] - attr_accessor :trigger - - # The variables in the container that this version was taken from. - # Corresponds to the JSON property `variable` - # @return [Array] - attr_accessor :variable - - # The zones in the container that this version was taken from. - # Corresponds to the JSON property `zone` - # @return [Array] - attr_accessor :zone - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @built_in_variable = args[:built_in_variable] if args.key?(:built_in_variable) - @client = args[:client] if args.key?(:client) - @container = args[:container] if args.key?(:container) - @container_id = args[:container_id] if args.key?(:container_id) - @container_version_id = args[:container_version_id] if args.key?(:container_version_id) - @custom_template = args[:custom_template] if args.key?(:custom_template) - @deleted = args[:deleted] if args.key?(:deleted) - @description = args[:description] if args.key?(:description) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @folder = args[:folder] if args.key?(:folder) - @name = args[:name] if args.key?(:name) - @path = args[:path] if args.key?(:path) - @tag = args[:tag] if args.key?(:tag) - @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url) - @trigger = args[:trigger] if args.key?(:trigger) - @variable = args[:variable] if args.key?(:variable) - @zone = args[:zone] if args.key?(:zone) - end - end - - # Represents a Google Tag Manager Container Version Header. - class ContainerVersionHeader - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # The Container Version ID uniquely identifies the GTM Container Version. - # Corresponds to the JSON property `containerVersionId` - # @return [String] - attr_accessor :container_version_id - - # A value of true indicates this container version has been deleted. - # Corresponds to the JSON property `deleted` - # @return [Boolean] - attr_accessor :deleted - alias_method :deleted?, :deleted - - # Container version display name. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # Number of custom templates in the container version. - # Corresponds to the JSON property `numCustomTemplates` - # @return [String] - attr_accessor :num_custom_templates - - # Number of macros in the container version. - # Corresponds to the JSON property `numMacros` - # @return [String] - attr_accessor :num_macros - - # Number of rules in the container version. - # Corresponds to the JSON property `numRules` - # @return [String] - attr_accessor :num_rules - - # Number of tags in the container version. - # Corresponds to the JSON property `numTags` - # @return [String] - attr_accessor :num_tags - - # Number of triggers in the container version. - # Corresponds to the JSON property `numTriggers` - # @return [String] - attr_accessor :num_triggers - - # Number of variables in the container version. - # Corresponds to the JSON property `numVariables` - # @return [String] - attr_accessor :num_variables - - # Number of zones in the container version. - # Corresponds to the JSON property `numZones` - # @return [String] - attr_accessor :num_zones - - # GTM Container Versions's API relative path. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @container_id = args[:container_id] if args.key?(:container_id) - @container_version_id = args[:container_version_id] if args.key?(:container_version_id) - @deleted = args[:deleted] if args.key?(:deleted) - @name = args[:name] if args.key?(:name) - @num_custom_templates = args[:num_custom_templates] if args.key?(:num_custom_templates) - @num_macros = args[:num_macros] if args.key?(:num_macros) - @num_rules = args[:num_rules] if args.key?(:num_rules) - @num_tags = args[:num_tags] if args.key?(:num_tags) - @num_triggers = args[:num_triggers] if args.key?(:num_triggers) - @num_variables = args[:num_variables] if args.key?(:num_variables) - @num_zones = args[:num_zones] if args.key?(:num_zones) - @path = args[:path] if args.key?(:path) - end - end - - # - class CreateBuiltInVariableResponse - include Google::Apis::Core::Hashable - - # List of created built-in variables. - # Corresponds to the JSON property `builtInVariable` - # @return [Array] - attr_accessor :built_in_variable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @built_in_variable = args[:built_in_variable] if args.key?(:built_in_variable) - end - end - - # Options for new container versions. - class CreateContainerVersionRequestVersionOptions - include Google::Apis::Core::Hashable - - # The name of the container version to be created. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # The notes of the container version to be created. - # Corresponds to the JSON property `notes` - # @return [String] - attr_accessor :notes - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @name = args[:name] if args.key?(:name) - @notes = args[:notes] if args.key?(:notes) - end - end - - # Create container versions response. - class CreateContainerVersionResponse - include Google::Apis::Core::Hashable - - # Compiler errors or not. - # Corresponds to the JSON property `compilerError` - # @return [Boolean] - attr_accessor :compiler_error - alias_method :compiler_error?, :compiler_error - - # Represents a Google Tag Manager Container Version. - # Corresponds to the JSON property `containerVersion` - # @return [Google::Apis::TagmanagerV2::ContainerVersion] - attr_accessor :container_version - - # Auto generated workspace path created as a result of version creation. This - # field should only be populated if the created version was not a quick preview. - # Corresponds to the JSON property `newWorkspacePath` - # @return [String] - attr_accessor :new_workspace_path - - # The status of a workspace after synchronization. - # Corresponds to the JSON property `syncStatus` - # @return [Google::Apis::TagmanagerV2::SyncStatus] - attr_accessor :sync_status - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @compiler_error = args[:compiler_error] if args.key?(:compiler_error) - @container_version = args[:container_version] if args.key?(:container_version) - @new_workspace_path = args[:new_workspace_path] if args.key?(:new_workspace_path) - @sync_status = args[:sync_status] if args.key?(:sync_status) - end - end - - # Represents a Google Tag Manager Custom Template's contents. - class CustomTemplate - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # The fingerprint of the GTM Custom Template as computed at storage time. This - # value is recomputed whenever the template is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # Represents the link between a custom template and an entry on the Community - # Template Gallery site. - # Corresponds to the JSON property `galleryReference` - # @return [Google::Apis::TagmanagerV2::GalleryReference] - attr_accessor :gallery_reference - - # Custom Template display name. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # GTM Custom Template's API relative path. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - # Auto generated link to the tag manager UI - # Corresponds to the JSON property `tagManagerUrl` - # @return [String] - attr_accessor :tag_manager_url - - # The custom template in text format. - # Corresponds to the JSON property `templateData` - # @return [String] - attr_accessor :template_data - - # The Custom Template ID uniquely identifies the GTM custom template. - # Corresponds to the JSON property `templateId` - # @return [String] - attr_accessor :template_id - - # GTM Workspace ID. - # Corresponds to the JSON property `workspaceId` - # @return [String] - attr_accessor :workspace_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @container_id = args[:container_id] if args.key?(:container_id) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @gallery_reference = args[:gallery_reference] if args.key?(:gallery_reference) - @name = args[:name] if args.key?(:name) - @path = args[:path] if args.key?(:path) - @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url) - @template_data = args[:template_data] if args.key?(:template_data) - @template_id = args[:template_id] if args.key?(:template_id) - @workspace_id = args[:workspace_id] if args.key?(:workspace_id) - end - end - - # A workspace entity that may represent a tag, trigger, variable, or folder in - # addition to its status in the workspace. - class Entity - include Google::Apis::Core::Hashable - - # Represents how the entity has been changed in the workspace. - # Corresponds to the JSON property `changeStatus` - # @return [String] - attr_accessor :change_status - - # Represents a Google Tag Manager Folder. - # Corresponds to the JSON property `folder` - # @return [Google::Apis::TagmanagerV2::Folder] - attr_accessor :folder - - # Represents a Google Tag Manager Tag. - # Corresponds to the JSON property `tag` - # @return [Google::Apis::TagmanagerV2::Tag] - attr_accessor :tag - - # Represents a Google Tag Manager Trigger - # Corresponds to the JSON property `trigger` - # @return [Google::Apis::TagmanagerV2::Trigger] - attr_accessor :trigger - - # Represents a Google Tag Manager Variable. - # Corresponds to the JSON property `variable` - # @return [Google::Apis::TagmanagerV2::Variable] - attr_accessor :variable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @change_status = args[:change_status] if args.key?(:change_status) - @folder = args[:folder] if args.key?(:folder) - @tag = args[:tag] if args.key?(:tag) - @trigger = args[:trigger] if args.key?(:trigger) - @variable = args[:variable] if args.key?(:variable) - end - end - - # Represents a Google Tag Manager Environment. Note that a user can create, - # delete and update environments of type USER, but can only update the - # enable_debug and url fields of environments of other types. - class Environment - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # The environment authorization code. - # Corresponds to the JSON property `authorizationCode` - # @return [String] - attr_accessor :authorization_code - - # The last update time-stamp for the authorization code. - # Corresponds to the JSON property `authorizationTimestamp` - # @return [String] - attr_accessor :authorization_timestamp - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # Represents a link to a container version. - # Corresponds to the JSON property `containerVersionId` - # @return [String] - attr_accessor :container_version_id - - # The environment description. Can be set or changed only on USER type - # environments. @mutable tagmanager.accounts.containers.environments.create @ - # mutable tagmanager.accounts.containers.environments.update - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # Whether or not to enable debug by default for the environment. @mutable - # tagmanager.accounts.containers.environments.create @mutable tagmanager. - # accounts.containers.environments.update - # Corresponds to the JSON property `enableDebug` - # @return [Boolean] - attr_accessor :enable_debug - alias_method :enable_debug?, :enable_debug - - # GTM Environment ID uniquely identifies the GTM Environment. - # Corresponds to the JSON property `environmentId` - # @return [String] - attr_accessor :environment_id - - # The fingerprint of the GTM environment as computed at storage time. This value - # is recomputed whenever the environment is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # The environment display name. Can be set or changed only on USER type - # environments. @mutable tagmanager.accounts.containers.environments.create @ - # mutable tagmanager.accounts.containers.environments.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # GTM Environment's API relative path. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - # Auto generated link to the tag manager UI - # Corresponds to the JSON property `tagManagerUrl` - # @return [String] - attr_accessor :tag_manager_url - - # The type of this environment. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # Default preview page url for the environment. @mutable tagmanager.accounts. - # containers.environments.create @mutable tagmanager.accounts.containers. - # environments.update - # Corresponds to the JSON property `url` - # @return [String] - attr_accessor :url - - # Represents a link to a quick preview of a workspace. - # Corresponds to the JSON property `workspaceId` - # @return [String] - attr_accessor :workspace_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @authorization_code = args[:authorization_code] if args.key?(:authorization_code) - @authorization_timestamp = args[:authorization_timestamp] if args.key?(:authorization_timestamp) - @container_id = args[:container_id] if args.key?(:container_id) - @container_version_id = args[:container_version_id] if args.key?(:container_version_id) - @description = args[:description] if args.key?(:description) - @enable_debug = args[:enable_debug] if args.key?(:enable_debug) - @environment_id = args[:environment_id] if args.key?(:environment_id) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @name = args[:name] if args.key?(:name) - @path = args[:path] if args.key?(:path) - @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url) - @type = args[:type] if args.key?(:type) - @url = args[:url] if args.key?(:url) - @workspace_id = args[:workspace_id] if args.key?(:workspace_id) - end - end - - # Represents a Google Tag Manager Folder. - class Folder - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # The fingerprint of the GTM Folder as computed at storage time. This value is - # recomputed whenever the folder is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # The Folder ID uniquely identifies the GTM Folder. - # Corresponds to the JSON property `folderId` - # @return [String] - attr_accessor :folder_id - - # Folder display name. @mutable tagmanager.accounts.containers.workspaces. - # folders.create @mutable tagmanager.accounts.containers.workspaces.folders. - # update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # User notes on how to apply this folder in the container. @mutable tagmanager. - # accounts.containers.workspaces.folders.create @mutable tagmanager.accounts. - # containers.workspaces.folders.update - # Corresponds to the JSON property `notes` - # @return [String] - attr_accessor :notes - - # GTM Folder's API relative path. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - # Auto generated link to the tag manager UI - # Corresponds to the JSON property `tagManagerUrl` - # @return [String] - attr_accessor :tag_manager_url - - # GTM Workspace ID. - # Corresponds to the JSON property `workspaceId` - # @return [String] - attr_accessor :workspace_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @container_id = args[:container_id] if args.key?(:container_id) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @folder_id = args[:folder_id] if args.key?(:folder_id) - @name = args[:name] if args.key?(:name) - @notes = args[:notes] if args.key?(:notes) - @path = args[:path] if args.key?(:path) - @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url) - @workspace_id = args[:workspace_id] if args.key?(:workspace_id) - end - end - - # Represents a Google Tag Manager Folder's contents. - class FolderEntities - include Google::Apis::Core::Hashable - - # Continuation token for fetching the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # The list of tags inside the folder. - # Corresponds to the JSON property `tag` - # @return [Array] - attr_accessor :tag - - # The list of triggers inside the folder. - # Corresponds to the JSON property `trigger` - # @return [Array] - attr_accessor :trigger - - # The list of variables inside the folder. - # Corresponds to the JSON property `variable` - # @return [Array] - attr_accessor :variable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @tag = args[:tag] if args.key?(:tag) - @trigger = args[:trigger] if args.key?(:trigger) - @variable = args[:variable] if args.key?(:variable) - end - end - - # Represents the link between a custom template and an entry on the Community - # Template Gallery site. - class GalleryReference - include Google::Apis::Core::Hashable - - # The name of the host for the community gallery template. - # Corresponds to the JSON property `host` - # @return [String] - attr_accessor :host - - # If a user has manually edited the community gallery template. - # Corresponds to the JSON property `isModified` - # @return [Boolean] - attr_accessor :is_modified - alias_method :is_modified?, :is_modified - - # The name of the owner for the community gallery template. - # Corresponds to the JSON property `owner` - # @return [String] - attr_accessor :owner - - # The name of the repository for the community gallery template. - # Corresponds to the JSON property `repository` - # @return [String] - attr_accessor :repository - - # The signature of the community gallery template as computed at import time. - # This value is recomputed whenever the template is updated from the gallery. - # Corresponds to the JSON property `signature` - # @return [String] - attr_accessor :signature - - # The version of the community gallery template. - # Corresponds to the JSON property `version` - # @return [String] - attr_accessor :version - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @host = args[:host] if args.key?(:host) - @is_modified = args[:is_modified] if args.key?(:is_modified) - @owner = args[:owner] if args.key?(:owner) - @repository = args[:repository] if args.key?(:repository) - @signature = args[:signature] if args.key?(:signature) - @version = args[:version] if args.key?(:version) - end - end - - # The changes that have occurred in the workspace since the base container - # version. - class GetWorkspaceStatusResponse - include Google::Apis::Core::Hashable - - # The merge conflict after sync. - # Corresponds to the JSON property `mergeConflict` - # @return [Array] - attr_accessor :merge_conflict - - # Entities that have been changed in the workspace. - # Corresponds to the JSON property `workspaceChange` - # @return [Array] - attr_accessor :workspace_change - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @merge_conflict = args[:merge_conflict] if args.key?(:merge_conflict) - @workspace_change = args[:workspace_change] if args.key?(:workspace_change) - end - end - - # List Accounts Response. - class ListAccountsResponse - include Google::Apis::Core::Hashable - - # List of GTM Accounts that a user has access to. - # Corresponds to the JSON property `account` - # @return [Array] - attr_accessor :account - - # Continuation token for fetching the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account = args[:account] if args.key?(:account) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # List container versions response. - class ListContainerVersionsResponse - include Google::Apis::Core::Hashable - - # All container version headers of a GTM Container. - # Corresponds to the JSON property `containerVersionHeader` - # @return [Array] - attr_accessor :container_version_header - - # Continuation token for fetching the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @container_version_header = args[:container_version_header] if args.key?(:container_version_header) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # List Containers Response. - class ListContainersResponse - include Google::Apis::Core::Hashable - - # All Containers of a GTM Account. - # Corresponds to the JSON property `container` - # @return [Array] - attr_accessor :container - - # Continuation token for fetching the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @container = args[:container] if args.key?(:container) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # A list of enabled built-in variables. - class ListEnabledBuiltInVariablesResponse - include Google::Apis::Core::Hashable - - # All GTM BuiltInVariables of a GTM container. - # Corresponds to the JSON property `builtInVariable` - # @return [Array] - attr_accessor :built_in_variable - - # Continuation token for fetching the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @built_in_variable = args[:built_in_variable] if args.key?(:built_in_variable) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # List Environments Response. - class ListEnvironmentsResponse - include Google::Apis::Core::Hashable - - # All Environments of a GTM Container. - # Corresponds to the JSON property `environment` - # @return [Array] - attr_accessor :environment - - # Continuation token for fetching the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @environment = args[:environment] if args.key?(:environment) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # List Folders Response. - class ListFoldersResponse - include Google::Apis::Core::Hashable - - # All GTM Folders of a GTM Container. - # Corresponds to the JSON property `folder` - # @return [Array] - attr_accessor :folder - - # Continuation token for fetching the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @folder = args[:folder] if args.key?(:folder) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - end - end - - # List Tags Response. - class ListTagsResponse - include Google::Apis::Core::Hashable - - # Continuation token for fetching the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # All GTM Tags of a GTM Container. - # Corresponds to the JSON property `tag` - # @return [Array] - attr_accessor :tag - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @tag = args[:tag] if args.key?(:tag) - end - end - - # - class ListTemplatesResponse - include Google::Apis::Core::Hashable - - # Continuation token for fetching the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # All GTM Custom Templates of a GTM Container. - # Corresponds to the JSON property `template` - # @return [Array] - attr_accessor :template - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @template = args[:template] if args.key?(:template) - end - end - - # List triggers response. - class ListTriggersResponse - include Google::Apis::Core::Hashable - - # Continuation token for fetching the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # All GTM Triggers of a GTM Container. - # Corresponds to the JSON property `trigger` - # @return [Array] - attr_accessor :trigger - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @trigger = args[:trigger] if args.key?(:trigger) - end - end - - # List user permissions response. - class ListUserPermissionsResponse - include Google::Apis::Core::Hashable - - # Continuation token for fetching the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # All GTM UserPermissions of a GTM Account. - # Corresponds to the JSON property `userPermission` - # @return [Array] - attr_accessor :user_permission - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @user_permission = args[:user_permission] if args.key?(:user_permission) - end - end - - # List Variables Response. - class ListVariablesResponse - include Google::Apis::Core::Hashable - - # Continuation token for fetching the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # All GTM Variables of a GTM Container. - # Corresponds to the JSON property `variable` - # @return [Array] - attr_accessor :variable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @variable = args[:variable] if args.key?(:variable) - end - end - - # A list of workspaces in a container. - class ListWorkspacesResponse - include Google::Apis::Core::Hashable - - # Continuation token for fetching the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # All Workspaces of a GTM Container. - # Corresponds to the JSON property `workspace` - # @return [Array] - attr_accessor :workspace - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @workspace = args[:workspace] if args.key?(:workspace) - end - end - - # - class ListZonesResponse - include Google::Apis::Core::Hashable - - # Continuation token for fetching the next page of results. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # All GTM Zones of a GTM Container. - # Corresponds to the JSON property `zone` - # @return [Array] - attr_accessor :zone - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @zone = args[:zone] if args.key?(:zone) - end - end - - # Represents a merge conflict. - class MergeConflict - include Google::Apis::Core::Hashable - - # A workspace entity that may represent a tag, trigger, variable, or folder in - # addition to its status in the workspace. - # Corresponds to the JSON property `entityInBaseVersion` - # @return [Google::Apis::TagmanagerV2::Entity] - attr_accessor :entity_in_base_version - - # A workspace entity that may represent a tag, trigger, variable, or folder in - # addition to its status in the workspace. - # Corresponds to the JSON property `entityInWorkspace` - # @return [Google::Apis::TagmanagerV2::Entity] - attr_accessor :entity_in_workspace - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @entity_in_base_version = args[:entity_in_base_version] if args.key?(:entity_in_base_version) - @entity_in_workspace = args[:entity_in_workspace] if args.key?(:entity_in_workspace) - end - end - - # Represents a Google Tag Manager Parameter. - class Parameter - include Google::Apis::Core::Hashable - - # The named key that uniquely identifies a parameter. Required for top-level - # parameters, as well as map values. Ignored for list values. @mutable - # tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager. - # accounts.containers.workspaces.variables.update @mutable tagmanager.accounts. - # containers.workspaces.triggers.create @mutable tagmanager.accounts.containers. - # workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces. - # tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update - # Corresponds to the JSON property `key` - # @return [String] - attr_accessor :key - - # This list parameter's parameters (keys will be ignored). @mutable tagmanager. - # accounts.containers.workspaces.variables.create @mutable tagmanager.accounts. - # containers.workspaces.variables.update @mutable tagmanager.accounts.containers. - # workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces. - # triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update - # Corresponds to the JSON property `list` - # @return [Array] - attr_accessor :list - - # This map parameter's parameters (must have keys; keys must be unique). @ - # mutable tagmanager.accounts.containers.workspaces.variables.create @mutable - # tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager. - # accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts. - # containers.workspaces.triggers.update @mutable tagmanager.accounts.containers. - # workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags. - # update - # Corresponds to the JSON property `map` - # @return [Array] - attr_accessor :map - - # The parameter type. Valid values are: - boolean: The value represents a - # boolean, represented as 'true' or 'false' - integer: The value represents a 64- - # bit signed integer value, in base 10 - list: A list of parameters should be - # specified - map: A map of parameters should be specified - template: The value - # represents any text; this can include variable references (even variable - # references that might return non-string types) - trigger_reference: The value - # represents a trigger, represented as the trigger id - tag_reference: The value - # represents a tag, represented as the tag name @mutable tagmanager.accounts. - # containers.workspaces.variables.create @mutable tagmanager.accounts.containers. - # workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces. - # triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers. - # update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable - # tagmanager.accounts.containers.workspaces.tags.update - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # A parameter's value (may contain variable references such as "``myVariable``") - # as appropriate to the specified type. @mutable tagmanager.accounts.containers. - # workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces. - # variables.update @mutable tagmanager.accounts.containers.workspaces.triggers. - # create @mutable tagmanager.accounts.containers.workspaces.triggers.update @ - # mutable tagmanager.accounts.containers.workspaces.tags.create @mutable - # tagmanager.accounts.containers.workspaces.tags.update - # Corresponds to the JSON property `value` - # @return [String] - attr_accessor :value - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @key = args[:key] if args.key?(:key) - @list = args[:list] if args.key?(:list) - @map = args[:map] if args.key?(:map) - @type = args[:type] if args.key?(:type) - @value = args[:value] if args.key?(:value) - end - end - - # Publish container version response. - class PublishContainerVersionResponse - include Google::Apis::Core::Hashable - - # Compiler errors or not. - # Corresponds to the JSON property `compilerError` - # @return [Boolean] - attr_accessor :compiler_error - alias_method :compiler_error?, :compiler_error - - # Represents a Google Tag Manager Container Version. - # Corresponds to the JSON property `containerVersion` - # @return [Google::Apis::TagmanagerV2::ContainerVersion] - attr_accessor :container_version - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @compiler_error = args[:compiler_error] if args.key?(:compiler_error) - @container_version = args[:container_version] if args.key?(:container_version) - end - end - - # Response to quick previewing a workspace. - class QuickPreviewResponse - include Google::Apis::Core::Hashable - - # Were there compiler errors or not. - # Corresponds to the JSON property `compilerError` - # @return [Boolean] - attr_accessor :compiler_error - alias_method :compiler_error?, :compiler_error - - # Represents a Google Tag Manager Container Version. - # Corresponds to the JSON property `containerVersion` - # @return [Google::Apis::TagmanagerV2::ContainerVersion] - attr_accessor :container_version - - # The status of a workspace after synchronization. - # Corresponds to the JSON property `syncStatus` - # @return [Google::Apis::TagmanagerV2::SyncStatus] - attr_accessor :sync_status - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @compiler_error = args[:compiler_error] if args.key?(:compiler_error) - @container_version = args[:container_version] if args.key?(:container_version) - @sync_status = args[:sync_status] if args.key?(:sync_status) - end - end - - # The result of reverting a built-in variable in a workspace. - class RevertBuiltInVariableResponse - include Google::Apis::Core::Hashable - - # Whether the built-in variable is enabled after reversion. - # Corresponds to the JSON property `enabled` - # @return [Boolean] - attr_accessor :enabled - alias_method :enabled?, :enabled - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @enabled = args[:enabled] if args.key?(:enabled) - end - end - - # The result of reverting folder changes in a workspace. - class RevertFolderResponse - include Google::Apis::Core::Hashable - - # Represents a Google Tag Manager Folder. - # Corresponds to the JSON property `folder` - # @return [Google::Apis::TagmanagerV2::Folder] - attr_accessor :folder - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @folder = args[:folder] if args.key?(:folder) - end - end - - # The result of reverting a tag in a workspace. - class RevertTagResponse - include Google::Apis::Core::Hashable - - # Represents a Google Tag Manager Tag. - # Corresponds to the JSON property `tag` - # @return [Google::Apis::TagmanagerV2::Tag] - attr_accessor :tag - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @tag = args[:tag] if args.key?(:tag) - end - end - - # The result of reverting a template in a workspace. - class RevertTemplateResponse - include Google::Apis::Core::Hashable - - # Represents a Google Tag Manager Custom Template's contents. - # Corresponds to the JSON property `template` - # @return [Google::Apis::TagmanagerV2::CustomTemplate] - attr_accessor :template - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @template = args[:template] if args.key?(:template) - end - end - - # The result of reverting a trigger in a workspace. - class RevertTriggerResponse - include Google::Apis::Core::Hashable - - # Represents a Google Tag Manager Trigger - # Corresponds to the JSON property `trigger` - # @return [Google::Apis::TagmanagerV2::Trigger] - attr_accessor :trigger - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @trigger = args[:trigger] if args.key?(:trigger) - end - end - - # The result of reverting a variable in a workspace. - class RevertVariableResponse - include Google::Apis::Core::Hashable - - # Represents a Google Tag Manager Variable. - # Corresponds to the JSON property `variable` - # @return [Google::Apis::TagmanagerV2::Variable] - attr_accessor :variable - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @variable = args[:variable] if args.key?(:variable) - end - end - - # The result of reverting a zone in a workspace. - class RevertZoneResponse - include Google::Apis::Core::Hashable - - # Represents a Google Tag Manager Zone's contents. - # Corresponds to the JSON property `zone` - # @return [Google::Apis::TagmanagerV2::Zone] - attr_accessor :zone - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @zone = args[:zone] if args.key?(:zone) - end - end - - # Represents a reference to atag that fires before another tag in order to set - # up dependencies. - class SetupTag - include Google::Apis::Core::Hashable - - # If true, fire the main tag if and only if the setup tag fires successfully. If - # false, fire the main tag regardless of setup tag firing status. - # Corresponds to the JSON property `stopOnSetupFailure` - # @return [Boolean] - attr_accessor :stop_on_setup_failure - alias_method :stop_on_setup_failure?, :stop_on_setup_failure - - # The name of the setup tag. - # Corresponds to the JSON property `tagName` - # @return [String] - attr_accessor :tag_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @stop_on_setup_failure = args[:stop_on_setup_failure] if args.key?(:stop_on_setup_failure) - @tag_name = args[:tag_name] if args.key?(:tag_name) - end - end - - # The status of a workspace after synchronization. - class SyncStatus - include Google::Apis::Core::Hashable - - # Synchornization operation detected a merge conflict. - # Corresponds to the JSON property `mergeConflict` - # @return [Boolean] - attr_accessor :merge_conflict - alias_method :merge_conflict?, :merge_conflict - - # An error occurred during the synchronization operation. - # Corresponds to the JSON property `syncError` - # @return [Boolean] - attr_accessor :sync_error - alias_method :sync_error?, :sync_error - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @merge_conflict = args[:merge_conflict] if args.key?(:merge_conflict) - @sync_error = args[:sync_error] if args.key?(:sync_error) - end - end - - # A response after synchronizing the workspace to the latest container version. - class SyncWorkspaceResponse - include Google::Apis::Core::Hashable - - # The merge conflict after sync. If this field is not empty, the sync is still - # treated as successful. But a version cannot be created until all conflicts are - # resolved. - # Corresponds to the JSON property `mergeConflict` - # @return [Array] - attr_accessor :merge_conflict - - # The status of a workspace after synchronization. - # Corresponds to the JSON property `syncStatus` - # @return [Google::Apis::TagmanagerV2::SyncStatus] - attr_accessor :sync_status - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @merge_conflict = args[:merge_conflict] if args.key?(:merge_conflict) - @sync_status = args[:sync_status] if args.key?(:sync_status) - end - end - - # Represents a Google Tag Manager Tag. - class Tag - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will - # not fire. @mutable tagmanager.accounts.containers.workspaces.tags.create @ - # mutable tagmanager.accounts.containers.workspaces.tags.update - # Corresponds to the JSON property `blockingRuleId` - # @return [Array] - attr_accessor :blocking_rule_id - - # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag - # will not fire. @mutable tagmanager.accounts.containers.workspaces.tags.create @ - # mutable tagmanager.accounts.containers.workspaces.tags.update - # Corresponds to the JSON property `blockingTriggerId` - # @return [Array] - attr_accessor :blocking_trigger_id - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # The fingerprint of the GTM Tag as computed at storage time. This value is - # recomputed whenever the tag is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # Firing rule IDs. A tag will fire when any of the listed rules are true and all - # of its blockingRuleIds (if any specified) are false. @mutable tagmanager. - # accounts.containers.workspaces.tags.create @mutable tagmanager.accounts. - # containers.workspaces.tags.update - # Corresponds to the JSON property `firingRuleId` - # @return [Array] - attr_accessor :firing_rule_id - - # Firing trigger IDs. A tag will fire when any of the listed triggers are true - # and all of its blockingTriggerIds (if any specified) are false. @mutable - # tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager. - # accounts.containers.workspaces.tags.update - # Corresponds to the JSON property `firingTriggerId` - # @return [Array] - attr_accessor :firing_trigger_id - - # If set to true, this tag will only fire in the live environment (e.g. not in - # preview or debug mode). @mutable tagmanager.accounts.containers.workspaces. - # tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update - # Corresponds to the JSON property `liveOnly` - # @return [Boolean] - attr_accessor :live_only - alias_method :live_only?, :live_only - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `monitoringMetadata` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :monitoring_metadata - - # If non-empty, then the tag display name will be included in the monitoring - # metadata map using the key specified. @mutable tagmanager.accounts.containers. - # workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags. - # update - # Corresponds to the JSON property `monitoringMetadataTagNameKey` - # @return [String] - attr_accessor :monitoring_metadata_tag_name_key - - # Tag display name. @mutable tagmanager.accounts.containers.workspaces.tags. - # create @mutable tagmanager.accounts.containers.workspaces.tags.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # User notes on how to apply this tag in the container. @mutable tagmanager. - # accounts.containers.workspaces.tags.create @mutable tagmanager.accounts. - # containers.workspaces.tags.update - # Corresponds to the JSON property `notes` - # @return [String] - attr_accessor :notes - - # The tag's parameters. @mutable tagmanager.accounts.containers.workspaces.tags. - # create @mutable tagmanager.accounts.containers.workspaces.tags.update - # Corresponds to the JSON property `parameter` - # @return [Array] - attr_accessor :parameter - - # Parent folder id. - # Corresponds to the JSON property `parentFolderId` - # @return [String] - attr_accessor :parent_folder_id - - # GTM Tag's API relative path. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - # Indicates whether the tag is paused, which prevents the tag from firing. @ - # mutable tagmanager.accounts.containers.workspaces.tags.create @mutable - # tagmanager.accounts.containers.workspaces.tags.update - # Corresponds to the JSON property `paused` - # @return [Boolean] - attr_accessor :paused - alias_method :paused?, :paused - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `priority` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :priority - - # The end timestamp in milliseconds to schedule a tag. @mutable tagmanager. - # accounts.containers.workspaces.tags.create @mutable tagmanager.accounts. - # containers.workspaces.tags.update - # Corresponds to the JSON property `scheduleEndMs` - # @return [Fixnum] - attr_accessor :schedule_end_ms - - # The start timestamp in milliseconds to schedule a tag. @mutable tagmanager. - # accounts.containers.workspaces.tags.create @mutable tagmanager.accounts. - # containers.workspaces.tags.update - # Corresponds to the JSON property `scheduleStartMs` - # @return [Fixnum] - attr_accessor :schedule_start_ms - - # The list of setup tags. Currently we only allow one. - # Corresponds to the JSON property `setupTag` - # @return [Array] - attr_accessor :setup_tag - - # Option to fire this tag. - # Corresponds to the JSON property `tagFiringOption` - # @return [String] - attr_accessor :tag_firing_option - - # The Tag ID uniquely identifies the GTM Tag. - # Corresponds to the JSON property `tagId` - # @return [String] - attr_accessor :tag_id - - # Auto generated link to the tag manager UI - # Corresponds to the JSON property `tagManagerUrl` - # @return [String] - attr_accessor :tag_manager_url - - # The list of teardown tags. Currently we only allow one. - # Corresponds to the JSON property `teardownTag` - # @return [Array] - attr_accessor :teardown_tag - - # GTM Tag Type. @mutable tagmanager.accounts.containers.workspaces.tags.create @ - # mutable tagmanager.accounts.containers.workspaces.tags.update - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # GTM Workspace ID. - # Corresponds to the JSON property `workspaceId` - # @return [String] - attr_accessor :workspace_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @blocking_rule_id = args[:blocking_rule_id] if args.key?(:blocking_rule_id) - @blocking_trigger_id = args[:blocking_trigger_id] if args.key?(:blocking_trigger_id) - @container_id = args[:container_id] if args.key?(:container_id) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @firing_rule_id = args[:firing_rule_id] if args.key?(:firing_rule_id) - @firing_trigger_id = args[:firing_trigger_id] if args.key?(:firing_trigger_id) - @live_only = args[:live_only] if args.key?(:live_only) - @monitoring_metadata = args[:monitoring_metadata] if args.key?(:monitoring_metadata) - @monitoring_metadata_tag_name_key = args[:monitoring_metadata_tag_name_key] if args.key?(:monitoring_metadata_tag_name_key) - @name = args[:name] if args.key?(:name) - @notes = args[:notes] if args.key?(:notes) - @parameter = args[:parameter] if args.key?(:parameter) - @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id) - @path = args[:path] if args.key?(:path) - @paused = args[:paused] if args.key?(:paused) - @priority = args[:priority] if args.key?(:priority) - @schedule_end_ms = args[:schedule_end_ms] if args.key?(:schedule_end_ms) - @schedule_start_ms = args[:schedule_start_ms] if args.key?(:schedule_start_ms) - @setup_tag = args[:setup_tag] if args.key?(:setup_tag) - @tag_firing_option = args[:tag_firing_option] if args.key?(:tag_firing_option) - @tag_id = args[:tag_id] if args.key?(:tag_id) - @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url) - @teardown_tag = args[:teardown_tag] if args.key?(:teardown_tag) - @type = args[:type] if args.key?(:type) - @workspace_id = args[:workspace_id] if args.key?(:workspace_id) - end - end - - # Represents a tag that fires after another tag in order to tear down - # dependencies. - class TeardownTag - include Google::Apis::Core::Hashable - - # If true, fire the teardown tag if and only if the main tag fires successfully. - # If false, fire the teardown tag regardless of main tag firing status. - # Corresponds to the JSON property `stopTeardownOnFailure` - # @return [Boolean] - attr_accessor :stop_teardown_on_failure - alias_method :stop_teardown_on_failure?, :stop_teardown_on_failure - - # The name of the teardown tag. - # Corresponds to the JSON property `tagName` - # @return [String] - attr_accessor :tag_name - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @stop_teardown_on_failure = args[:stop_teardown_on_failure] if args.key?(:stop_teardown_on_failure) - @tag_name = args[:tag_name] if args.key?(:tag_name) - end - end - - # Represents a Google Tag Manager Trigger - class Trigger - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # Used in the case of auto event tracking. @mutable tagmanager.accounts. - # containers.workspaces.triggers.create @mutable tagmanager.accounts.containers. - # workspaces.triggers.update - # Corresponds to the JSON property `autoEventFilter` - # @return [Array] - attr_accessor :auto_event_filter - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `checkValidation` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :check_validation - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `continuousTimeMinMilliseconds` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :continuous_time_min_milliseconds - - # Used in the case of custom event, which is fired iff all Conditions are true. @ - # mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable - # tagmanager.accounts.containers.workspaces.triggers.update - # Corresponds to the JSON property `customEventFilter` - # @return [Array] - attr_accessor :custom_event_filter - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `eventName` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :event_name - - # The trigger will only fire iff all Conditions are true. @mutable tagmanager. - # accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts. - # containers.workspaces.triggers.update - # Corresponds to the JSON property `filter` - # @return [Array] - attr_accessor :filter - - # The fingerprint of the GTM Trigger as computed at storage time. This value is - # recomputed whenever the trigger is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `horizontalScrollPercentageList` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :horizontal_scroll_percentage_list - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `interval` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :interval - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `intervalSeconds` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :interval_seconds - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `limit` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :limit - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `maxTimerLengthSeconds` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :max_timer_length_seconds - - # Trigger display name. @mutable tagmanager.accounts.containers.workspaces. - # triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers. - # update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # User notes on how to apply this trigger in the container. @mutable tagmanager. - # accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts. - # containers.workspaces.triggers.update - # Corresponds to the JSON property `notes` - # @return [String] - attr_accessor :notes - - # Additional parameters. @mutable tagmanager.accounts.containers.workspaces. - # triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers. - # update - # Corresponds to the JSON property `parameter` - # @return [Array] - attr_accessor :parameter - - # Parent folder id. - # Corresponds to the JSON property `parentFolderId` - # @return [String] - attr_accessor :parent_folder_id - - # GTM Trigger's API relative path. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `selector` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :selector - - # Auto generated link to the tag manager UI - # Corresponds to the JSON property `tagManagerUrl` - # @return [String] - attr_accessor :tag_manager_url - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `totalTimeMinMilliseconds` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :total_time_min_milliseconds - - # The Trigger ID uniquely identifies the GTM Trigger. - # Corresponds to the JSON property `triggerId` - # @return [String] - attr_accessor :trigger_id - - # Defines the data layer event that causes this trigger. @mutable tagmanager. - # accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts. - # containers.workspaces.triggers.update - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `uniqueTriggerId` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :unique_trigger_id - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `verticalScrollPercentageList` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :vertical_scroll_percentage_list - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `visibilitySelector` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :visibility_selector - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `visiblePercentageMax` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :visible_percentage_max - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `visiblePercentageMin` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :visible_percentage_min - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `waitForTags` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :wait_for_tags - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `waitForTagsTimeout` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :wait_for_tags_timeout - - # GTM Workspace ID. - # Corresponds to the JSON property `workspaceId` - # @return [String] - attr_accessor :workspace_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @auto_event_filter = args[:auto_event_filter] if args.key?(:auto_event_filter) - @check_validation = args[:check_validation] if args.key?(:check_validation) - @container_id = args[:container_id] if args.key?(:container_id) - @continuous_time_min_milliseconds = args[:continuous_time_min_milliseconds] if args.key?(:continuous_time_min_milliseconds) - @custom_event_filter = args[:custom_event_filter] if args.key?(:custom_event_filter) - @event_name = args[:event_name] if args.key?(:event_name) - @filter = args[:filter] if args.key?(:filter) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @horizontal_scroll_percentage_list = args[:horizontal_scroll_percentage_list] if args.key?(:horizontal_scroll_percentage_list) - @interval = args[:interval] if args.key?(:interval) - @interval_seconds = args[:interval_seconds] if args.key?(:interval_seconds) - @limit = args[:limit] if args.key?(:limit) - @max_timer_length_seconds = args[:max_timer_length_seconds] if args.key?(:max_timer_length_seconds) - @name = args[:name] if args.key?(:name) - @notes = args[:notes] if args.key?(:notes) - @parameter = args[:parameter] if args.key?(:parameter) - @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id) - @path = args[:path] if args.key?(:path) - @selector = args[:selector] if args.key?(:selector) - @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url) - @total_time_min_milliseconds = args[:total_time_min_milliseconds] if args.key?(:total_time_min_milliseconds) - @trigger_id = args[:trigger_id] if args.key?(:trigger_id) - @type = args[:type] if args.key?(:type) - @unique_trigger_id = args[:unique_trigger_id] if args.key?(:unique_trigger_id) - @vertical_scroll_percentage_list = args[:vertical_scroll_percentage_list] if args.key?(:vertical_scroll_percentage_list) - @visibility_selector = args[:visibility_selector] if args.key?(:visibility_selector) - @visible_percentage_max = args[:visible_percentage_max] if args.key?(:visible_percentage_max) - @visible_percentage_min = args[:visible_percentage_min] if args.key?(:visible_percentage_min) - @wait_for_tags = args[:wait_for_tags] if args.key?(:wait_for_tags) - @wait_for_tags_timeout = args[:wait_for_tags_timeout] if args.key?(:wait_for_tags_timeout) - @workspace_id = args[:workspace_id] if args.key?(:workspace_id) - end - end - - # Represents a user's permissions to an account and its container. - class UserPermission - include Google::Apis::Core::Hashable - - # Defines the Google Tag Manager Account access permissions. - # Corresponds to the JSON property `accountAccess` - # @return [Google::Apis::TagmanagerV2::AccountAccess] - attr_accessor :account_access - - # The Account ID uniquely identifies the GTM Account. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # GTM Container access permissions. @mutable tagmanager.accounts.permissions. - # create @mutable tagmanager.accounts.permissions.update - # Corresponds to the JSON property `containerAccess` - # @return [Array] - attr_accessor :container_access - - # User's email address. @mutable tagmanager.accounts.permissions.create - # Corresponds to the JSON property `emailAddress` - # @return [String] - attr_accessor :email_address - - # GTM UserPermission's API relative path. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_access = args[:account_access] if args.key?(:account_access) - @account_id = args[:account_id] if args.key?(:account_id) - @container_access = args[:container_access] if args.key?(:container_access) - @email_address = args[:email_address] if args.key?(:email_address) - @path = args[:path] if args.key?(:path) - end - end - - # Represents a Google Tag Manager Variable. - class Variable - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # For mobile containers only: A list of trigger IDs for disabling conditional - # variables; the variable is enabled if one of the enabling trigger is true - # while all the disabling trigger are false. Treated as an unordered set. @ - # mutable tagmanager.accounts.containers.workspaces.variables.create @mutable - # tagmanager.accounts.containers.workspaces.variables.update - # Corresponds to the JSON property `disablingTriggerId` - # @return [Array] - attr_accessor :disabling_trigger_id - - # For mobile containers only: A list of trigger IDs for enabling conditional - # variables; the variable is enabled if one of the enabling triggers is true - # while all the disabling triggers are false. Treated as an unordered set. @ - # mutable tagmanager.accounts.containers.workspaces.variables.create @mutable - # tagmanager.accounts.containers.workspaces.variables.update - # Corresponds to the JSON property `enablingTriggerId` - # @return [Array] - attr_accessor :enabling_trigger_id - - # The fingerprint of the GTM Variable as computed at storage time. This value is - # recomputed whenever the variable is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # Option to convert a variable value to other value. - # Corresponds to the JSON property `formatValue` - # @return [Google::Apis::TagmanagerV2::VariableFormatValue] - attr_accessor :format_value - - # Variable display name. @mutable tagmanager.accounts.containers.workspaces. - # variables.create @mutable tagmanager.accounts.containers.workspaces.variables. - # update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # User notes on how to apply this variable in the container. @mutable tagmanager. - # accounts.containers.workspaces.variables.create @mutable tagmanager.accounts. - # containers.workspaces.variables.update - # Corresponds to the JSON property `notes` - # @return [String] - attr_accessor :notes - - # The variable's parameters. @mutable tagmanager.accounts.containers.workspaces. - # variables.create @mutable tagmanager.accounts.containers.workspaces.variables. - # update - # Corresponds to the JSON property `parameter` - # @return [Array] - attr_accessor :parameter - - # Parent folder id. - # Corresponds to the JSON property `parentFolderId` - # @return [String] - attr_accessor :parent_folder_id - - # GTM Variable's API relative path. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - # The end timestamp in milliseconds to schedule a variable. @mutable tagmanager. - # accounts.containers.workspaces.variables.create @mutable tagmanager.accounts. - # containers.workspaces.variables.update - # Corresponds to the JSON property `scheduleEndMs` - # @return [Fixnum] - attr_accessor :schedule_end_ms - - # The start timestamp in milliseconds to schedule a variable. @mutable - # tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager. - # accounts.containers.workspaces.variables.update - # Corresponds to the JSON property `scheduleStartMs` - # @return [Fixnum] - attr_accessor :schedule_start_ms - - # Auto generated link to the tag manager UI - # Corresponds to the JSON property `tagManagerUrl` - # @return [String] - attr_accessor :tag_manager_url - - # GTM Variable Type. @mutable tagmanager.accounts.containers.workspaces. - # variables.create @mutable tagmanager.accounts.containers.workspaces.variables. - # update - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # The Variable ID uniquely identifies the GTM Variable. - # Corresponds to the JSON property `variableId` - # @return [String] - attr_accessor :variable_id - - # GTM Workspace ID. - # Corresponds to the JSON property `workspaceId` - # @return [String] - attr_accessor :workspace_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @container_id = args[:container_id] if args.key?(:container_id) - @disabling_trigger_id = args[:disabling_trigger_id] if args.key?(:disabling_trigger_id) - @enabling_trigger_id = args[:enabling_trigger_id] if args.key?(:enabling_trigger_id) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @format_value = args[:format_value] if args.key?(:format_value) - @name = args[:name] if args.key?(:name) - @notes = args[:notes] if args.key?(:notes) - @parameter = args[:parameter] if args.key?(:parameter) - @parent_folder_id = args[:parent_folder_id] if args.key?(:parent_folder_id) - @path = args[:path] if args.key?(:path) - @schedule_end_ms = args[:schedule_end_ms] if args.key?(:schedule_end_ms) - @schedule_start_ms = args[:schedule_start_ms] if args.key?(:schedule_start_ms) - @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url) - @type = args[:type] if args.key?(:type) - @variable_id = args[:variable_id] if args.key?(:variable_id) - @workspace_id = args[:workspace_id] if args.key?(:workspace_id) - end - end - - # - class VariableFormatValue - include Google::Apis::Core::Hashable - - # The option to convert a string-type variable value to either lowercase or - # uppercase. - # Corresponds to the JSON property `caseConversionType` - # @return [String] - attr_accessor :case_conversion_type - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `convertFalseToValue` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :convert_false_to_value - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `convertNullToValue` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :convert_null_to_value - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `convertTrueToValue` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :convert_true_to_value - - # Represents a Google Tag Manager Parameter. - # Corresponds to the JSON property `convertUndefinedToValue` - # @return [Google::Apis::TagmanagerV2::Parameter] - attr_accessor :convert_undefined_to_value - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @case_conversion_type = args[:case_conversion_type] if args.key?(:case_conversion_type) - @convert_false_to_value = args[:convert_false_to_value] if args.key?(:convert_false_to_value) - @convert_null_to_value = args[:convert_null_to_value] if args.key?(:convert_null_to_value) - @convert_true_to_value = args[:convert_true_to_value] if args.key?(:convert_true_to_value) - @convert_undefined_to_value = args[:convert_undefined_to_value] if args.key?(:convert_undefined_to_value) - end - end - - # Represents a Google Tag Manager Container Workspace. - class Workspace - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # Workspace description. @mutable tagmanager.accounts.containers.workspaces. - # create @mutable tagmanager.accounts.containers.workspaces.update - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description - - # The fingerprint of the GTM Workspace as computed at storage time. This value - # is recomputed whenever the workspace is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # Workspace display name. @mutable tagmanager.accounts.containers.workspaces. - # create @mutable tagmanager.accounts.containers.workspaces.update - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # GTM Workspace's API relative path. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - # Auto generated link to the tag manager UI - # Corresponds to the JSON property `tagManagerUrl` - # @return [String] - attr_accessor :tag_manager_url - - # The Workspace ID uniquely identifies the GTM Workspace. - # Corresponds to the JSON property `workspaceId` - # @return [String] - attr_accessor :workspace_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @container_id = args[:container_id] if args.key?(:container_id) - @description = args[:description] if args.key?(:description) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @name = args[:name] if args.key?(:name) - @path = args[:path] if args.key?(:path) - @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url) - @workspace_id = args[:workspace_id] if args.key?(:workspace_id) - end - end - - # Represents a Google Tag Manager Zone's contents. - class Zone - include Google::Apis::Core::Hashable - - # GTM Account ID. - # Corresponds to the JSON property `accountId` - # @return [String] - attr_accessor :account_id - - # Represents a Zone's boundaries. - # Corresponds to the JSON property `boundary` - # @return [Google::Apis::TagmanagerV2::ZoneBoundary] - attr_accessor :boundary - - # Containers that are children of this Zone. - # Corresponds to the JSON property `childContainer` - # @return [Array] - attr_accessor :child_container - - # GTM Container ID. - # Corresponds to the JSON property `containerId` - # @return [String] - attr_accessor :container_id - - # The fingerprint of the GTM Zone as computed at storage time. This value is - # recomputed whenever the zone is modified. - # Corresponds to the JSON property `fingerprint` - # @return [String] - attr_accessor :fingerprint - - # Zone display name. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name - - # User notes on how to apply this zone in the container. - # Corresponds to the JSON property `notes` - # @return [String] - attr_accessor :notes - - # GTM Zone's API relative path. - # Corresponds to the JSON property `path` - # @return [String] - attr_accessor :path - - # Auto generated link to the tag manager UI - # Corresponds to the JSON property `tagManagerUrl` - # @return [String] - attr_accessor :tag_manager_url - - # Represents a Zone's type restrictions. - # Corresponds to the JSON property `typeRestriction` - # @return [Google::Apis::TagmanagerV2::ZoneTypeRestriction] - attr_accessor :type_restriction - - # GTM Workspace ID. - # Corresponds to the JSON property `workspaceId` - # @return [String] - attr_accessor :workspace_id - - # The Zone ID uniquely identifies the GTM Zone. - # Corresponds to the JSON property `zoneId` - # @return [String] - attr_accessor :zone_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @account_id = args[:account_id] if args.key?(:account_id) - @boundary = args[:boundary] if args.key?(:boundary) - @child_container = args[:child_container] if args.key?(:child_container) - @container_id = args[:container_id] if args.key?(:container_id) - @fingerprint = args[:fingerprint] if args.key?(:fingerprint) - @name = args[:name] if args.key?(:name) - @notes = args[:notes] if args.key?(:notes) - @path = args[:path] if args.key?(:path) - @tag_manager_url = args[:tag_manager_url] if args.key?(:tag_manager_url) - @type_restriction = args[:type_restriction] if args.key?(:type_restriction) - @workspace_id = args[:workspace_id] if args.key?(:workspace_id) - @zone_id = args[:zone_id] if args.key?(:zone_id) - end - end - - # Represents a Zone's boundaries. - class ZoneBoundary - include Google::Apis::Core::Hashable - - # The conditions that, when conjoined, make up the boundary. - # Corresponds to the JSON property `condition` - # @return [Array] - attr_accessor :condition - - # Custom evaluation trigger IDs. A zone will evaluate its boundary conditions - # when any of the listed triggers are true. - # Corresponds to the JSON property `customEvaluationTriggerId` - # @return [Array] - attr_accessor :custom_evaluation_trigger_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @condition = args[:condition] if args.key?(:condition) - @custom_evaluation_trigger_id = args[:custom_evaluation_trigger_id] if args.key?(:custom_evaluation_trigger_id) - end - end - - # Represents a child container of a Zone. - class ZoneChildContainer - include Google::Apis::Core::Hashable - - # The zone's nickname for the child container. - # Corresponds to the JSON property `nickname` - # @return [String] - attr_accessor :nickname - - # The child container's public id. - # Corresponds to the JSON property `publicId` - # @return [String] - attr_accessor :public_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @nickname = args[:nickname] if args.key?(:nickname) - @public_id = args[:public_id] if args.key?(:public_id) - end - end - - # Represents a Zone's type restrictions. - class ZoneTypeRestriction - include Google::Apis::Core::Hashable - - # True if type restrictions have been enabled for this Zone. - # Corresponds to the JSON property `enable` - # @return [Boolean] - attr_accessor :enable - alias_method :enable?, :enable - - # List of type public ids that have been whitelisted for use in this Zone. - # Corresponds to the JSON property `whitelistedTypeId` - # @return [Array] - attr_accessor :whitelisted_type_id - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @enable = args[:enable] if args.key?(:enable) - @whitelisted_type_id = args[:whitelisted_type_id] if args.key?(:whitelisted_type_id) - end - end - end - end -end diff --git a/generated/google/apis/tagmanager_v2/representations.rb b/generated/google/apis/tagmanager_v2/representations.rb deleted file mode 100644 index 01483f371..000000000 --- a/generated/google/apis/tagmanager_v2/representations.rb +++ /dev/null @@ -1,1092 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'date' -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module TagmanagerV2 - - class Account - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class AccountAccess - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class BuiltInVariable - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Client - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Condition - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Container - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ContainerAccess - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ContainerVersion - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ContainerVersionHeader - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CreateBuiltInVariableResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CreateContainerVersionRequestVersionOptions - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CreateContainerVersionResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class CustomTemplate - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Entity - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Environment - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Folder - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class FolderEntities - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GalleryReference - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class GetWorkspaceStatusResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListAccountsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListContainerVersionsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListContainersResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListEnabledBuiltInVariablesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListEnvironmentsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListFoldersResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListTagsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListTemplatesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListTriggersResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListUserPermissionsResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListVariablesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListWorkspacesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ListZonesResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class MergeConflict - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Parameter - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class PublishContainerVersionResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class QuickPreviewResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RevertBuiltInVariableResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RevertFolderResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RevertTagResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RevertTemplateResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RevertTriggerResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RevertVariableResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class RevertZoneResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SetupTag - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SyncStatus - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class SyncWorkspaceResponse - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Tag - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class TeardownTag - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Trigger - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class UserPermission - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Variable - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class VariableFormatValue - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Workspace - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Zone - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ZoneBoundary - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ZoneChildContainer - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class ZoneTypeRestriction - class Representation < Google::Apis::Core::JsonRepresentation; end - - include Google::Apis::Core::JsonObjectSupport - end - - class Account - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :fingerprint, as: 'fingerprint' - property :name, as: 'name' - property :path, as: 'path' - property :share_data, as: 'shareData' - property :tag_manager_url, as: 'tagManagerUrl' - end - end - - class AccountAccess - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :permission, as: 'permission' - end - end - - class BuiltInVariable - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :container_id, as: 'containerId' - property :name, as: 'name' - property :path, as: 'path' - property :type, as: 'type' - property :workspace_id, as: 'workspaceId' - end - end - - class Client - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :client_id, as: 'clientId' - property :container_id, as: 'containerId' - property :fingerprint, as: 'fingerprint' - property :name, as: 'name' - collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :parent_folder_id, as: 'parentFolderId' - property :path, as: 'path' - property :priority, as: 'priority' - property :tag_manager_url, as: 'tagManagerUrl' - property :type, as: 'type' - property :workspace_id, as: 'workspaceId' - end - end - - class Condition - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :type, as: 'type' - end - end - - class Container - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :container_id, as: 'containerId' - collection :domain_name, as: 'domainName' - property :fingerprint, as: 'fingerprint' - property :name, as: 'name' - property :notes, as: 'notes' - property :path, as: 'path' - property :public_id, as: 'publicId' - property :tag_manager_url, as: 'tagManagerUrl' - collection :usage_context, as: 'usageContext' - end - end - - class ContainerAccess - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :container_id, as: 'containerId' - property :permission, as: 'permission' - end - end - - class ContainerVersion - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - collection :built_in_variable, as: 'builtInVariable', class: Google::Apis::TagmanagerV2::BuiltInVariable, decorator: Google::Apis::TagmanagerV2::BuiltInVariable::Representation - - collection :client, as: 'client', class: Google::Apis::TagmanagerV2::Client, decorator: Google::Apis::TagmanagerV2::Client::Representation - - property :container, as: 'container', class: Google::Apis::TagmanagerV2::Container, decorator: Google::Apis::TagmanagerV2::Container::Representation - - property :container_id, as: 'containerId' - property :container_version_id, as: 'containerVersionId' - collection :custom_template, as: 'customTemplate', class: Google::Apis::TagmanagerV2::CustomTemplate, decorator: Google::Apis::TagmanagerV2::CustomTemplate::Representation - - property :deleted, as: 'deleted' - property :description, as: 'description' - property :fingerprint, as: 'fingerprint' - collection :folder, as: 'folder', class: Google::Apis::TagmanagerV2::Folder, decorator: Google::Apis::TagmanagerV2::Folder::Representation - - property :name, as: 'name' - property :path, as: 'path' - collection :tag, as: 'tag', class: Google::Apis::TagmanagerV2::Tag, decorator: Google::Apis::TagmanagerV2::Tag::Representation - - property :tag_manager_url, as: 'tagManagerUrl' - collection :trigger, as: 'trigger', class: Google::Apis::TagmanagerV2::Trigger, decorator: Google::Apis::TagmanagerV2::Trigger::Representation - - collection :variable, as: 'variable', class: Google::Apis::TagmanagerV2::Variable, decorator: Google::Apis::TagmanagerV2::Variable::Representation - - collection :zone, as: 'zone', class: Google::Apis::TagmanagerV2::Zone, decorator: Google::Apis::TagmanagerV2::Zone::Representation - - end - end - - class ContainerVersionHeader - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :container_id, as: 'containerId' - property :container_version_id, as: 'containerVersionId' - property :deleted, as: 'deleted' - property :name, as: 'name' - property :num_custom_templates, as: 'numCustomTemplates' - property :num_macros, as: 'numMacros' - property :num_rules, as: 'numRules' - property :num_tags, as: 'numTags' - property :num_triggers, as: 'numTriggers' - property :num_variables, as: 'numVariables' - property :num_zones, as: 'numZones' - property :path, as: 'path' - end - end - - class CreateBuiltInVariableResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :built_in_variable, as: 'builtInVariable', class: Google::Apis::TagmanagerV2::BuiltInVariable, decorator: Google::Apis::TagmanagerV2::BuiltInVariable::Representation - - end - end - - class CreateContainerVersionRequestVersionOptions - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :name, as: 'name' - property :notes, as: 'notes' - end - end - - class CreateContainerVersionResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :compiler_error, as: 'compilerError' - property :container_version, as: 'containerVersion', class: Google::Apis::TagmanagerV2::ContainerVersion, decorator: Google::Apis::TagmanagerV2::ContainerVersion::Representation - - property :new_workspace_path, as: 'newWorkspacePath' - property :sync_status, as: 'syncStatus', class: Google::Apis::TagmanagerV2::SyncStatus, decorator: Google::Apis::TagmanagerV2::SyncStatus::Representation - - end - end - - class CustomTemplate - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :container_id, as: 'containerId' - property :fingerprint, as: 'fingerprint' - property :gallery_reference, as: 'galleryReference', class: Google::Apis::TagmanagerV2::GalleryReference, decorator: Google::Apis::TagmanagerV2::GalleryReference::Representation - - property :name, as: 'name' - property :path, as: 'path' - property :tag_manager_url, as: 'tagManagerUrl' - property :template_data, as: 'templateData' - property :template_id, as: 'templateId' - property :workspace_id, as: 'workspaceId' - end - end - - class Entity - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :change_status, as: 'changeStatus' - property :folder, as: 'folder', class: Google::Apis::TagmanagerV2::Folder, decorator: Google::Apis::TagmanagerV2::Folder::Representation - - property :tag, as: 'tag', class: Google::Apis::TagmanagerV2::Tag, decorator: Google::Apis::TagmanagerV2::Tag::Representation - - property :trigger, as: 'trigger', class: Google::Apis::TagmanagerV2::Trigger, decorator: Google::Apis::TagmanagerV2::Trigger::Representation - - property :variable, as: 'variable', class: Google::Apis::TagmanagerV2::Variable, decorator: Google::Apis::TagmanagerV2::Variable::Representation - - end - end - - class Environment - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :authorization_code, as: 'authorizationCode' - property :authorization_timestamp, as: 'authorizationTimestamp' - property :container_id, as: 'containerId' - property :container_version_id, as: 'containerVersionId' - property :description, as: 'description' - property :enable_debug, as: 'enableDebug' - property :environment_id, as: 'environmentId' - property :fingerprint, as: 'fingerprint' - property :name, as: 'name' - property :path, as: 'path' - property :tag_manager_url, as: 'tagManagerUrl' - property :type, as: 'type' - property :url, as: 'url' - property :workspace_id, as: 'workspaceId' - end - end - - class Folder - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :container_id, as: 'containerId' - property :fingerprint, as: 'fingerprint' - property :folder_id, as: 'folderId' - property :name, as: 'name' - property :notes, as: 'notes' - property :path, as: 'path' - property :tag_manager_url, as: 'tagManagerUrl' - property :workspace_id, as: 'workspaceId' - end - end - - class FolderEntities - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :tag, as: 'tag', class: Google::Apis::TagmanagerV2::Tag, decorator: Google::Apis::TagmanagerV2::Tag::Representation - - collection :trigger, as: 'trigger', class: Google::Apis::TagmanagerV2::Trigger, decorator: Google::Apis::TagmanagerV2::Trigger::Representation - - collection :variable, as: 'variable', class: Google::Apis::TagmanagerV2::Variable, decorator: Google::Apis::TagmanagerV2::Variable::Representation - - end - end - - class GalleryReference - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :host, as: 'host' - property :is_modified, as: 'isModified' - property :owner, as: 'owner' - property :repository, as: 'repository' - property :signature, as: 'signature' - property :version, as: 'version' - end - end - - class GetWorkspaceStatusResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :merge_conflict, as: 'mergeConflict', class: Google::Apis::TagmanagerV2::MergeConflict, decorator: Google::Apis::TagmanagerV2::MergeConflict::Representation - - collection :workspace_change, as: 'workspaceChange', class: Google::Apis::TagmanagerV2::Entity, decorator: Google::Apis::TagmanagerV2::Entity::Representation - - end - end - - class ListAccountsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :account, as: 'account', class: Google::Apis::TagmanagerV2::Account, decorator: Google::Apis::TagmanagerV2::Account::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class ListContainerVersionsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :container_version_header, as: 'containerVersionHeader', class: Google::Apis::TagmanagerV2::ContainerVersionHeader, decorator: Google::Apis::TagmanagerV2::ContainerVersionHeader::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class ListContainersResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :container, as: 'container', class: Google::Apis::TagmanagerV2::Container, decorator: Google::Apis::TagmanagerV2::Container::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class ListEnabledBuiltInVariablesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :built_in_variable, as: 'builtInVariable', class: Google::Apis::TagmanagerV2::BuiltInVariable, decorator: Google::Apis::TagmanagerV2::BuiltInVariable::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class ListEnvironmentsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :environment, as: 'environment', class: Google::Apis::TagmanagerV2::Environment, decorator: Google::Apis::TagmanagerV2::Environment::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class ListFoldersResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :folder, as: 'folder', class: Google::Apis::TagmanagerV2::Folder, decorator: Google::Apis::TagmanagerV2::Folder::Representation - - property :next_page_token, as: 'nextPageToken' - end - end - - class ListTagsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :tag, as: 'tag', class: Google::Apis::TagmanagerV2::Tag, decorator: Google::Apis::TagmanagerV2::Tag::Representation - - end - end - - class ListTemplatesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :template, as: 'template', class: Google::Apis::TagmanagerV2::CustomTemplate, decorator: Google::Apis::TagmanagerV2::CustomTemplate::Representation - - end - end - - class ListTriggersResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :trigger, as: 'trigger', class: Google::Apis::TagmanagerV2::Trigger, decorator: Google::Apis::TagmanagerV2::Trigger::Representation - - end - end - - class ListUserPermissionsResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :user_permission, as: 'userPermission', class: Google::Apis::TagmanagerV2::UserPermission, decorator: Google::Apis::TagmanagerV2::UserPermission::Representation - - end - end - - class ListVariablesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :variable, as: 'variable', class: Google::Apis::TagmanagerV2::Variable, decorator: Google::Apis::TagmanagerV2::Variable::Representation - - end - end - - class ListWorkspacesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :workspace, as: 'workspace', class: Google::Apis::TagmanagerV2::Workspace, decorator: Google::Apis::TagmanagerV2::Workspace::Representation - - end - end - - class ListZonesResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :next_page_token, as: 'nextPageToken' - collection :zone, as: 'zone', class: Google::Apis::TagmanagerV2::Zone, decorator: Google::Apis::TagmanagerV2::Zone::Representation - - end - end - - class MergeConflict - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :entity_in_base_version, as: 'entityInBaseVersion', class: Google::Apis::TagmanagerV2::Entity, decorator: Google::Apis::TagmanagerV2::Entity::Representation - - property :entity_in_workspace, as: 'entityInWorkspace', class: Google::Apis::TagmanagerV2::Entity, decorator: Google::Apis::TagmanagerV2::Entity::Representation - - end - end - - class Parameter - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :key, as: 'key' - collection :list, as: 'list', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - collection :map, as: 'map', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :type, as: 'type' - property :value, as: 'value' - end - end - - class PublishContainerVersionResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :compiler_error, as: 'compilerError' - property :container_version, as: 'containerVersion', class: Google::Apis::TagmanagerV2::ContainerVersion, decorator: Google::Apis::TagmanagerV2::ContainerVersion::Representation - - end - end - - class QuickPreviewResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :compiler_error, as: 'compilerError' - property :container_version, as: 'containerVersion', class: Google::Apis::TagmanagerV2::ContainerVersion, decorator: Google::Apis::TagmanagerV2::ContainerVersion::Representation - - property :sync_status, as: 'syncStatus', class: Google::Apis::TagmanagerV2::SyncStatus, decorator: Google::Apis::TagmanagerV2::SyncStatus::Representation - - end - end - - class RevertBuiltInVariableResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :enabled, as: 'enabled' - end - end - - class RevertFolderResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :folder, as: 'folder', class: Google::Apis::TagmanagerV2::Folder, decorator: Google::Apis::TagmanagerV2::Folder::Representation - - end - end - - class RevertTagResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :tag, as: 'tag', class: Google::Apis::TagmanagerV2::Tag, decorator: Google::Apis::TagmanagerV2::Tag::Representation - - end - end - - class RevertTemplateResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :template, as: 'template', class: Google::Apis::TagmanagerV2::CustomTemplate, decorator: Google::Apis::TagmanagerV2::CustomTemplate::Representation - - end - end - - class RevertTriggerResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :trigger, as: 'trigger', class: Google::Apis::TagmanagerV2::Trigger, decorator: Google::Apis::TagmanagerV2::Trigger::Representation - - end - end - - class RevertVariableResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :variable, as: 'variable', class: Google::Apis::TagmanagerV2::Variable, decorator: Google::Apis::TagmanagerV2::Variable::Representation - - end - end - - class RevertZoneResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :zone, as: 'zone', class: Google::Apis::TagmanagerV2::Zone, decorator: Google::Apis::TagmanagerV2::Zone::Representation - - end - end - - class SetupTag - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :stop_on_setup_failure, as: 'stopOnSetupFailure' - property :tag_name, as: 'tagName' - end - end - - class SyncStatus - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :merge_conflict, as: 'mergeConflict' - property :sync_error, as: 'syncError' - end - end - - class SyncWorkspaceResponse - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :merge_conflict, as: 'mergeConflict', class: Google::Apis::TagmanagerV2::MergeConflict, decorator: Google::Apis::TagmanagerV2::MergeConflict::Representation - - property :sync_status, as: 'syncStatus', class: Google::Apis::TagmanagerV2::SyncStatus, decorator: Google::Apis::TagmanagerV2::SyncStatus::Representation - - end - end - - class Tag - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - collection :blocking_rule_id, as: 'blockingRuleId' - collection :blocking_trigger_id, as: 'blockingTriggerId' - property :container_id, as: 'containerId' - property :fingerprint, as: 'fingerprint' - collection :firing_rule_id, as: 'firingRuleId' - collection :firing_trigger_id, as: 'firingTriggerId' - property :live_only, as: 'liveOnly' - property :monitoring_metadata, as: 'monitoringMetadata', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :monitoring_metadata_tag_name_key, as: 'monitoringMetadataTagNameKey' - property :name, as: 'name' - property :notes, as: 'notes' - collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :parent_folder_id, as: 'parentFolderId' - property :path, as: 'path' - property :paused, as: 'paused' - property :priority, as: 'priority', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :schedule_end_ms, :numeric_string => true, as: 'scheduleEndMs' - property :schedule_start_ms, :numeric_string => true, as: 'scheduleStartMs' - collection :setup_tag, as: 'setupTag', class: Google::Apis::TagmanagerV2::SetupTag, decorator: Google::Apis::TagmanagerV2::SetupTag::Representation - - property :tag_firing_option, as: 'tagFiringOption' - property :tag_id, as: 'tagId' - property :tag_manager_url, as: 'tagManagerUrl' - collection :teardown_tag, as: 'teardownTag', class: Google::Apis::TagmanagerV2::TeardownTag, decorator: Google::Apis::TagmanagerV2::TeardownTag::Representation - - property :type, as: 'type' - property :workspace_id, as: 'workspaceId' - end - end - - class TeardownTag - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :stop_teardown_on_failure, as: 'stopTeardownOnFailure' - property :tag_name, as: 'tagName' - end - end - - class Trigger - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - collection :auto_event_filter, as: 'autoEventFilter', class: Google::Apis::TagmanagerV2::Condition, decorator: Google::Apis::TagmanagerV2::Condition::Representation - - property :check_validation, as: 'checkValidation', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :container_id, as: 'containerId' - property :continuous_time_min_milliseconds, as: 'continuousTimeMinMilliseconds', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - collection :custom_event_filter, as: 'customEventFilter', class: Google::Apis::TagmanagerV2::Condition, decorator: Google::Apis::TagmanagerV2::Condition::Representation - - property :event_name, as: 'eventName', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - collection :filter, as: 'filter', class: Google::Apis::TagmanagerV2::Condition, decorator: Google::Apis::TagmanagerV2::Condition::Representation - - property :fingerprint, as: 'fingerprint' - property :horizontal_scroll_percentage_list, as: 'horizontalScrollPercentageList', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :interval, as: 'interval', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :interval_seconds, as: 'intervalSeconds', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :limit, as: 'limit', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :max_timer_length_seconds, as: 'maxTimerLengthSeconds', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :name, as: 'name' - property :notes, as: 'notes' - collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :parent_folder_id, as: 'parentFolderId' - property :path, as: 'path' - property :selector, as: 'selector', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :tag_manager_url, as: 'tagManagerUrl' - property :total_time_min_milliseconds, as: 'totalTimeMinMilliseconds', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :trigger_id, as: 'triggerId' - property :type, as: 'type' - property :unique_trigger_id, as: 'uniqueTriggerId', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :vertical_scroll_percentage_list, as: 'verticalScrollPercentageList', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :visibility_selector, as: 'visibilitySelector', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :visible_percentage_max, as: 'visiblePercentageMax', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :visible_percentage_min, as: 'visiblePercentageMin', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :wait_for_tags, as: 'waitForTags', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :wait_for_tags_timeout, as: 'waitForTagsTimeout', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :workspace_id, as: 'workspaceId' - end - end - - class UserPermission - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_access, as: 'accountAccess', class: Google::Apis::TagmanagerV2::AccountAccess, decorator: Google::Apis::TagmanagerV2::AccountAccess::Representation - - property :account_id, as: 'accountId' - collection :container_access, as: 'containerAccess', class: Google::Apis::TagmanagerV2::ContainerAccess, decorator: Google::Apis::TagmanagerV2::ContainerAccess::Representation - - property :email_address, as: 'emailAddress' - property :path, as: 'path' - end - end - - class Variable - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :container_id, as: 'containerId' - collection :disabling_trigger_id, as: 'disablingTriggerId' - collection :enabling_trigger_id, as: 'enablingTriggerId' - property :fingerprint, as: 'fingerprint' - property :format_value, as: 'formatValue', class: Google::Apis::TagmanagerV2::VariableFormatValue, decorator: Google::Apis::TagmanagerV2::VariableFormatValue::Representation - - property :name, as: 'name' - property :notes, as: 'notes' - collection :parameter, as: 'parameter', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :parent_folder_id, as: 'parentFolderId' - property :path, as: 'path' - property :schedule_end_ms, :numeric_string => true, as: 'scheduleEndMs' - property :schedule_start_ms, :numeric_string => true, as: 'scheduleStartMs' - property :tag_manager_url, as: 'tagManagerUrl' - property :type, as: 'type' - property :variable_id, as: 'variableId' - property :workspace_id, as: 'workspaceId' - end - end - - class VariableFormatValue - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :case_conversion_type, as: 'caseConversionType' - property :convert_false_to_value, as: 'convertFalseToValue', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :convert_null_to_value, as: 'convertNullToValue', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :convert_true_to_value, as: 'convertTrueToValue', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - property :convert_undefined_to_value, as: 'convertUndefinedToValue', class: Google::Apis::TagmanagerV2::Parameter, decorator: Google::Apis::TagmanagerV2::Parameter::Representation - - end - end - - class Workspace - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :container_id, as: 'containerId' - property :description, as: 'description' - property :fingerprint, as: 'fingerprint' - property :name, as: 'name' - property :path, as: 'path' - property :tag_manager_url, as: 'tagManagerUrl' - property :workspace_id, as: 'workspaceId' - end - end - - class Zone - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :account_id, as: 'accountId' - property :boundary, as: 'boundary', class: Google::Apis::TagmanagerV2::ZoneBoundary, decorator: Google::Apis::TagmanagerV2::ZoneBoundary::Representation - - collection :child_container, as: 'childContainer', class: Google::Apis::TagmanagerV2::ZoneChildContainer, decorator: Google::Apis::TagmanagerV2::ZoneChildContainer::Representation - - property :container_id, as: 'containerId' - property :fingerprint, as: 'fingerprint' - property :name, as: 'name' - property :notes, as: 'notes' - property :path, as: 'path' - property :tag_manager_url, as: 'tagManagerUrl' - property :type_restriction, as: 'typeRestriction', class: Google::Apis::TagmanagerV2::ZoneTypeRestriction, decorator: Google::Apis::TagmanagerV2::ZoneTypeRestriction::Representation - - property :workspace_id, as: 'workspaceId' - property :zone_id, as: 'zoneId' - end - end - - class ZoneBoundary - # @private - class Representation < Google::Apis::Core::JsonRepresentation - collection :condition, as: 'condition', class: Google::Apis::TagmanagerV2::Condition, decorator: Google::Apis::TagmanagerV2::Condition::Representation - - collection :custom_evaluation_trigger_id, as: 'customEvaluationTriggerId' - end - end - - class ZoneChildContainer - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :nickname, as: 'nickname' - property :public_id, as: 'publicId' - end - end - - class ZoneTypeRestriction - # @private - class Representation < Google::Apis::Core::JsonRepresentation - property :enable, as: 'enable' - collection :whitelisted_type_id, as: 'whitelistedTypeId' - end - end - end - end -end diff --git a/generated/google/apis/tagmanager_v2/service.rb b/generated/google/apis/tagmanager_v2/service.rb deleted file mode 100644 index f581b8253..000000000 --- a/generated/google/apis/tagmanager_v2/service.rb +++ /dev/null @@ -1,2730 +0,0 @@ -# Copyright 2015 Google Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -require 'google/apis/core/base_service' -require 'google/apis/core/json_representation' -require 'google/apis/core/hashable' -require 'google/apis/errors' - -module Google - module Apis - module TagmanagerV2 - # Tag Manager API - # - # This API allows clients to access and modify container and tag configuration. - # - # @example - # require 'google/apis/tagmanager_v2' - # - # Tagmanager = Google::Apis::TagmanagerV2 # Alias the module - # service = Tagmanager::TagManagerService.new - # - # @see https://developers.google.com/tag-manager - class TagManagerService < Google::Apis::Core::BaseService - # @return [String] - # API key. Your API key identifies your project and provides you with API access, - # quota, and reports. Required unless you provide an OAuth 2.0 token. - attr_accessor :key - - # @return [String] - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - attr_accessor :quota_user - - def initialize - super('https://www.googleapis.com/', '') - @batch_path = 'batch/tagmanager/v2' - end - - # Gets a GTM Account. - # @param [String] path - # GTM Accounts's API relative path. Example: accounts/`account_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Account] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Account] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+path}', options) - command.response_representation = Google::Apis::TagmanagerV2::Account::Representation - command.response_class = Google::Apis::TagmanagerV2::Account - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all GTM Accounts that a user has access to. - # @param [String] page_token - # Continuation token for fetching the next page of results. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ListAccountsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ListAccountsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_accounts(page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/accounts', options) - command.response_representation = Google::Apis::TagmanagerV2::ListAccountsResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::ListAccountsResponse - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a GTM Account. - # @param [String] path - # GTM Accounts's API relative path. Example: accounts/`account_id` - # @param [Google::Apis::TagmanagerV2::Account] account_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the account in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Account] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Account] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account(path, account_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v2/{+path}', options) - command.request_representation = Google::Apis::TagmanagerV2::Account::Representation - command.request_object = account_object - command.response_representation = Google::Apis::TagmanagerV2::Account::Representation - command.response_class = Google::Apis::TagmanagerV2::Account - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a Container. - # @param [String] parent - # GTM Account's API relative path. Example: accounts/`account_id`. - # @param [Google::Apis::TagmanagerV2::Container] container_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Container] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Container] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_account_container(parent, container_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+parent}/containers', options) - command.request_representation = Google::Apis::TagmanagerV2::Container::Representation - command.request_object = container_object - command.response_representation = Google::Apis::TagmanagerV2::Container::Representation - command.response_class = Google::Apis::TagmanagerV2::Container - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a Container. - # @param [String] path - # GTM Container's API relative path. Example: accounts/`account_id`/containers/` - # container_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_account_container(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v2/{+path}', options) - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a Container. - # @param [String] path - # GTM Container's API relative path. Example: accounts/`account_id`/containers/` - # container_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Container] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Container] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_container(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+path}', options) - command.response_representation = Google::Apis::TagmanagerV2::Container::Representation - command.response_class = Google::Apis::TagmanagerV2::Container - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all Containers that belongs to a GTM Account. - # @param [String] parent - # GTM Accounts's API relative path. Example: accounts/`account_id`. - # @param [String] page_token - # Continuation token for fetching the next page of results. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ListContainersResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ListContainersResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_containers(parent, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+parent}/containers', options) - command.response_representation = Google::Apis::TagmanagerV2::ListContainersResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::ListContainersResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a Container. - # @param [String] path - # GTM Container's API relative path. Example: accounts/`account_id`/containers/` - # container_id` - # @param [Google::Apis::TagmanagerV2::Container] container_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the container in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Container] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Container] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account_container(path, container_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v2/{+path}', options) - command.request_representation = Google::Apis::TagmanagerV2::Container::Representation - command.request_object = container_object - command.response_representation = Google::Apis::TagmanagerV2::Container::Representation - command.response_class = Google::Apis::TagmanagerV2::Container - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a GTM Environment. - # @param [String] parent - # GTM Container's API relative path. Example: accounts/`account_id`/containers/` - # container_id` - # @param [Google::Apis::TagmanagerV2::Environment] environment_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Environment] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Environment] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_account_container_environment(parent, environment_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+parent}/environments', options) - command.request_representation = Google::Apis::TagmanagerV2::Environment::Representation - command.request_object = environment_object - command.response_representation = Google::Apis::TagmanagerV2::Environment::Representation - command.response_class = Google::Apis::TagmanagerV2::Environment - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a GTM Environment. - # @param [String] path - # GTM Environment's API relative path. Example: accounts/`account_id`/containers/ - # `container_id`/environments/`environment_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_account_container_environment(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v2/{+path}', options) - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a GTM Environment. - # @param [String] path - # GTM Environment's API relative path. Example: accounts/`account_id`/containers/ - # `container_id`/environments/`environment_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Environment] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Environment] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_container_environment(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+path}', options) - command.response_representation = Google::Apis::TagmanagerV2::Environment::Representation - command.response_class = Google::Apis::TagmanagerV2::Environment - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all GTM Environments of a GTM Container. - # @param [String] parent - # GTM Container's API relative path. Example: accounts/`account_id`/containers/` - # container_id` - # @param [String] page_token - # Continuation token for fetching the next page of results. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ListEnvironmentsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ListEnvironmentsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_container_environments(parent, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+parent}/environments', options) - command.response_representation = Google::Apis::TagmanagerV2::ListEnvironmentsResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::ListEnvironmentsResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Re-generates the authorization code for a GTM Environment. - # @param [String] path - # GTM Environment's API relative path. Example: accounts/`account_id`/containers/ - # `container_id`/environments/`environment_id` - # @param [Google::Apis::TagmanagerV2::Environment] environment_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Environment] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Environment] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def reauthorize_account_container_environment(path, environment_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:reauthorize', options) - command.request_representation = Google::Apis::TagmanagerV2::Environment::Representation - command.request_object = environment_object - command.response_representation = Google::Apis::TagmanagerV2::Environment::Representation - command.response_class = Google::Apis::TagmanagerV2::Environment - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a GTM Environment. - # @param [String] path - # GTM Environment's API relative path. Example: accounts/`account_id`/containers/ - # `container_id`/environments/`environment_id` - # @param [Google::Apis::TagmanagerV2::Environment] environment_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the environment - # in storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Environment] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Environment] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account_container_environment(path, environment_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v2/{+path}', options) - command.request_representation = Google::Apis::TagmanagerV2::Environment::Representation - command.request_object = environment_object - command.response_representation = Google::Apis::TagmanagerV2::Environment::Representation - command.response_class = Google::Apis::TagmanagerV2::Environment - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets the latest container version header - # @param [String] parent - # GTM Container's API relative path. Example: accounts/`account_id`/containers/` - # container_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ContainerVersionHeader] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ContainerVersionHeader] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def latest_account_container_version_header(parent, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+parent}/version_headers:latest', options) - command.response_representation = Google::Apis::TagmanagerV2::ContainerVersionHeader::Representation - command.response_class = Google::Apis::TagmanagerV2::ContainerVersionHeader - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all Container Versions of a GTM Container. - # @param [String] parent - # GTM Container's API relative path. Example: accounts/`account_id`/containers/` - # container_id` - # @param [Boolean] include_deleted - # Also retrieve deleted (archived) versions when true. - # @param [String] page_token - # Continuation token for fetching the next page of results. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ListContainerVersionsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ListContainerVersionsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_container_version_headers(parent, include_deleted: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+parent}/version_headers', options) - command.response_representation = Google::Apis::TagmanagerV2::ListContainerVersionsResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::ListContainerVersionsResponse - command.params['parent'] = parent unless parent.nil? - command.query['includeDeleted'] = include_deleted unless include_deleted.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a Container Version. - # @param [String] path - # GTM ContainerVersion's API relative path. Example: accounts/`account_id`/ - # containers/`container_id`/versions/`version_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_account_container_version(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v2/{+path}', options) - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a Container Version. - # @param [String] path - # GTM ContainerVersion's API relative path. Example: accounts/`account_id`/ - # containers/`container_id`/versions/`version_id` - # @param [String] container_version_id - # The GTM ContainerVersion ID. Specify published to retrieve the currently - # published version. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ContainerVersion] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ContainerVersion] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_container_version(path, container_version_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+path}', options) - command.response_representation = Google::Apis::TagmanagerV2::ContainerVersion::Representation - command.response_class = Google::Apis::TagmanagerV2::ContainerVersion - command.params['path'] = path unless path.nil? - command.query['containerVersionId'] = container_version_id unless container_version_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets the live (i.e. published) container version - # @param [String] parent - # GTM Container's API relative path. Example: accounts/`account_id`/containers/` - # container_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ContainerVersion] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ContainerVersion] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def live_account_container_version(parent, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+parent}/versions:live', options) - command.response_representation = Google::Apis::TagmanagerV2::ContainerVersion::Representation - command.response_class = Google::Apis::TagmanagerV2::ContainerVersion - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Publishes a Container Version. - # @param [String] path - # GTM ContainerVersion's API relative path. Example: accounts/`account_id`/ - # containers/`container_id`/versions/`version_id` - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the container - # version in storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::PublishContainerVersionResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::PublishContainerVersionResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def publish_account_container_version(path, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:publish', options) - command.response_representation = Google::Apis::TagmanagerV2::PublishContainerVersionResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::PublishContainerVersionResponse - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Sets the latest version used for synchronization of workspaces when detecting - # conflicts and errors. - # @param [String] path - # GTM ContainerVersion's API relative path. Example: accounts/`account_id`/ - # containers/`container_id`/versions/`version_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ContainerVersion] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ContainerVersion] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def set_account_container_version_latest(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:set_latest', options) - command.response_representation = Google::Apis::TagmanagerV2::ContainerVersion::Representation - command.response_class = Google::Apis::TagmanagerV2::ContainerVersion - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Undeletes a Container Version. - # @param [String] path - # GTM ContainerVersion's API relative path. Example: accounts/`account_id`/ - # containers/`container_id`/versions/`version_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ContainerVersion] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ContainerVersion] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def undelete_account_container_version(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:undelete', options) - command.response_representation = Google::Apis::TagmanagerV2::ContainerVersion::Representation - command.response_class = Google::Apis::TagmanagerV2::ContainerVersion - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a Container Version. - # @param [String] path - # GTM ContainerVersion's API relative path. Example: accounts/`account_id`/ - # containers/`container_id`/versions/`version_id` - # @param [Google::Apis::TagmanagerV2::ContainerVersion] container_version_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the container - # version in storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ContainerVersion] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ContainerVersion] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account_container_version(path, container_version_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v2/{+path}', options) - command.request_representation = Google::Apis::TagmanagerV2::ContainerVersion::Representation - command.request_object = container_version_object - command.response_representation = Google::Apis::TagmanagerV2::ContainerVersion::Representation - command.response_class = Google::Apis::TagmanagerV2::ContainerVersion - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a Workspace. - # @param [String] parent - # GTM parent Container's API relative path. Example: accounts/`account_id`/ - # containers/`container_id` - # @param [Google::Apis::TagmanagerV2::Workspace] workspace_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Workspace] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Workspace] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_account_container_workspace(parent, workspace_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+parent}/workspaces', options) - command.request_representation = Google::Apis::TagmanagerV2::Workspace::Representation - command.request_object = workspace_object - command.response_representation = Google::Apis::TagmanagerV2::Workspace::Representation - command.response_class = Google::Apis::TagmanagerV2::Workspace - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a Container Version from the entities present in the workspace, - # deletes the workspace, and sets the base container version to the newly - # created version. - # @param [String] path - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [Google::Apis::TagmanagerV2::CreateContainerVersionRequestVersionOptions] create_container_version_request_version_options_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::CreateContainerVersionResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::CreateContainerVersionResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_account_container_workspace_version(path, create_container_version_request_version_options_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:create_version', options) - command.request_representation = Google::Apis::TagmanagerV2::CreateContainerVersionRequestVersionOptions::Representation - command.request_object = create_container_version_request_version_options_object - command.response_representation = Google::Apis::TagmanagerV2::CreateContainerVersionResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::CreateContainerVersionResponse - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a Workspace. - # @param [String] path - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_account_container_workspace(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v2/{+path}', options) - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a Workspace. - # @param [String] path - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Workspace] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Workspace] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_container_workspace(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+path}', options) - command.response_representation = Google::Apis::TagmanagerV2::Workspace::Representation - command.response_class = Google::Apis::TagmanagerV2::Workspace - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Finds conflicting and modified entities in the workspace. - # @param [String] path - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::GetWorkspaceStatusResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::GetWorkspaceStatusResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_container_workspace_status(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+path}/status', options) - command.response_representation = Google::Apis::TagmanagerV2::GetWorkspaceStatusResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::GetWorkspaceStatusResponse - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all Workspaces that belong to a GTM Container. - # @param [String] parent - # GTM parent Container's API relative path. Example: accounts/`account_id`/ - # containers/`container_id` - # @param [String] page_token - # Continuation token for fetching the next page of results. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ListWorkspacesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ListWorkspacesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_container_workspaces(parent, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+parent}/workspaces', options) - command.response_representation = Google::Apis::TagmanagerV2::ListWorkspacesResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::ListWorkspacesResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Quick previews a workspace by creating a fake container version from all - # entities in the provided workspace. - # @param [String] path - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::QuickPreviewResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::QuickPreviewResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def quick_account_container_workspace_preview(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:quick_preview', options) - command.response_representation = Google::Apis::TagmanagerV2::QuickPreviewResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::QuickPreviewResponse - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Resolves a merge conflict for a workspace entity by updating it to the - # resolved entity passed in the request. - # @param [String] path - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [Google::Apis::TagmanagerV2::Entity] entity_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the - # entity_in_workspace in the merge conflict. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def resolve_account_container_workspace_conflict(path, entity_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:resolve_conflict', options) - command.request_representation = Google::Apis::TagmanagerV2::Entity::Representation - command.request_object = entity_object - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Syncs a workspace to the latest container version by updating all unmodified - # workspace entities and displaying conflicts for modified entities. - # @param [String] path - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::SyncWorkspaceResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::SyncWorkspaceResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def sync_account_container_workspace(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:sync', options) - command.response_representation = Google::Apis::TagmanagerV2::SyncWorkspaceResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::SyncWorkspaceResponse - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a Workspace. - # @param [String] path - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [Google::Apis::TagmanagerV2::Workspace] workspace_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the workspace in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Workspace] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Workspace] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account_container_workspace(path, workspace_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v2/{+path}', options) - command.request_representation = Google::Apis::TagmanagerV2::Workspace::Representation - command.request_object = workspace_object - command.response_representation = Google::Apis::TagmanagerV2::Workspace::Representation - command.response_class = Google::Apis::TagmanagerV2::Workspace - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates one or more GTM Built-In Variables. - # @param [String] parent - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [Array, String] type - # The types of built-in variables to enable. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::CreateBuiltInVariableResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::CreateBuiltInVariableResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_account_container_workspace_built_in_variable(parent, type: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+parent}/built_in_variables', options) - command.response_representation = Google::Apis::TagmanagerV2::CreateBuiltInVariableResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::CreateBuiltInVariableResponse - command.params['parent'] = parent unless parent.nil? - command.query['type'] = type unless type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes one or more GTM Built-In Variables. - # @param [String] path - # GTM BuiltInVariable's API relative path. Example: accounts/`account_id`/ - # containers/`container_id`/workspaces/`workspace_id`/built_in_variables - # @param [Array, String] type - # The types of built-in variables to delete. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_account_container_workspace_built_in_variable(path, type: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v2/{+path}', options) - command.params['path'] = path unless path.nil? - command.query['type'] = type unless type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all the enabled Built-In Variables of a GTM Container. - # @param [String] parent - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [String] page_token - # Continuation token for fetching the next page of results. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ListEnabledBuiltInVariablesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ListEnabledBuiltInVariablesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_container_workspace_built_in_variables(parent, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+parent}/built_in_variables', options) - command.response_representation = Google::Apis::TagmanagerV2::ListEnabledBuiltInVariablesResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::ListEnabledBuiltInVariablesResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Reverts changes to a GTM Built-In Variables in a GTM Workspace. - # @param [String] path - # GTM BuiltInVariable's API relative path. Example: accounts/`account_id`/ - # containers/`container_id`/workspaces/`workspace_id`/built_in_variables - # @param [String] type - # The type of built-in variable to revert. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::RevertBuiltInVariableResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::RevertBuiltInVariableResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def revert_account_container_workspace_built_in_variable(path, type: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}/built_in_variables:revert', options) - command.response_representation = Google::Apis::TagmanagerV2::RevertBuiltInVariableResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::RevertBuiltInVariableResponse - command.params['path'] = path unless path.nil? - command.query['type'] = type unless type.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a GTM Folder. - # @param [String] parent - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [Google::Apis::TagmanagerV2::Folder] folder_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Folder] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Folder] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_account_container_workspace_folder(parent, folder_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+parent}/folders', options) - command.request_representation = Google::Apis::TagmanagerV2::Folder::Representation - command.request_object = folder_object - command.response_representation = Google::Apis::TagmanagerV2::Folder::Representation - command.response_class = Google::Apis::TagmanagerV2::Folder - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a GTM Folder. - # @param [String] path - # GTM Folder's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/folders/`folder_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_account_container_workspace_folder(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v2/{+path}', options) - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # List all entities in a GTM Folder. - # @param [String] path - # GTM Folder's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/folders/`folder_id` - # @param [String] page_token - # Continuation token for fetching the next page of results. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::FolderEntities] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::FolderEntities] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def entities_account_container_workspace_folder(path, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:entities', options) - command.response_representation = Google::Apis::TagmanagerV2::FolderEntities::Representation - command.response_class = Google::Apis::TagmanagerV2::FolderEntities - command.params['path'] = path unless path.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a GTM Folder. - # @param [String] path - # GTM Folder's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/folders/`folder_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Folder] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Folder] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_container_workspace_folder(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+path}', options) - command.response_representation = Google::Apis::TagmanagerV2::Folder::Representation - command.response_class = Google::Apis::TagmanagerV2::Folder - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all GTM Folders of a Container. - # @param [String] parent - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [String] page_token - # Continuation token for fetching the next page of results. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ListFoldersResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ListFoldersResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_container_workspace_folders(parent, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+parent}/folders', options) - command.response_representation = Google::Apis::TagmanagerV2::ListFoldersResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::ListFoldersResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Moves entities to a GTM Folder. - # @param [String] path - # GTM Folder's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/folders/`folder_id` - # @param [Google::Apis::TagmanagerV2::Folder] folder_object - # @param [Array, String] tag_id - # The tags to be moved to the folder. - # @param [Array, String] trigger_id - # The triggers to be moved to the folder. - # @param [Array, String] variable_id - # The variables to be moved to the folder. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def move_account_container_workspace_folder_entities_to_folder(path, folder_object = nil, tag_id: nil, trigger_id: nil, variable_id: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:move_entities_to_folder', options) - command.request_representation = Google::Apis::TagmanagerV2::Folder::Representation - command.request_object = folder_object - command.params['path'] = path unless path.nil? - command.query['tagId'] = tag_id unless tag_id.nil? - command.query['triggerId'] = trigger_id unless trigger_id.nil? - command.query['variableId'] = variable_id unless variable_id.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Reverts changes to a GTM Folder in a GTM Workspace. - # @param [String] path - # GTM Folder's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/folders/`folder_id` - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the tag in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::RevertFolderResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::RevertFolderResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def revert_account_container_workspace_folder(path, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:revert', options) - command.response_representation = Google::Apis::TagmanagerV2::RevertFolderResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::RevertFolderResponse - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a GTM Folder. - # @param [String] path - # GTM Folder's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/folders/`folder_id` - # @param [Google::Apis::TagmanagerV2::Folder] folder_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the folder in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Folder] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Folder] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account_container_workspace_folder(path, folder_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v2/{+path}', options) - command.request_representation = Google::Apis::TagmanagerV2::Folder::Representation - command.request_object = folder_object - command.response_representation = Google::Apis::TagmanagerV2::Folder::Representation - command.response_class = Google::Apis::TagmanagerV2::Folder - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a GTM Tag. - # @param [String] parent - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [Google::Apis::TagmanagerV2::Tag] tag_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Tag] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Tag] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_account_container_workspace_tag(parent, tag_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+parent}/tags', options) - command.request_representation = Google::Apis::TagmanagerV2::Tag::Representation - command.request_object = tag_object - command.response_representation = Google::Apis::TagmanagerV2::Tag::Representation - command.response_class = Google::Apis::TagmanagerV2::Tag - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a GTM Tag. - # @param [String] path - # GTM Tag's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/tags/`tag_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_account_container_workspace_tag(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v2/{+path}', options) - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a GTM Tag. - # @param [String] path - # GTM Tag's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/tags/`tag_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Tag] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Tag] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_container_workspace_tag(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+path}', options) - command.response_representation = Google::Apis::TagmanagerV2::Tag::Representation - command.response_class = Google::Apis::TagmanagerV2::Tag - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all GTM Tags of a Container. - # @param [String] parent - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [String] page_token - # Continuation token for fetching the next page of results. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ListTagsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ListTagsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_container_workspace_tags(parent, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+parent}/tags', options) - command.response_representation = Google::Apis::TagmanagerV2::ListTagsResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::ListTagsResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Reverts changes to a GTM Tag in a GTM Workspace. - # @param [String] path - # GTM Tag's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/tags/`tag_id` - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of thetag in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::RevertTagResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::RevertTagResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def revert_account_container_workspace_tag(path, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:revert', options) - command.response_representation = Google::Apis::TagmanagerV2::RevertTagResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::RevertTagResponse - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a GTM Tag. - # @param [String] path - # GTM Tag's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/tags/`tag_id` - # @param [Google::Apis::TagmanagerV2::Tag] tag_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the tag in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Tag] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Tag] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account_container_workspace_tag(path, tag_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v2/{+path}', options) - command.request_representation = Google::Apis::TagmanagerV2::Tag::Representation - command.request_object = tag_object - command.response_representation = Google::Apis::TagmanagerV2::Tag::Representation - command.response_class = Google::Apis::TagmanagerV2::Tag - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a GTM Custom Template. - # @param [String] parent - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [Google::Apis::TagmanagerV2::CustomTemplate] custom_template_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::CustomTemplate] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::CustomTemplate] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_account_container_workspace_template(parent, custom_template_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+parent}/templates', options) - command.request_representation = Google::Apis::TagmanagerV2::CustomTemplate::Representation - command.request_object = custom_template_object - command.response_representation = Google::Apis::TagmanagerV2::CustomTemplate::Representation - command.response_class = Google::Apis::TagmanagerV2::CustomTemplate - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a GTM Template. - # @param [String] path - # GTM Custom Template's API relative path. Example: accounts/`account_id`/ - # containers/`container_id`/workspaces/`workspace_id`/templates/`template_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_account_container_workspace_template(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v2/{+path}', options) - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a GTM Template. - # @param [String] path - # GTM Custom Template's API relative path. Example: accounts/`account_id`/ - # containers/`container_id`/workspaces/`workspace_id`/templates/`template_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::CustomTemplate] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::CustomTemplate] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_container_workspace_template(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+path}', options) - command.response_representation = Google::Apis::TagmanagerV2::CustomTemplate::Representation - command.response_class = Google::Apis::TagmanagerV2::CustomTemplate - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all GTM Templates of a GTM container workspace. - # @param [String] parent - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [String] page_token - # Continuation token for fetching the next page of results. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ListTemplatesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ListTemplatesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_container_workspace_templates(parent, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+parent}/templates', options) - command.response_representation = Google::Apis::TagmanagerV2::ListTemplatesResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::ListTemplatesResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Reverts changes to a GTM Template in a GTM Workspace. - # @param [String] path - # GTM Custom Template's API relative path. Example: accounts/`account_id`/ - # containers/`container_id`/workspaces/`workspace_id`/templates/`template_id` - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the template in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::RevertTemplateResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::RevertTemplateResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def revert_account_container_workspace_template(path, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:revert', options) - command.response_representation = Google::Apis::TagmanagerV2::RevertTemplateResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::RevertTemplateResponse - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a GTM Template. - # @param [String] path - # GTM Custom Template's API relative path. Example: accounts/`account_id`/ - # containers/`container_id`/workspaces/`workspace_id`/templates/`template_id` - # @param [Google::Apis::TagmanagerV2::CustomTemplate] custom_template_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the templates in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::CustomTemplate] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::CustomTemplate] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account_container_workspace_template(path, custom_template_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v2/{+path}', options) - command.request_representation = Google::Apis::TagmanagerV2::CustomTemplate::Representation - command.request_object = custom_template_object - command.response_representation = Google::Apis::TagmanagerV2::CustomTemplate::Representation - command.response_class = Google::Apis::TagmanagerV2::CustomTemplate - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a GTM Trigger. - # @param [String] parent - # GTM Workspaces's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [Google::Apis::TagmanagerV2::Trigger] trigger_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Trigger] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Trigger] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_account_container_workspace_trigger(parent, trigger_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+parent}/triggers', options) - command.request_representation = Google::Apis::TagmanagerV2::Trigger::Representation - command.request_object = trigger_object - command.response_representation = Google::Apis::TagmanagerV2::Trigger::Representation - command.response_class = Google::Apis::TagmanagerV2::Trigger - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a GTM Trigger. - # @param [String] path - # GTM Trigger's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/triggers/`trigger_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_account_container_workspace_trigger(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v2/{+path}', options) - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a GTM Trigger. - # @param [String] path - # GTM Trigger's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/triggers/`trigger_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Trigger] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Trigger] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_container_workspace_trigger(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+path}', options) - command.response_representation = Google::Apis::TagmanagerV2::Trigger::Representation - command.response_class = Google::Apis::TagmanagerV2::Trigger - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all GTM Triggers of a Container. - # @param [String] parent - # GTM Workspaces's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [String] page_token - # Continuation token for fetching the next page of results. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ListTriggersResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ListTriggersResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_container_workspace_triggers(parent, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+parent}/triggers', options) - command.response_representation = Google::Apis::TagmanagerV2::ListTriggersResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::ListTriggersResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Reverts changes to a GTM Trigger in a GTM Workspace. - # @param [String] path - # GTM Trigger's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/triggers/`trigger_id` - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the trigger in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::RevertTriggerResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::RevertTriggerResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def revert_account_container_workspace_trigger(path, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:revert', options) - command.response_representation = Google::Apis::TagmanagerV2::RevertTriggerResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::RevertTriggerResponse - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a GTM Trigger. - # @param [String] path - # GTM Trigger's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/triggers/`trigger_id` - # @param [Google::Apis::TagmanagerV2::Trigger] trigger_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the trigger in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Trigger] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Trigger] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account_container_workspace_trigger(path, trigger_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v2/{+path}', options) - command.request_representation = Google::Apis::TagmanagerV2::Trigger::Representation - command.request_object = trigger_object - command.response_representation = Google::Apis::TagmanagerV2::Trigger::Representation - command.response_class = Google::Apis::TagmanagerV2::Trigger - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a GTM Variable. - # @param [String] parent - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [Google::Apis::TagmanagerV2::Variable] variable_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Variable] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Variable] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_account_container_workspace_variable(parent, variable_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+parent}/variables', options) - command.request_representation = Google::Apis::TagmanagerV2::Variable::Representation - command.request_object = variable_object - command.response_representation = Google::Apis::TagmanagerV2::Variable::Representation - command.response_class = Google::Apis::TagmanagerV2::Variable - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a GTM Variable. - # @param [String] path - # GTM Variable's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/variables/`variable_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_account_container_workspace_variable(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v2/{+path}', options) - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a GTM Variable. - # @param [String] path - # GTM Variable's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/variables/`variable_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Variable] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Variable] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_container_workspace_variable(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+path}', options) - command.response_representation = Google::Apis::TagmanagerV2::Variable::Representation - command.response_class = Google::Apis::TagmanagerV2::Variable - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all GTM Variables of a Container. - # @param [String] parent - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [String] page_token - # Continuation token for fetching the next page of results. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ListVariablesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ListVariablesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_container_workspace_variables(parent, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+parent}/variables', options) - command.response_representation = Google::Apis::TagmanagerV2::ListVariablesResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::ListVariablesResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Reverts changes to a GTM Variable in a GTM Workspace. - # @param [String] path - # GTM Variable's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/variables/`variable_id` - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the variable in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::RevertVariableResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::RevertVariableResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def revert_account_container_workspace_variable(path, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:revert', options) - command.response_representation = Google::Apis::TagmanagerV2::RevertVariableResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::RevertVariableResponse - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a GTM Variable. - # @param [String] path - # GTM Variable's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/variables/`variable_id` - # @param [Google::Apis::TagmanagerV2::Variable] variable_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the variable in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Variable] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Variable] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account_container_workspace_variable(path, variable_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v2/{+path}', options) - command.request_representation = Google::Apis::TagmanagerV2::Variable::Representation - command.request_object = variable_object - command.response_representation = Google::Apis::TagmanagerV2::Variable::Representation - command.response_class = Google::Apis::TagmanagerV2::Variable - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a GTM Zone. - # @param [String] parent - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [Google::Apis::TagmanagerV2::Zone] zone_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Zone] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Zone] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_account_container_workspace_zone(parent, zone_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+parent}/zones', options) - command.request_representation = Google::Apis::TagmanagerV2::Zone::Representation - command.request_object = zone_object - command.response_representation = Google::Apis::TagmanagerV2::Zone::Representation - command.response_class = Google::Apis::TagmanagerV2::Zone - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Deletes a GTM Zone. - # @param [String] path - # GTM Zone's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/zones/`zone_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_account_container_workspace_zone(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v2/{+path}', options) - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a GTM Zone. - # @param [String] path - # GTM Zone's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/zones/`zone_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Zone] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Zone] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_container_workspace_zone(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+path}', options) - command.response_representation = Google::Apis::TagmanagerV2::Zone::Representation - command.response_class = Google::Apis::TagmanagerV2::Zone - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Lists all GTM Zones of a GTM container workspace. - # @param [String] parent - # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id` - # @param [String] page_token - # Continuation token for fetching the next page of results. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ListZonesResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ListZonesResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_container_workspace_zones(parent, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+parent}/zones', options) - command.response_representation = Google::Apis::TagmanagerV2::ListZonesResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::ListZonesResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Reverts changes to a GTM Zone in a GTM Workspace. - # @param [String] path - # GTM Zone's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/zones/`zone_id` - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the zone in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::RevertZoneResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::RevertZoneResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def revert_account_container_workspace_zone(path, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+path}:revert', options) - command.response_representation = Google::Apis::TagmanagerV2::RevertZoneResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::RevertZoneResponse - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a GTM Zone. - # @param [String] path - # GTM Zone's API relative path. Example: accounts/`account_id`/containers/` - # container_id`/workspaces/`workspace_id`/zones/`zone_id` - # @param [Google::Apis::TagmanagerV2::Zone] zone_object - # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the zone in - # storage. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::Zone] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::Zone] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account_container_workspace_zone(path, zone_object = nil, fingerprint: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v2/{+path}', options) - command.request_representation = Google::Apis::TagmanagerV2::Zone::Representation - command.request_object = zone_object - command.response_representation = Google::Apis::TagmanagerV2::Zone::Representation - command.response_class = Google::Apis::TagmanagerV2::Zone - command.params['path'] = path unless path.nil? - command.query['fingerprint'] = fingerprint unless fingerprint.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Creates a user's Account & Container access. - # @param [String] parent - # GTM Account's API relative path. Example: accounts/`account_id` - # @param [Google::Apis::TagmanagerV2::UserPermission] user_permission_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::UserPermission] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::UserPermission] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def create_account_user_permission(parent, user_permission_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:post, 'tagmanager/v2/{+parent}/user_permissions', options) - command.request_representation = Google::Apis::TagmanagerV2::UserPermission::Representation - command.request_object = user_permission_object - command.response_representation = Google::Apis::TagmanagerV2::UserPermission::Representation - command.response_class = Google::Apis::TagmanagerV2::UserPermission - command.params['parent'] = parent unless parent.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Removes a user from the account, revoking access to it and all of its - # containers. - # @param [String] path - # GTM UserPermission's API relative path. Example: accounts/`account_id`/ - # user_permissions/`user_permission_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [NilClass] No result returned for this method - # @yieldparam err [StandardError] error object if request failed - # - # @return [void] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def delete_account_user_permission(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:delete, 'tagmanager/v2/{+path}', options) - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Gets a user's Account & Container access. - # @param [String] path - # GTM UserPermission's API relative path. Example: accounts/`account_id`/ - # user_permissions/`user_permission_id` - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::UserPermission] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::UserPermission] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def get_account_user_permission(path, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+path}', options) - command.response_representation = Google::Apis::TagmanagerV2::UserPermission::Representation - command.response_class = Google::Apis::TagmanagerV2::UserPermission - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # List all users that have access to the account along with Account and - # Container user access granted to each of them. - # @param [String] parent - # GTM Accounts's API relative path. Example: accounts/`account_id` - # @param [String] page_token - # Continuation token for fetching the next page of results. - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::ListUserPermissionsResponse] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::ListUserPermissionsResponse] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_account_user_permissions(parent, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:get, 'tagmanager/v2/{+parent}/user_permissions', options) - command.response_representation = Google::Apis::TagmanagerV2::ListUserPermissionsResponse::Representation - command.response_class = Google::Apis::TagmanagerV2::ListUserPermissionsResponse - command.params['parent'] = parent unless parent.nil? - command.query['pageToken'] = page_token unless page_token.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - # Updates a user's Account & Container access. - # @param [String] path - # GTM UserPermission's API relative path. Example: accounts/`account_id`/ - # user_permissions/`user_permission_id` - # @param [Google::Apis::TagmanagerV2::UserPermission] user_permission_object - # @param [String] fields - # Selector specifying which fields to include in a partial response. - # @param [String] quota_user - # Available to use for quota purposes for server-side applications. Can be any - # arbitrary string assigned to a user, but should not exceed 40 characters. - # @param [Google::Apis::RequestOptions] options - # Request-specific options - # - # @yield [result, err] Result & error if block supplied - # @yieldparam result [Google::Apis::TagmanagerV2::UserPermission] parsed result object - # @yieldparam err [StandardError] error object if request failed - # - # @return [Google::Apis::TagmanagerV2::UserPermission] - # - # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried - # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification - # @raise [Google::Apis::AuthorizationError] Authorization is required - def update_account_user_permission(path, user_permission_object = nil, fields: nil, quota_user: nil, options: nil, &block) - command = make_simple_command(:put, 'tagmanager/v2/{+path}', options) - command.request_representation = Google::Apis::TagmanagerV2::UserPermission::Representation - command.request_object = user_permission_object - command.response_representation = Google::Apis::TagmanagerV2::UserPermission::Representation - command.response_class = Google::Apis::TagmanagerV2::UserPermission - command.params['path'] = path unless path.nil? - command.query['fields'] = fields unless fields.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - execute_or_queue_command(command, &block) - end - - protected - - def apply_command_defaults(command) - command.query['key'] = key unless key.nil? - command.query['quotaUser'] = quota_user unless quota_user.nil? - end - end - end - end -end diff --git a/generated/google/apis/testing_v1.rb b/generated/google/apis/testing_v1.rb index af1a7d4cd..efb9cd32f 100644 --- a/generated/google/apis/testing_v1.rb +++ b/generated/google/apis/testing_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/cloud-test-lab/ module TestingV1 VERSION = 'V1' - REVISION = '20200805' + REVISION = '20200820' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/testing_v1/classes.rb b/generated/google/apis/testing_v1/classes.rb index 694ccc6da..79c10dfab 100644 --- a/generated/google/apis/testing_v1/classes.rb +++ b/generated/google/apis/testing_v1/classes.rb @@ -1368,6 +1368,11 @@ module Google class IosTestSetup include Google::Apis::Core::Hashable + # iOS apps to install in addition to those being directly tested. + # Corresponds to the JSON property `additionalIpas` + # @return [Array] + attr_accessor :additional_ipas + # The network traffic profile used for running the test. Available network # profiles can be queried by using the NETWORK_CONFIGURATION environment type # when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog. @@ -1381,6 +1386,7 @@ module Google # Update properties of this object def update!(**args) + @additional_ipas = args[:additional_ipas] if args.key?(:additional_ipas) @network_profile = args[:network_profile] if args.key?(:network_profile) end end diff --git a/generated/google/apis/testing_v1/representations.rb b/generated/google/apis/testing_v1/representations.rb index 4c3fcd943..209335353 100644 --- a/generated/google/apis/testing_v1/representations.rb +++ b/generated/google/apis/testing_v1/representations.rb @@ -826,6 +826,8 @@ module Google class IosTestSetup # @private class Representation < Google::Apis::Core::JsonRepresentation + collection :additional_ipas, as: 'additionalIpas', class: Google::Apis::TestingV1::FileReference, decorator: Google::Apis::TestingV1::FileReference::Representation + property :network_profile, as: 'networkProfile' end end diff --git a/generated/google/apis/youtube_partner_v1.rb b/generated/google/apis/youtube_partner_v1.rb index 7c5379c3b..3f706ce91 100644 --- a/generated/google/apis/youtube_partner_v1.rb +++ b/generated/google/apis/youtube_partner_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://devsite.googleplex.com/youtube/partner/docs/v1/ module YoutubePartnerV1 VERSION = 'V1' - REVISION = '20200807' + REVISION = '20200825' # View and manage your assets and associated content on YouTube AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner'