Autogenerated update (2020-08-04)
Update: - abusiveexperiencereport_v1 - adexchangebuyer2_v2beta1 - adexperiencereport_v1 - admob_v1 - androiddeviceprovisioning_v1 - androidpublisher_v3 - billingbudgets_v1beta1 - blogger_v2 - blogger_v3 - customsearch_v1 - domainsrdap_v1 - factchecktools_v1alpha1 - firebasehosting_v1 - firebasehosting_v1beta1 - gmailpostmastertools_v1beta1 - language_v1 - language_v1beta1 - language_v1beta2 - libraryagent_v1 - managedidentities_v1 - managedidentities_v1alpha1 - managedidentities_v1beta1 - playcustomapp_v1 - prod_tt_sasportal_v1alpha1 - realtimebidding_v1 - sasportal_v1alpha1 - securitycenter_v1 - securitycenter_v1beta1 - securitycenter_v1p1alpha1 - securitycenter_v1p1beta1 - serviceconsumermanagement_v1 - serviceconsumermanagement_v1beta1 - servicenetworking_v1 - servicenetworking_v1beta - serviceusage_v1 - serviceusage_v1beta1 - toolresults_v1beta3 - translate_v3 - translate_v3beta1 - websecurityscanner_v1 - websecurityscanner_v1alpha - websecurityscanner_v1beta - youtube_analytics_v2 - youtube_partner_v1 - youtube_v3 - youtubereporting_v1
This commit is contained in:
Google APIs
parent
039cf0957c
commit
2ebdf41813
|
|
@ -58718,6 +58718,178 @@
|
||||||
"/dataflow:v1b3/fields": fields
|
"/dataflow:v1b3/fields": fields
|
||||||
"/dataflow:v1b3/key": key
|
"/dataflow:v1b3/key": key
|
||||||
"/dataflow:v1b3/quotaUser": quota_user
|
"/dataflow:v1b3/quotaUser": quota_user
|
||||||
|
"/datafusion:v1/Accelerator": accelerator
|
||||||
|
"/datafusion:v1/Accelerator/acceleratorType": accelerator_type
|
||||||
|
"/datafusion:v1/AuditConfig": audit_config
|
||||||
|
"/datafusion:v1/AuditConfig/auditLogConfigs": audit_log_configs
|
||||||
|
"/datafusion:v1/AuditConfig/auditLogConfigs/audit_log_config": audit_log_config
|
||||||
|
"/datafusion:v1/AuditConfig/service": service
|
||||||
|
"/datafusion:v1/AuditLogConfig": audit_log_config
|
||||||
|
"/datafusion:v1/AuditLogConfig/exemptedMembers": exempted_members
|
||||||
|
"/datafusion:v1/AuditLogConfig/exemptedMembers/exempted_member": exempted_member
|
||||||
|
"/datafusion:v1/AuditLogConfig/logType": log_type
|
||||||
|
"/datafusion:v1/Binding": binding
|
||||||
|
"/datafusion:v1/Binding/condition": condition
|
||||||
|
"/datafusion:v1/Binding/members": members
|
||||||
|
"/datafusion:v1/Binding/members/member": member
|
||||||
|
"/datafusion:v1/Binding/role": role
|
||||||
|
"/datafusion:v1/CancelOperationRequest": cancel_operation_request
|
||||||
|
"/datafusion:v1/Empty": empty
|
||||||
|
"/datafusion:v1/Expr": expr
|
||||||
|
"/datafusion:v1/Expr/description": description
|
||||||
|
"/datafusion:v1/Expr/expression": expression
|
||||||
|
"/datafusion:v1/Expr/location": location
|
||||||
|
"/datafusion:v1/Expr/title": title
|
||||||
|
"/datafusion:v1/Instance": instance
|
||||||
|
"/datafusion:v1/Instance/accelerators": accelerators
|
||||||
|
"/datafusion:v1/Instance/accelerators/accelerator": accelerator
|
||||||
|
"/datafusion:v1/Instance/apiEndpoint": api_endpoint
|
||||||
|
"/datafusion:v1/Instance/availableVersion": available_version
|
||||||
|
"/datafusion:v1/Instance/availableVersion/available_version": available_version
|
||||||
|
"/datafusion:v1/Instance/createTime": create_time
|
||||||
|
"/datafusion:v1/Instance/description": description
|
||||||
|
"/datafusion:v1/Instance/displayName": display_name
|
||||||
|
"/datafusion:v1/Instance/enableStackdriverLogging": enable_stackdriver_logging
|
||||||
|
"/datafusion:v1/Instance/enableStackdriverMonitoring": enable_stackdriver_monitoring
|
||||||
|
"/datafusion:v1/Instance/gcsBucket": gcs_bucket
|
||||||
|
"/datafusion:v1/Instance/labels": labels
|
||||||
|
"/datafusion:v1/Instance/labels/label": label
|
||||||
|
"/datafusion:v1/Instance/name": name
|
||||||
|
"/datafusion:v1/Instance/networkConfig": network_config
|
||||||
|
"/datafusion:v1/Instance/options": options
|
||||||
|
"/datafusion:v1/Instance/options/option": option
|
||||||
|
"/datafusion:v1/Instance/privateInstance": private_instance
|
||||||
|
"/datafusion:v1/Instance/serviceAccount": service_account
|
||||||
|
"/datafusion:v1/Instance/serviceEndpoint": service_endpoint
|
||||||
|
"/datafusion:v1/Instance/state": state
|
||||||
|
"/datafusion:v1/Instance/stateMessage": state_message
|
||||||
|
"/datafusion:v1/Instance/type": type
|
||||||
|
"/datafusion:v1/Instance/updateTime": update_time
|
||||||
|
"/datafusion:v1/Instance/version": version
|
||||||
|
"/datafusion:v1/Instance/zone": zone
|
||||||
|
"/datafusion:v1/ListAvailableVersionsResponse": list_available_versions_response
|
||||||
|
"/datafusion:v1/ListAvailableVersionsResponse/availableVersions": available_versions
|
||||||
|
"/datafusion:v1/ListAvailableVersionsResponse/availableVersions/available_version": available_version
|
||||||
|
"/datafusion:v1/ListAvailableVersionsResponse/nextPageToken": next_page_token
|
||||||
|
"/datafusion:v1/ListInstancesResponse": list_instances_response
|
||||||
|
"/datafusion:v1/ListInstancesResponse/instances": instances
|
||||||
|
"/datafusion:v1/ListInstancesResponse/instances/instance": instance
|
||||||
|
"/datafusion:v1/ListInstancesResponse/nextPageToken": next_page_token
|
||||||
|
"/datafusion:v1/ListInstancesResponse/unreachable": unreachable
|
||||||
|
"/datafusion:v1/ListInstancesResponse/unreachable/unreachable": unreachable
|
||||||
|
"/datafusion:v1/ListLocationsResponse": list_locations_response
|
||||||
|
"/datafusion:v1/ListLocationsResponse/locations": locations
|
||||||
|
"/datafusion:v1/ListLocationsResponse/locations/location": location
|
||||||
|
"/datafusion:v1/ListLocationsResponse/nextPageToken": next_page_token
|
||||||
|
"/datafusion:v1/ListOperationsResponse": list_operations_response
|
||||||
|
"/datafusion:v1/ListOperationsResponse/nextPageToken": next_page_token
|
||||||
|
"/datafusion:v1/ListOperationsResponse/operations": operations
|
||||||
|
"/datafusion:v1/ListOperationsResponse/operations/operation": operation
|
||||||
|
"/datafusion:v1/Location": location
|
||||||
|
"/datafusion:v1/Location/displayName": display_name
|
||||||
|
"/datafusion:v1/Location/labels": labels
|
||||||
|
"/datafusion:v1/Location/labels/label": label
|
||||||
|
"/datafusion:v1/Location/locationId": location_id
|
||||||
|
"/datafusion:v1/Location/metadata": metadata
|
||||||
|
"/datafusion:v1/Location/metadata/metadatum": metadatum
|
||||||
|
"/datafusion:v1/Location/name": name
|
||||||
|
"/datafusion:v1/NetworkConfig": network_config
|
||||||
|
"/datafusion:v1/NetworkConfig/ipAllocation": ip_allocation
|
||||||
|
"/datafusion:v1/NetworkConfig/network": network
|
||||||
|
"/datafusion:v1/Operation": operation
|
||||||
|
"/datafusion:v1/Operation/done": done
|
||||||
|
"/datafusion:v1/Operation/error": error
|
||||||
|
"/datafusion:v1/Operation/metadata": metadata
|
||||||
|
"/datafusion:v1/Operation/metadata/metadatum": metadatum
|
||||||
|
"/datafusion:v1/Operation/name": name
|
||||||
|
"/datafusion:v1/Operation/response": response
|
||||||
|
"/datafusion:v1/Operation/response/response": response
|
||||||
|
"/datafusion:v1/OperationMetadata": operation_metadata
|
||||||
|
"/datafusion:v1/OperationMetadata/apiVersion": api_version
|
||||||
|
"/datafusion:v1/OperationMetadata/createTime": create_time
|
||||||
|
"/datafusion:v1/OperationMetadata/endTime": end_time
|
||||||
|
"/datafusion:v1/OperationMetadata/requestedCancellation": requested_cancellation
|
||||||
|
"/datafusion:v1/OperationMetadata/statusDetail": status_detail
|
||||||
|
"/datafusion:v1/OperationMetadata/target": target
|
||||||
|
"/datafusion:v1/OperationMetadata/verb": verb
|
||||||
|
"/datafusion:v1/Policy": policy
|
||||||
|
"/datafusion:v1/Policy/auditConfigs": audit_configs
|
||||||
|
"/datafusion:v1/Policy/auditConfigs/audit_config": audit_config
|
||||||
|
"/datafusion:v1/Policy/bindings": bindings
|
||||||
|
"/datafusion:v1/Policy/bindings/binding": binding
|
||||||
|
"/datafusion:v1/Policy/etag": etag
|
||||||
|
"/datafusion:v1/Policy/version": version
|
||||||
|
"/datafusion:v1/RestartInstanceRequest": restart_instance_request
|
||||||
|
"/datafusion:v1/SetIamPolicyRequest": set_iam_policy_request
|
||||||
|
"/datafusion:v1/SetIamPolicyRequest/policy": policy
|
||||||
|
"/datafusion:v1/SetIamPolicyRequest/updateMask": update_mask
|
||||||
|
"/datafusion:v1/Status": status
|
||||||
|
"/datafusion:v1/Status/code": code
|
||||||
|
"/datafusion:v1/Status/details": details
|
||||||
|
"/datafusion:v1/Status/details/detail": detail
|
||||||
|
"/datafusion:v1/Status/details/detail/detail": detail
|
||||||
|
"/datafusion:v1/Status/message": message
|
||||||
|
"/datafusion:v1/TestIamPermissionsRequest": test_iam_permissions_request
|
||||||
|
"/datafusion:v1/TestIamPermissionsRequest/permissions": permissions
|
||||||
|
"/datafusion:v1/TestIamPermissionsRequest/permissions/permission": permission
|
||||||
|
"/datafusion:v1/TestIamPermissionsResponse": test_iam_permissions_response
|
||||||
|
"/datafusion:v1/TestIamPermissionsResponse/permissions": permissions
|
||||||
|
"/datafusion:v1/TestIamPermissionsResponse/permissions/permission": permission
|
||||||
|
"/datafusion:v1/Version": version
|
||||||
|
"/datafusion:v1/Version/defaultVersion": default_version
|
||||||
|
"/datafusion:v1/Version/versionNumber": version_number
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.get": get_project_location
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.get/name": name
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.create": create_project_location_instance
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.create/instanceId": instance_id
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.create/parent": parent
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.delete": delete_project_location_instance
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.delete/name": name
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.get": get_project_location_instance
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.get/name": name
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.getIamPolicy": get_project_location_instance_iam_policy
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.getIamPolicy/options.requestedPolicyVersion": options_requested_policy_version
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.getIamPolicy/resource": resource
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.list": list_project_location_instances
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.list/filter": filter
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.list/orderBy": order_by
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.list/pageSize": page_size
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.list/pageToken": page_token
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.list/parent": parent
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.patch": patch_project_location_instance
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.patch/name": name
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.patch/updateMask": update_mask
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.restart": restart_instance
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.restart/name": name
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.setIamPolicy": set_instance_iam_policy
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.setIamPolicy/resource": resource
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.testIamPermissions": test_instance_iam_permissions
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.instances.testIamPermissions/resource": resource
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.list": list_project_locations
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.list/filter": filter
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.list/includeUnrevealedLocations": include_unrevealed_locations
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.list/name": name
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.list/pageSize": page_size
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.list/pageToken": page_token
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.operations.cancel": cancel_operation
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.operations.cancel/name": name
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.operations.delete": delete_project_location_operation
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.operations.delete/name": name
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.operations.get": get_project_location_operation
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.operations.get/name": name
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.operations.list": list_project_location_operations
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.operations.list/filter": filter
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.operations.list/name": name
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.operations.list/pageSize": page_size
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.operations.list/pageToken": page_token
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.versions.list": list_project_location_versions
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.versions.list/latestPatchOnly": latest_patch_only
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.versions.list/pageSize": page_size
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.versions.list/pageToken": page_token
|
||||||
|
"/datafusion:v1/datafusion.projects.locations.versions.list/parent": parent
|
||||||
|
"/datafusion:v1/fields": fields
|
||||||
|
"/datafusion:v1/key": key
|
||||||
|
"/datafusion:v1/quotaUser": quota_user
|
||||||
"/datafusion:v1beta1/Accelerator": accelerator
|
"/datafusion:v1beta1/Accelerator": accelerator
|
||||||
"/datafusion:v1beta1/Accelerator/acceleratorType": accelerator_type
|
"/datafusion:v1beta1/Accelerator/acceleratorType": accelerator_type
|
||||||
"/datafusion:v1beta1/AuditConfig": audit_config
|
"/datafusion:v1beta1/AuditConfig": audit_config
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ module Google
|
||||||
# @see https://developers.google.com/abusive-experience-report/
|
# @see https://developers.google.com/abusive-experience-report/
|
||||||
module AbusiveexperiencereportV1
|
module AbusiveexperiencereportV1
|
||||||
VERSION = 'V1'
|
VERSION = 'V1'
|
||||||
REVISION = '20200210'
|
REVISION = '20200803'
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
||||||
|
|
@ -31,18 +31,15 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :abusive_status
|
attr_accessor :abusive_status
|
||||||
|
|
||||||
# The time at which
|
# The time at which [enforcement](https://support.google.com/webtools/answer/
|
||||||
# [enforcement](https://support.google.com/webtools/answer/7538608) against
|
# 7538608) against the site began or will begin. Not set when the filter_status
|
||||||
# the site began or will begin.
|
|
||||||
# Not set when the
|
|
||||||
# filter_status
|
|
||||||
# is OFF.
|
# is OFF.
|
||||||
# Corresponds to the JSON property `enforcementTime`
|
# Corresponds to the JSON property `enforcementTime`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :enforcement_time
|
attr_accessor :enforcement_time
|
||||||
|
|
||||||
# The site's [enforcement
|
# The site's [enforcement status](https://support.google.com/webtools/answer/
|
||||||
# status](https://support.google.com/webtools/answer/7538608).
|
# 7538608).
|
||||||
# Corresponds to the JSON property `filterStatus`
|
# Corresponds to the JSON property `filterStatus`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :filter_status
|
attr_accessor :filter_status
|
||||||
|
|
@ -52,12 +49,10 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :last_change_time
|
attr_accessor :last_change_time
|
||||||
|
|
||||||
# A link to the full Abusive Experience Report for the site.
|
# A link to the full Abusive Experience Report for the site. Not set in
|
||||||
# Not set in
|
# ViolatingSitesResponse. Note that you must complete the [Search Console
|
||||||
# ViolatingSitesResponse.
|
# verification process](https://support.google.com/webmasters/answer/9008080)
|
||||||
# Note that you must complete the [Search Console verification
|
# for the site before you can access the full report.
|
||||||
# process](https://support.google.com/webmasters/answer/9008080) for the site
|
|
||||||
# before you can access the full report.
|
|
||||||
# Corresponds to the JSON property `reportUrl`
|
# Corresponds to the JSON property `reportUrl`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :report_url
|
attr_accessor :report_url
|
||||||
|
|
|
||||||
|
|
@ -50,9 +50,8 @@ module Google
|
||||||
|
|
||||||
# Gets a site's Abusive Experience Report summary.
|
# Gets a site's Abusive Experience Report summary.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The name of the site whose summary to get, e.g.
|
# Required. The name of the site whose summary to get, e.g. `sites/http%3A%2F%
|
||||||
# `sites/http%3A%2F%2Fwww.google.com%2F`.
|
# 2Fwww.google.com%2F`. Format: `sites/`site``
|
||||||
# Format: `sites/`site``
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,7 @@ module Google
|
||||||
# @see https://developers.google.com/authorized-buyers/apis/reference/rest/
|
# @see https://developers.google.com/authorized-buyers/apis/reference/rest/
|
||||||
module Adexchangebuyer2V2beta1
|
module Adexchangebuyer2V2beta1
|
||||||
VERSION = 'V2beta1'
|
VERSION = 'V2beta1'
|
||||||
REVISION = '20200520'
|
REVISION = '20200803'
|
||||||
|
|
||||||
# Manage your Ad Exchange buyer account configuration
|
# Manage your Ad Exchange buyer account configuration
|
||||||
AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer'
|
AUTH_ADEXCHANGE_BUYER = 'https://www.googleapis.com/auth/adexchange.buyer'
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -26,7 +26,7 @@ module Google
|
||||||
# @see https://developers.google.com/ad-experience-report/
|
# @see https://developers.google.com/ad-experience-report/
|
||||||
module AdexperiencereportV1
|
module AdexperiencereportV1
|
||||||
VERSION = 'V1'
|
VERSION = 'V1'
|
||||||
REVISION = '20200210'
|
REVISION = '20200803'
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
||||||
|
|
@ -31,19 +31,15 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :better_ads_status
|
attr_accessor :better_ads_status
|
||||||
|
|
||||||
# The time at which
|
# The time at which [enforcement](https://support.google.com/webtools/answer/
|
||||||
# [enforcement](https://support.google.com/webtools/answer/7308033) against
|
# 7308033) against the site began or will begin on this platform. Not set when
|
||||||
# the site began or will begin on this platform.
|
# the filter_status is OFF.
|
||||||
# Not set when the
|
|
||||||
# filter_status
|
|
||||||
# is OFF.
|
|
||||||
# Corresponds to the JSON property `enforcementTime`
|
# Corresponds to the JSON property `enforcementTime`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :enforcement_time
|
attr_accessor :enforcement_time
|
||||||
|
|
||||||
# The site's [enforcement
|
# The site's [enforcement status](https://support.google.com/webtools/answer/
|
||||||
# status](https://support.google.com/webtools/answer/7308033) on this
|
# 7308033) on this platform.
|
||||||
# platform.
|
|
||||||
# Corresponds to the JSON property `filterStatus`
|
# Corresponds to the JSON property `filterStatus`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :filter_status
|
attr_accessor :filter_status
|
||||||
|
|
@ -53,19 +49,16 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :last_change_time
|
attr_accessor :last_change_time
|
||||||
|
|
||||||
# The site's regions on this platform.
|
# The site's regions on this platform. No longer populated, because there is no
|
||||||
# No longer populated, because there is no longer any semantic difference
|
# longer any semantic difference between sites in different regions.
|
||||||
# between sites in different regions.
|
|
||||||
# Corresponds to the JSON property `region`
|
# Corresponds to the JSON property `region`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :region
|
attr_accessor :region
|
||||||
|
|
||||||
# A link to the full Ad Experience Report for the site on this platform..
|
# A link to the full Ad Experience Report for the site on this platform.. Not
|
||||||
# Not set in
|
# set in ViolatingSitesResponse. Note that you must complete the [Search Console
|
||||||
# ViolatingSitesResponse.
|
# verification process](https://support.google.com/webmasters/answer/9008080)
|
||||||
# Note that you must complete the [Search Console verification
|
# for the site before you can access the full report.
|
||||||
# process](https://support.google.com/webmasters/answer/9008080) for the site
|
|
||||||
# before you can access the full report.
|
|
||||||
# Corresponds to the JSON property `reportUrl`
|
# Corresponds to the JSON property `reportUrl`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :report_url
|
attr_accessor :report_url
|
||||||
|
|
|
||||||
|
|
@ -50,9 +50,8 @@ module Google
|
||||||
|
|
||||||
# Gets a site's Ad Experience Report summary.
|
# Gets a site's Ad Experience Report summary.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The name of the site whose summary to get, e.g.
|
# Required. The name of the site whose summary to get, e.g. `sites/http%3A%2F%
|
||||||
# `sites/http%3A%2F%2Fwww.google.com%2F`.
|
# 2Fwww.google.com%2F`. Format: `sites/`site``
|
||||||
# Format: `sites/`site``
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ module Google
|
||||||
# @see https://developers.google.com/admob/api/
|
# @see https://developers.google.com/admob/api/
|
||||||
module AdmobV1
|
module AdmobV1
|
||||||
VERSION = 'V1'
|
VERSION = 'V1'
|
||||||
REVISION = '20200722'
|
REVISION = '20200801'
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
||||||
|
|
@ -24,30 +24,29 @@ module Google
|
||||||
|
|
||||||
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
|
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
|
||||||
# and time zone are either specified elsewhere or are not significant. The date
|
# and time zone are either specified elsewhere or are not significant. The date
|
||||||
# is relative to the Proleptic Gregorian Calendar. This can represent:
|
# is relative to the Proleptic Gregorian Calendar. This can represent: * A full
|
||||||
# * A full date, with non-zero year, month and day values
|
# date, with non-zero year, month and day values * A month and day value, with a
|
||||||
# * A month and day value, with a zero year, e.g. an anniversary
|
# zero year, e.g. an anniversary * A year on its own, with zero month and day
|
||||||
# * A year on its own, with zero month and day values
|
# values * A year and month value, with a zero day, e.g. a credit card
|
||||||
# * A year and month value, with a zero day, e.g. a credit card expiration date
|
# expiration date Related types are google.type.TimeOfDay and `google.protobuf.
|
||||||
# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
|
# Timestamp`.
|
||||||
class Date
|
class Date
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Day of month. Must be from 1 to 31 and valid for the year and month, or 0
|
# Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if
|
||||||
# if specifying a year by itself or a year and month where the day is not
|
# specifying a year by itself or a year and month where the day is not
|
||||||
# significant.
|
# significant.
|
||||||
# Corresponds to the JSON property `day`
|
# Corresponds to the JSON property `day`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :day
|
attr_accessor :day
|
||||||
|
|
||||||
# Month of year. Must be from 1 to 12, or 0 if specifying a year without a
|
# Month of year. Must be from 1 to 12, or 0 if specifying a year without a month
|
||||||
# month and day.
|
# and day.
|
||||||
# Corresponds to the JSON property `month`
|
# Corresponds to the JSON property `month`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :month
|
attr_accessor :month
|
||||||
|
|
||||||
# Year of date. Must be from 1 to 9999, or 0 if specifying a date without
|
# Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
|
||||||
# a year.
|
|
||||||
# Corresponds to the JSON property `year`
|
# Corresponds to the JSON property `year`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :year
|
attr_accessor :year
|
||||||
|
|
@ -70,24 +69,24 @@ module Google
|
||||||
|
|
||||||
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
|
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
|
||||||
# and time zone are either specified elsewhere or are not significant. The date
|
# and time zone are either specified elsewhere or are not significant. The date
|
||||||
# is relative to the Proleptic Gregorian Calendar. This can represent:
|
# is relative to the Proleptic Gregorian Calendar. This can represent: * A full
|
||||||
# * A full date, with non-zero year, month and day values
|
# date, with non-zero year, month and day values * A month and day value, with a
|
||||||
# * A month and day value, with a zero year, e.g. an anniversary
|
# zero year, e.g. an anniversary * A year on its own, with zero month and day
|
||||||
# * A year on its own, with zero month and day values
|
# values * A year and month value, with a zero day, e.g. a credit card
|
||||||
# * A year and month value, with a zero day, e.g. a credit card expiration date
|
# expiration date Related types are google.type.TimeOfDay and `google.protobuf.
|
||||||
# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
|
# Timestamp`.
|
||||||
# Corresponds to the JSON property `endDate`
|
# Corresponds to the JSON property `endDate`
|
||||||
# @return [Google::Apis::AdmobV1::Date]
|
# @return [Google::Apis::AdmobV1::Date]
|
||||||
attr_accessor :end_date
|
attr_accessor :end_date
|
||||||
|
|
||||||
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
|
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
|
||||||
# and time zone are either specified elsewhere or are not significant. The date
|
# and time zone are either specified elsewhere or are not significant. The date
|
||||||
# is relative to the Proleptic Gregorian Calendar. This can represent:
|
# is relative to the Proleptic Gregorian Calendar. This can represent: * A full
|
||||||
# * A full date, with non-zero year, month and day values
|
# date, with non-zero year, month and day values * A month and day value, with a
|
||||||
# * A month and day value, with a zero year, e.g. an anniversary
|
# zero year, e.g. an anniversary * A year on its own, with zero month and day
|
||||||
# * A year on its own, with zero month and day values
|
# values * A year and month value, with a zero day, e.g. a credit card
|
||||||
# * A year and month value, with a zero day, e.g. a credit card expiration date
|
# expiration date Related types are google.type.TimeOfDay and `google.protobuf.
|
||||||
# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
|
# Timestamp`.
|
||||||
# Corresponds to the JSON property `startDate`
|
# Corresponds to the JSON property `startDate`
|
||||||
# @return [Google::Apis::AdmobV1::Date]
|
# @return [Google::Apis::AdmobV1::Date]
|
||||||
attr_accessor :start_date
|
attr_accessor :start_date
|
||||||
|
|
@ -107,38 +106,19 @@ module Google
|
||||||
class GenerateMediationReportRequest
|
class GenerateMediationReportRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The specification for generating an AdMob Mediation report.
|
# The specification for generating an AdMob Mediation report. For example, the
|
||||||
# For example, the specification to get observed ECPM sliced by ad source and
|
# specification to get observed ECPM sliced by ad source and app for the 'US'
|
||||||
# app for the 'US' and 'CN' countries can look like the following example:
|
# and 'CN' countries can look like the following example: ` "date_range": ` "
|
||||||
# `
|
# start_date": `"year": 2018, "month": 9, "day": 1`, "end_date": `"year": 2018, "
|
||||||
# "date_range": `
|
# month": 9, "day": 30` `, "dimensions": ["AD_SOURCE", "APP", "COUNTRY"], "
|
||||||
# "start_date": `"year": 2018, "month": 9, "day": 1`,
|
# metrics": ["OBSERVED_ECPM"], "dimension_filters": [ ` "dimension": "COUNTRY", "
|
||||||
# "end_date": `"year": 2018, "month": 9, "day": 30`
|
# matches_any": `"values": [`"value": "US", "value": "CN"`]` ` ], "
|
||||||
# `,
|
# sort_conditions": [ `"dimension":"APP", order: "ASCENDING"` ], "
|
||||||
# "dimensions": ["AD_SOURCE", "APP", "COUNTRY"],
|
# localization_settings": ` "currency_code": "USD", "language_code": "en-US" ` `
|
||||||
# "metrics": ["OBSERVED_ECPM"],
|
# For a better understanding, you can treat the preceding specification like the
|
||||||
# "dimension_filters": [
|
# following pseudo SQL: SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM
|
||||||
# `
|
# MEDIATION_REPORT WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' AND
|
||||||
# "dimension": "COUNTRY",
|
# COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC;
|
||||||
# "matches_any": `"values": [`"value": "US", "value": "CN"`]`
|
|
||||||
# `
|
|
||||||
# ],
|
|
||||||
# "sort_conditions": [
|
|
||||||
# `"dimension":"APP", order: "ASCENDING"`
|
|
||||||
# ],
|
|
||||||
# "localization_settings": `
|
|
||||||
# "currency_code": "USD",
|
|
||||||
# "language_code": "en-US"
|
|
||||||
# `
|
|
||||||
# `
|
|
||||||
# For a better understanding, you can treat the preceding specification like
|
|
||||||
# the following pseudo SQL:
|
|
||||||
# SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM
|
|
||||||
# FROM MEDIATION_REPORT
|
|
||||||
# WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30'
|
|
||||||
# AND COUNTRY IN ('US', 'CN')
|
|
||||||
# GROUP BY AD_SOURCE, APP, COUNTRY
|
|
||||||
# ORDER BY APP ASC;
|
|
||||||
# Corresponds to the JSON property `reportSpec`
|
# Corresponds to the JSON property `reportSpec`
|
||||||
# @return [Google::Apis::AdmobV1::MediationReportSpec]
|
# @return [Google::Apis::AdmobV1::MediationReportSpec]
|
||||||
attr_accessor :report_spec
|
attr_accessor :report_spec
|
||||||
|
|
@ -153,39 +133,16 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# The streaming response for the AdMob Mediation report where the first
|
# The streaming response for the AdMob Mediation report where the first response
|
||||||
# response contains the report header, then a stream of row responses, and
|
# contains the report header, then a stream of row responses, and finally a
|
||||||
# finally a footer as the last response message.
|
# footer as the last response message. For example: [` "header": ` "date_range":
|
||||||
# For example:
|
# ` "start_date": `"year": 2018, "month": 9, "day": 1`, "end_date": `"year":
|
||||||
# [`
|
# 2018, "month": 9, "day": 1` `, "localization_settings": ` "currency_code": "
|
||||||
# "header": `
|
# USD", "language_code": "en-US" ` ` `, ` "row": ` "dimension_values": ` "DATE":
|
||||||
# "date_range": `
|
# `"value": "20180918"`, "APP": ` "value": "ca-app-pub-8123415297019784~
|
||||||
# "start_date": `"year": 2018, "month": 9, "day": 1`,
|
# 1001342552", "display_label": "My app name!" ` `, "metric_values": ` "
|
||||||
# "end_date": `"year": 2018, "month": 9, "day": 1`
|
# ESTIMATED_EARNINGS": `"decimal_value": "1324746"` ` ` `, ` "footer": `"
|
||||||
# `,
|
# matching_row_count": 1` `]
|
||||||
# "localization_settings": `
|
|
||||||
# "currency_code": "USD",
|
|
||||||
# "language_code": "en-US"
|
|
||||||
# `
|
|
||||||
# `
|
|
||||||
# `,
|
|
||||||
# `
|
|
||||||
# "row": `
|
|
||||||
# "dimension_values": `
|
|
||||||
# "DATE": `"value": "20180918"`,
|
|
||||||
# "APP": `
|
|
||||||
# "value": "ca-app-pub-8123415297019784~1001342552",
|
|
||||||
# "display_label": "My app name!"
|
|
||||||
# `
|
|
||||||
# `,
|
|
||||||
# "metric_values": `
|
|
||||||
# "ESTIMATED_EARNINGS": `"decimal_value": "1324746"`
|
|
||||||
# `
|
|
||||||
# `
|
|
||||||
# `,
|
|
||||||
# `
|
|
||||||
# "footer": `"matching_row_count": 1`
|
|
||||||
# `]
|
|
||||||
class GenerateMediationReportResponse
|
class GenerateMediationReportResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -222,39 +179,20 @@ module Google
|
||||||
class GenerateNetworkReportRequest
|
class GenerateNetworkReportRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The specification for generating an AdMob Network report.
|
# The specification for generating an AdMob Network report. For example, the
|
||||||
# For example, the specification to get clicks and estimated earnings for only
|
# specification to get clicks and estimated earnings for only the 'US' and 'CN'
|
||||||
# the 'US' and 'CN' countries can look like the following example:
|
# countries can look like the following example: ` 'date_range': ` 'start_date':
|
||||||
# `
|
# `'year': 2018, 'month': 9, 'day': 1`, 'end_date': `'year': 2018, 'month': 9, '
|
||||||
# 'date_range': `
|
# day': 30` `, 'dimensions': ['DATE', 'APP', 'COUNTRY'], 'metrics': ['CLICKS', '
|
||||||
# 'start_date': `'year': 2018, 'month': 9, 'day': 1`,
|
# ESTIMATED_EARNINGS'], 'dimension_filters': [ ` 'dimension': 'COUNTRY', '
|
||||||
# 'end_date': `'year': 2018, 'month': 9, 'day': 30`
|
# matches_any': `'values': [`'value': 'US', 'value': 'CN'`]` ` ], '
|
||||||
# `,
|
# sort_conditions': [ `'dimension':'APP', order: 'ASCENDING'`, `'metric':'CLICKS'
|
||||||
# 'dimensions': ['DATE', 'APP', 'COUNTRY'],
|
# , order: 'DESCENDING'` ], 'localization_settings': ` 'currency_code': 'USD', '
|
||||||
# 'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'],
|
# language_code': 'en-US' ` ` For a better understanding, you can treat the
|
||||||
# 'dimension_filters': [
|
# preceding specification like the following pseudo SQL: SELECT DATE, APP,
|
||||||
# `
|
# COUNTRY, CLICKS, ESTIMATED_EARNINGS FROM NETWORK_REPORT WHERE DATE >= '2018-09-
|
||||||
# 'dimension': 'COUNTRY',
|
# 01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP,
|
||||||
# 'matches_any': `'values': [`'value': 'US', 'value': 'CN'`]`
|
# COUNTRY ORDER BY APP ASC, CLICKS DESC;
|
||||||
# `
|
|
||||||
# ],
|
|
||||||
# 'sort_conditions': [
|
|
||||||
# `'dimension':'APP', order: 'ASCENDING'`,
|
|
||||||
# `'metric':'CLICKS', order: 'DESCENDING'`
|
|
||||||
# ],
|
|
||||||
# 'localization_settings': `
|
|
||||||
# 'currency_code': 'USD',
|
|
||||||
# 'language_code': 'en-US'
|
|
||||||
# `
|
|
||||||
# `
|
|
||||||
# For a better understanding, you can treat the preceding specification like
|
|
||||||
# the following pseudo SQL:
|
|
||||||
# SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS
|
|
||||||
# FROM NETWORK_REPORT
|
|
||||||
# WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30'
|
|
||||||
# AND COUNTRY IN ('US', 'CN')
|
|
||||||
# GROUP BY DATE, APP, COUNTRY
|
|
||||||
# ORDER BY APP ASC, CLICKS DESC;
|
|
||||||
# Corresponds to the JSON property `reportSpec`
|
# Corresponds to the JSON property `reportSpec`
|
||||||
# @return [Google::Apis::AdmobV1::NetworkReportSpec]
|
# @return [Google::Apis::AdmobV1::NetworkReportSpec]
|
||||||
attr_accessor :report_spec
|
attr_accessor :report_spec
|
||||||
|
|
@ -271,37 +209,13 @@ module Google
|
||||||
|
|
||||||
# The streaming response for the AdMob Network report where the first response
|
# The streaming response for the AdMob Network report where the first response
|
||||||
# contains the report header, then a stream of row responses, and finally a
|
# contains the report header, then a stream of row responses, and finally a
|
||||||
# footer as the last response message.
|
# footer as the last response message. For example: [` "header": ` "dateRange": `
|
||||||
# For example:
|
# "startDate": `"year": 2018, "month": 9, "day": 1`, "endDate": `"year": 2018, "
|
||||||
# [`
|
# month": 9, "day": 1` `, "localizationSettings": ` "currencyCode": "USD", "
|
||||||
# "header": `
|
# languageCode": "en-US" ` ` `, ` "row": ` "dimensionValues": ` "DATE": `"value":
|
||||||
# "dateRange": `
|
# "20180918"`, "APP": ` "value": "ca-app-pub-8123415297019784~1001342552",
|
||||||
# "startDate": `"year": 2018, "month": 9, "day": 1`,
|
# displayLabel: "My app name!" ` `, "metricValues": ` "ESTIMATED_EARNINGS": `"
|
||||||
# "endDate": `"year": 2018, "month": 9, "day": 1`
|
# microsValue": 6500000` ` ` `, ` "footer": `"matchingRowCount": 1` `]
|
||||||
# `,
|
|
||||||
# "localizationSettings": `
|
|
||||||
# "currencyCode": "USD",
|
|
||||||
# "languageCode": "en-US"
|
|
||||||
# `
|
|
||||||
# `
|
|
||||||
# `,
|
|
||||||
# `
|
|
||||||
# "row": `
|
|
||||||
# "dimensionValues": `
|
|
||||||
# "DATE": `"value": "20180918"`,
|
|
||||||
# "APP": `
|
|
||||||
# "value": "ca-app-pub-8123415297019784~1001342552",
|
|
||||||
# displayLabel: "My app name!"
|
|
||||||
# `
|
|
||||||
# `,
|
|
||||||
# "metricValues": `
|
|
||||||
# "ESTIMATED_EARNINGS": `"microsValue": 6500000`
|
|
||||||
# `
|
|
||||||
# `
|
|
||||||
# `,
|
|
||||||
# `
|
|
||||||
# "footer": `"matchingRowCount": 1`
|
|
||||||
# `]
|
|
||||||
class GenerateNetworkReportResponse
|
class GenerateNetworkReportResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -343,8 +257,8 @@ module Google
|
||||||
# @return [Array<Google::Apis::AdmobV1::PublisherAccount>]
|
# @return [Array<Google::Apis::AdmobV1::PublisherAccount>]
|
||||||
attr_accessor :account
|
attr_accessor :account
|
||||||
|
|
||||||
# If not empty, indicates that there might be more accounts for the request;
|
# If not empty, indicates that there might be more accounts for the request; you
|
||||||
# you must pass this value in a new `ListPublisherAccountsRequest`.
|
# must pass this value in a new `ListPublisherAccountsRequest`.
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -390,38 +304,19 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# The specification for generating an AdMob Mediation report.
|
# The specification for generating an AdMob Mediation report. For example, the
|
||||||
# For example, the specification to get observed ECPM sliced by ad source and
|
# specification to get observed ECPM sliced by ad source and app for the 'US'
|
||||||
# app for the 'US' and 'CN' countries can look like the following example:
|
# and 'CN' countries can look like the following example: ` "date_range": ` "
|
||||||
# `
|
# start_date": `"year": 2018, "month": 9, "day": 1`, "end_date": `"year": 2018, "
|
||||||
# "date_range": `
|
# month": 9, "day": 30` `, "dimensions": ["AD_SOURCE", "APP", "COUNTRY"], "
|
||||||
# "start_date": `"year": 2018, "month": 9, "day": 1`,
|
# metrics": ["OBSERVED_ECPM"], "dimension_filters": [ ` "dimension": "COUNTRY", "
|
||||||
# "end_date": `"year": 2018, "month": 9, "day": 30`
|
# matches_any": `"values": [`"value": "US", "value": "CN"`]` ` ], "
|
||||||
# `,
|
# sort_conditions": [ `"dimension":"APP", order: "ASCENDING"` ], "
|
||||||
# "dimensions": ["AD_SOURCE", "APP", "COUNTRY"],
|
# localization_settings": ` "currency_code": "USD", "language_code": "en-US" ` `
|
||||||
# "metrics": ["OBSERVED_ECPM"],
|
# For a better understanding, you can treat the preceding specification like the
|
||||||
# "dimension_filters": [
|
# following pseudo SQL: SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM
|
||||||
# `
|
# MEDIATION_REPORT WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' AND
|
||||||
# "dimension": "COUNTRY",
|
# COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC;
|
||||||
# "matches_any": `"values": [`"value": "US", "value": "CN"`]`
|
|
||||||
# `
|
|
||||||
# ],
|
|
||||||
# "sort_conditions": [
|
|
||||||
# `"dimension":"APP", order: "ASCENDING"`
|
|
||||||
# ],
|
|
||||||
# "localization_settings": `
|
|
||||||
# "currency_code": "USD",
|
|
||||||
# "language_code": "en-US"
|
|
||||||
# `
|
|
||||||
# `
|
|
||||||
# For a better understanding, you can treat the preceding specification like
|
|
||||||
# the following pseudo SQL:
|
|
||||||
# SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM
|
|
||||||
# FROM MEDIATION_REPORT
|
|
||||||
# WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30'
|
|
||||||
# AND COUNTRY IN ('US', 'CN')
|
|
||||||
# GROUP BY AD_SOURCE, APP, COUNTRY
|
|
||||||
# ORDER BY APP ASC;
|
|
||||||
class MediationReportSpec
|
class MediationReportSpec
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -436,8 +331,8 @@ module Google
|
||||||
attr_accessor :dimension_filters
|
attr_accessor :dimension_filters
|
||||||
|
|
||||||
# List of dimensions of the report. The value combination of these dimensions
|
# List of dimensions of the report. The value combination of these dimensions
|
||||||
# determines the row of the report. If no dimensions are specified, the
|
# determines the row of the report. If no dimensions are specified, the report
|
||||||
# report returns a single row of requested metrics for the entire account.
|
# returns a single row of requested metrics for the entire account.
|
||||||
# Corresponds to the JSON property `dimensions`
|
# Corresponds to the JSON property `dimensions`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :dimensions
|
attr_accessor :dimensions
|
||||||
|
|
@ -448,9 +343,9 @@ module Google
|
||||||
# @return [Google::Apis::AdmobV1::LocalizationSettings]
|
# @return [Google::Apis::AdmobV1::LocalizationSettings]
|
||||||
attr_accessor :localization_settings
|
attr_accessor :localization_settings
|
||||||
|
|
||||||
# Maximum number of report data rows to return. If the value is not set, the
|
# Maximum number of report data rows to return. If the value is not set, the API
|
||||||
# API returns as many rows as possible, up to 100000. Acceptable values are
|
# returns as many rows as possible, up to 100000. Acceptable values are 1-100000,
|
||||||
# 1-100000, inclusive. Any other values are treated as 100000.
|
# inclusive. Any other values are treated as 100000.
|
||||||
# Corresponds to the JSON property `maxReportRows`
|
# Corresponds to the JSON property `maxReportRows`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :max_report_rows
|
attr_accessor :max_report_rows
|
||||||
|
|
@ -460,19 +355,17 @@ module Google
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :metrics
|
attr_accessor :metrics
|
||||||
|
|
||||||
# Describes the sorting of report rows. The order of the condition in the
|
# Describes the sorting of report rows. The order of the condition in the list
|
||||||
# list defines its precedence; the earlier the condition, the higher its
|
# defines its precedence; the earlier the condition, the higher its precedence.
|
||||||
# precedence. If no sort conditions are specified, the row ordering is
|
# If no sort conditions are specified, the row ordering is undefined.
|
||||||
# undefined.
|
|
||||||
# Corresponds to the JSON property `sortConditions`
|
# Corresponds to the JSON property `sortConditions`
|
||||||
# @return [Array<Google::Apis::AdmobV1::MediationReportSpecSortCondition>]
|
# @return [Array<Google::Apis::AdmobV1::MediationReportSpecSortCondition>]
|
||||||
attr_accessor :sort_conditions
|
attr_accessor :sort_conditions
|
||||||
|
|
||||||
# A report time zone. Accepts an IANA TZ name values, such as
|
# A report time zone. Accepts an IANA TZ name values, such as "America/
|
||||||
# "America/Los_Angeles." If no time zone is defined, the account default
|
# Los_Angeles." If no time zone is defined, the account default takes effect.
|
||||||
# takes effect. Check default value by the get account action.
|
# Check default value by the get account action. **Warning:** The "America/
|
||||||
# **Warning:** The "America/Los_Angeles" is the only supported value at
|
# Los_Angeles" is the only supported value at the moment.
|
||||||
# the moment.
|
|
||||||
# Corresponds to the JSON property `timeZone`
|
# Corresponds to the JSON property `timeZone`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :time_zone
|
attr_accessor :time_zone
|
||||||
|
|
@ -550,39 +443,20 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# The specification for generating an AdMob Network report.
|
# The specification for generating an AdMob Network report. For example, the
|
||||||
# For example, the specification to get clicks and estimated earnings for only
|
# specification to get clicks and estimated earnings for only the 'US' and 'CN'
|
||||||
# the 'US' and 'CN' countries can look like the following example:
|
# countries can look like the following example: ` 'date_range': ` 'start_date':
|
||||||
# `
|
# `'year': 2018, 'month': 9, 'day': 1`, 'end_date': `'year': 2018, 'month': 9, '
|
||||||
# 'date_range': `
|
# day': 30` `, 'dimensions': ['DATE', 'APP', 'COUNTRY'], 'metrics': ['CLICKS', '
|
||||||
# 'start_date': `'year': 2018, 'month': 9, 'day': 1`,
|
# ESTIMATED_EARNINGS'], 'dimension_filters': [ ` 'dimension': 'COUNTRY', '
|
||||||
# 'end_date': `'year': 2018, 'month': 9, 'day': 30`
|
# matches_any': `'values': [`'value': 'US', 'value': 'CN'`]` ` ], '
|
||||||
# `,
|
# sort_conditions': [ `'dimension':'APP', order: 'ASCENDING'`, `'metric':'CLICKS'
|
||||||
# 'dimensions': ['DATE', 'APP', 'COUNTRY'],
|
# , order: 'DESCENDING'` ], 'localization_settings': ` 'currency_code': 'USD', '
|
||||||
# 'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'],
|
# language_code': 'en-US' ` ` For a better understanding, you can treat the
|
||||||
# 'dimension_filters': [
|
# preceding specification like the following pseudo SQL: SELECT DATE, APP,
|
||||||
# `
|
# COUNTRY, CLICKS, ESTIMATED_EARNINGS FROM NETWORK_REPORT WHERE DATE >= '2018-09-
|
||||||
# 'dimension': 'COUNTRY',
|
# 01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP,
|
||||||
# 'matches_any': `'values': [`'value': 'US', 'value': 'CN'`]`
|
# COUNTRY ORDER BY APP ASC, CLICKS DESC;
|
||||||
# `
|
|
||||||
# ],
|
|
||||||
# 'sort_conditions': [
|
|
||||||
# `'dimension':'APP', order: 'ASCENDING'`,
|
|
||||||
# `'metric':'CLICKS', order: 'DESCENDING'`
|
|
||||||
# ],
|
|
||||||
# 'localization_settings': `
|
|
||||||
# 'currency_code': 'USD',
|
|
||||||
# 'language_code': 'en-US'
|
|
||||||
# `
|
|
||||||
# `
|
|
||||||
# For a better understanding, you can treat the preceding specification like
|
|
||||||
# the following pseudo SQL:
|
|
||||||
# SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS
|
|
||||||
# FROM NETWORK_REPORT
|
|
||||||
# WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30'
|
|
||||||
# AND COUNTRY IN ('US', 'CN')
|
|
||||||
# GROUP BY DATE, APP, COUNTRY
|
|
||||||
# ORDER BY APP ASC, CLICKS DESC;
|
|
||||||
class NetworkReportSpec
|
class NetworkReportSpec
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -597,8 +471,8 @@ module Google
|
||||||
attr_accessor :dimension_filters
|
attr_accessor :dimension_filters
|
||||||
|
|
||||||
# List of dimensions of the report. The value combination of these dimensions
|
# List of dimensions of the report. The value combination of these dimensions
|
||||||
# determines the row of the report. If no dimensions are specified, the
|
# determines the row of the report. If no dimensions are specified, the report
|
||||||
# report returns a single row of requested metrics for the entire account.
|
# returns a single row of requested metrics for the entire account.
|
||||||
# Corresponds to the JSON property `dimensions`
|
# Corresponds to the JSON property `dimensions`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :dimensions
|
attr_accessor :dimensions
|
||||||
|
|
@ -609,9 +483,9 @@ module Google
|
||||||
# @return [Google::Apis::AdmobV1::LocalizationSettings]
|
# @return [Google::Apis::AdmobV1::LocalizationSettings]
|
||||||
attr_accessor :localization_settings
|
attr_accessor :localization_settings
|
||||||
|
|
||||||
# Maximum number of report data rows to return. If the value is not set, the
|
# Maximum number of report data rows to return. If the value is not set, the API
|
||||||
# API returns as many rows as possible, up to 100000. Acceptable values are
|
# returns as many rows as possible, up to 100000. Acceptable values are 1-100000,
|
||||||
# 1-100000, inclusive. Any other values are treated as 100000.
|
# inclusive. Any other values are treated as 100000.
|
||||||
# Corresponds to the JSON property `maxReportRows`
|
# Corresponds to the JSON property `maxReportRows`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :max_report_rows
|
attr_accessor :max_report_rows
|
||||||
|
|
@ -621,19 +495,17 @@ module Google
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :metrics
|
attr_accessor :metrics
|
||||||
|
|
||||||
# Describes the sorting of report rows. The order of the condition in the
|
# Describes the sorting of report rows. The order of the condition in the list
|
||||||
# list defines its precedence; the earlier the condition, the higher its
|
# defines its precedence; the earlier the condition, the higher its precedence.
|
||||||
# precedence. If no sort conditions are specified, the row ordering is
|
# If no sort conditions are specified, the row ordering is undefined.
|
||||||
# undefined.
|
|
||||||
# Corresponds to the JSON property `sortConditions`
|
# Corresponds to the JSON property `sortConditions`
|
||||||
# @return [Array<Google::Apis::AdmobV1::NetworkReportSpecSortCondition>]
|
# @return [Array<Google::Apis::AdmobV1::NetworkReportSpecSortCondition>]
|
||||||
attr_accessor :sort_conditions
|
attr_accessor :sort_conditions
|
||||||
|
|
||||||
# A report time zone. Accepts an IANA TZ name values, such as
|
# A report time zone. Accepts an IANA TZ name values, such as "America/
|
||||||
# "America/Los_Angeles." If no time zone is defined, the account default
|
# Los_Angeles." If no time zone is defined, the account default takes effect.
|
||||||
# takes effect. Check default value by the get account action.
|
# Check default value by the get account action. **Warning:** The "America/
|
||||||
# **Warning:** The "America/Los_Angeles" is the only supported value at
|
# Los_Angeles" is the only supported value at the moment.
|
||||||
# the moment.
|
|
||||||
# Corresponds to the JSON property `timeZone`
|
# Corresponds to the JSON property `timeZone`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :time_zone
|
attr_accessor :time_zone
|
||||||
|
|
@ -711,8 +583,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A publisher account contains information relevant to the use of this API,
|
# A publisher account contains information relevant to the use of this API, such
|
||||||
# such as the time zone used for the reports.
|
# as the time zone used for the reports.
|
||||||
class PublisherAccount
|
class PublisherAccount
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -723,21 +595,20 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :currency_code
|
attr_accessor :currency_code
|
||||||
|
|
||||||
# Resource name of this account.
|
# Resource name of this account. Format is accounts/`publisher_id`.
|
||||||
# Format is accounts/`publisher_id`.
|
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# The unique ID by which this publisher account can be identified
|
# The unique ID by which this publisher account can be identified in the API
|
||||||
# in the API requests (for example, pub-1234567890).
|
# requests (for example, pub-1234567890).
|
||||||
# Corresponds to the JSON property `publisherId`
|
# Corresponds to the JSON property `publisherId`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :publisher_id
|
attr_accessor :publisher_id
|
||||||
|
|
||||||
# The time zone that is used in reports that are generated for this account.
|
# The time zone that is used in reports that are generated for this account. The
|
||||||
# The value is a time-zone ID as specified by the CLDR project,
|
# value is a time-zone ID as specified by the CLDR project, for example, "
|
||||||
# for example, "America/Los_Angeles".
|
# America/Los_Angeles".
|
||||||
# Corresponds to the JSON property `reportingTimeZone`
|
# Corresponds to the JSON property `reportingTimeZone`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :reporting_time_zone
|
attr_accessor :reporting_time_zone
|
||||||
|
|
@ -760,9 +631,9 @@ module Google
|
||||||
class ReportFooter
|
class ReportFooter
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Total number of rows that matched the request.
|
# Total number of rows that matched the request. Warning: This count does NOT
|
||||||
# Warning: This count does NOT always match the number of rows in the
|
# always match the number of rows in the response. Do not make that assumption
|
||||||
# response. Do not make that assumption when processing the response.
|
# when processing the response.
|
||||||
# Corresponds to the JSON property `matchingRowCount`
|
# Corresponds to the JSON property `matchingRowCount`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :matching_row_count
|
attr_accessor :matching_row_count
|
||||||
|
|
@ -826,9 +697,8 @@ module Google
|
||||||
# @return [Hash<String,Google::Apis::AdmobV1::ReportRowDimensionValue>]
|
# @return [Hash<String,Google::Apis::AdmobV1::ReportRowDimensionValue>]
|
||||||
attr_accessor :dimension_values
|
attr_accessor :dimension_values
|
||||||
|
|
||||||
# Map of metric values in a row, with keys as enum name of the metrics. If
|
# Map of metric values in a row, with keys as enum name of the metrics. If a
|
||||||
# a metric being requested has no value returned, the map will not include
|
# metric being requested has no value returned, the map will not include it.
|
||||||
# it.
|
|
||||||
# Corresponds to the JSON property `metricValues`
|
# Corresponds to the JSON property `metricValues`
|
||||||
# @return [Hash<String,Google::Apis::AdmobV1::ReportRowMetricValue>]
|
# @return [Hash<String,Google::Apis::AdmobV1::ReportRowMetricValue>]
|
||||||
attr_accessor :metric_values
|
attr_accessor :metric_values
|
||||||
|
|
@ -848,14 +718,13 @@ module Google
|
||||||
class ReportRowDimensionValue
|
class ReportRowDimensionValue
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The localized string representation of the value. If unspecified, the
|
# The localized string representation of the value. If unspecified, the display
|
||||||
# display label should be derived from the value.
|
# label should be derived from the value.
|
||||||
# Corresponds to the JSON property `displayLabel`
|
# Corresponds to the JSON property `displayLabel`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :display_label
|
attr_accessor :display_label
|
||||||
|
|
||||||
# Dimension value in the format specified in the report's spec Dimension
|
# Dimension value in the format specified in the report's spec Dimension enum.
|
||||||
# enum.
|
|
||||||
# Corresponds to the JSON property `value`
|
# Corresponds to the JSON property `value`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :value
|
attr_accessor :value
|
||||||
|
|
@ -885,9 +754,9 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :integer_value
|
attr_accessor :integer_value
|
||||||
|
|
||||||
# Amount in micros. One million is equivalent to one unit. Currency value
|
# Amount in micros. One million is equivalent to one unit. Currency value is in
|
||||||
# is in the unit (USD, EUR or other) specified by the request.
|
# the unit (USD, EUR or other) specified by the request. For example, $6.50
|
||||||
# For example, $6.50 whould be represented as 6500000 micros.
|
# whould be represented as 6500000 micros.
|
||||||
# Corresponds to the JSON property `microsValue`
|
# Corresponds to the JSON property `microsValue`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :micros_value
|
attr_accessor :micros_value
|
||||||
|
|
|
||||||
|
|
@ -49,8 +49,8 @@ module Google
|
||||||
|
|
||||||
# Gets information about the specified AdMob publisher account.
|
# Gets information about the specified AdMob publisher account.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Resource name of the publisher account to retrieve.
|
# Resource name of the publisher account to retrieve. Example: accounts/pub-
|
||||||
# Example: accounts/pub-9876543210987654
|
# 9876543210987654
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -83,9 +83,9 @@ module Google
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# Maximum number of accounts to return.
|
# Maximum number of accounts to return.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The value returned by the last `ListPublisherAccountsResponse`; indicates
|
# The value returned by the last `ListPublisherAccountsResponse`; indicates that
|
||||||
# that this is a continuation of a prior `ListPublisherAccounts` call, and
|
# this is a continuation of a prior `ListPublisherAccounts` call, and that the
|
||||||
# that the system should return the next page of data.
|
# system should return the next page of data.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -114,11 +114,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Generates an AdMob Mediation report based on the provided report
|
# Generates an AdMob Mediation report based on the provided report specification.
|
||||||
# specification.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Resource name of the account to generate the report for.
|
# Resource name of the account to generate the report for. Example: accounts/pub-
|
||||||
# Example: accounts/pub-9876543210987654
|
# 9876543210987654
|
||||||
# @param [Google::Apis::AdmobV1::GenerateMediationReportRequest] generate_mediation_report_request_object
|
# @param [Google::Apis::AdmobV1::GenerateMediationReportRequest] generate_mediation_report_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -149,11 +148,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Generates an AdMob Network report based on the provided report
|
# Generates an AdMob Network report based on the provided report specification.
|
||||||
# specification.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Resource name of the account to generate the report for.
|
# Resource name of the account to generate the report for. Example: accounts/pub-
|
||||||
# Example: accounts/pub-9876543210987654
|
# 9876543210987654
|
||||||
# @param [Google::Apis::AdmobV1::GenerateNetworkReportRequest] generate_network_report_request_object
|
# @param [Google::Apis::AdmobV1::GenerateNetworkReportRequest] generate_network_report_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ module Google
|
||||||
# @see https://developers.google.com/zero-touch/
|
# @see https://developers.google.com/zero-touch/
|
||||||
module AndroiddeviceprovisioningV1
|
module AndroiddeviceprovisioningV1
|
||||||
VERSION = 'V1'
|
VERSION = 'V1'
|
||||||
REVISION = '20200701'
|
REVISION = '20200801'
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
||||||
|
|
@ -31,15 +31,15 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :customer_id
|
attr_accessor :customer_id
|
||||||
|
|
||||||
# Encapsulates hardware and product IDs to identify a manufactured device.
|
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
||||||
# To understand requirements on identifier sets, read
|
# understand requirements on identifier sets, read [Identifiers](https://
|
||||||
# [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
|
# developers.google.com/zero-touch/guides/identifiers).
|
||||||
# Corresponds to the JSON property `deviceIdentifier`
|
# Corresponds to the JSON property `deviceIdentifier`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
||||||
attr_accessor :device_identifier
|
attr_accessor :device_identifier
|
||||||
|
|
||||||
# Metadata entries that can be attached to a `Device`. To learn more, read
|
# Metadata entries that can be attached to a `Device`. To learn more, read [
|
||||||
# [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
# Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
||||||
# Corresponds to the JSON property `deviceMetadata`
|
# Corresponds to the JSON property `deviceMetadata`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata]
|
||||||
attr_accessor :device_metadata
|
attr_accessor :device_metadata
|
||||||
|
|
@ -71,8 +71,8 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :device_id
|
attr_accessor :device_id
|
||||||
|
|
||||||
# The resource name of the device in the format
|
# The resource name of the device in the format `partners/[PARTNER_ID]/devices/[
|
||||||
# `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
|
# DEVICE_ID]`.
|
||||||
# Corresponds to the JSON property `deviceName`
|
# Corresponds to the JSON property `deviceName`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :device_name
|
attr_accessor :device_name
|
||||||
|
|
@ -89,8 +89,8 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Request to claim devices asynchronously in batch. Claiming a device adds the
|
# Request to claim devices asynchronously in batch. Claiming a device adds the
|
||||||
# device to zero-touch enrollment and shows the device in the customer's view
|
# device to zero-touch enrollment and shows the device in the customer's view of
|
||||||
# of the portal.
|
# the portal.
|
||||||
class ClaimDevicesRequest
|
class ClaimDevicesRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -113,8 +113,8 @@ module Google
|
||||||
class Company
|
class Company
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Optional. Email address of customer's users in the admin role.
|
# Optional. Email address of customer's users in the admin role. Each email
|
||||||
# Each email address must be associated with a Google Account.
|
# address must be associated with a Google Account.
|
||||||
# Corresponds to the JSON property `adminEmails`
|
# Corresponds to the JSON property `adminEmails`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :admin_emails
|
attr_accessor :admin_emails
|
||||||
|
|
@ -130,28 +130,24 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :company_name
|
attr_accessor :company_name
|
||||||
|
|
||||||
# Output only. The API resource name of the company. The resource name is one
|
# Output only. The API resource name of the company. The resource name is one of
|
||||||
# of the following formats:
|
# the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `
|
||||||
# * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`
|
# partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[
|
||||||
# * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`
|
# VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server.
|
||||||
# * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]`
|
|
||||||
# Assigned by the server.
|
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# Required. Input only. Email address of customer's users in the owner role. At
|
# Required. Input only. Email address of customer's users in the owner role. At
|
||||||
# least
|
# least one `owner_email` is required. Each email address must be associated
|
||||||
# one `owner_email` is required. Each email address must be associated with a
|
# with a Google Account. Owners share the same access as admins but can also add,
|
||||||
# Google Account. Owners share the same access as admins but can also add,
|
|
||||||
# delete, and edit your organization's portal users.
|
# delete, and edit your organization's portal users.
|
||||||
# Corresponds to the JSON property `ownerEmails`
|
# Corresponds to the JSON property `ownerEmails`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :owner_emails
|
attr_accessor :owner_emails
|
||||||
|
|
||||||
# Output only. Whether any user from the company has accepted the latest
|
# Output only. Whether any user from the company has accepted the latest Terms
|
||||||
# Terms of Service (ToS). See
|
# of Service (ToS). See TermsStatus.
|
||||||
# TermsStatus.
|
|
||||||
# Corresponds to the JSON property `termsStatus`
|
# Corresponds to the JSON property `termsStatus`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :terms_status
|
attr_accessor :terms_status
|
||||||
|
|
@ -172,13 +168,12 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# A configuration collects the provisioning options for Android devices. Each
|
# A configuration collects the provisioning options for Android devices. Each
|
||||||
# configuration combines the following:
|
# configuration combines the following: * The EMM device policy controller (DPC)
|
||||||
# * The EMM device policy controller (DPC) installed on the devices.
|
# installed on the devices. * EMM policies enforced on the devices. * Metadata
|
||||||
# * EMM policies enforced on the devices.
|
# displayed on the device to help users during setup. Customers can add as many
|
||||||
# * Metadata displayed on the device to help users during setup.
|
# configurations as they need. However, zero-touch enrollment works best when a
|
||||||
# Customers can add as many configurations as they need. However, zero-touch
|
# customer sets a default configuration that's applied to any new devices the
|
||||||
# enrollment works best when a customer sets a default configuration that's
|
# organization purchases.
|
||||||
# applied to any new devices the organization purchases.
|
|
||||||
class Configuration
|
class Configuration
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -193,31 +188,31 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :configuration_id
|
attr_accessor :configuration_id
|
||||||
|
|
||||||
# Required. A short name that describes the configuration's purpose. For
|
# Required. A short name that describes the configuration's purpose. For example,
|
||||||
# example, _Sales team_ or _Temporary employees_. The zero-touch enrollment
|
# _Sales team_ or _Temporary employees_. The zero-touch enrollment portal
|
||||||
# portal displays this name to IT admins.
|
# displays this name to IT admins.
|
||||||
# Corresponds to the JSON property `configurationName`
|
# Corresponds to the JSON property `configurationName`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :configuration_name
|
attr_accessor :configuration_name
|
||||||
|
|
||||||
# Required. The email address that device users can contact to get help.
|
# Required. The email address that device users can contact to get help. Zero-
|
||||||
# Zero-touch enrollment shows this email address to device users before
|
# touch enrollment shows this email address to device users before device
|
||||||
# device provisioning. The value is validated on input.
|
# provisioning. The value is validated on input.
|
||||||
# Corresponds to the JSON property `contactEmail`
|
# Corresponds to the JSON property `contactEmail`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :contact_email
|
attr_accessor :contact_email
|
||||||
|
|
||||||
# Required. The telephone number that device users can call, using another
|
# Required. The telephone number that device users can call, using another
|
||||||
# device, to get help. Zero-touch enrollment shows this number to device
|
# device, to get help. Zero-touch enrollment shows this number to device users
|
||||||
# users before device provisioning. Accepts numerals, spaces, the plus sign,
|
# before device provisioning. Accepts numerals, spaces, the plus sign, hyphens,
|
||||||
# hyphens, and parentheses.
|
# and parentheses.
|
||||||
# Corresponds to the JSON property `contactPhone`
|
# Corresponds to the JSON property `contactPhone`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :contact_phone
|
attr_accessor :contact_phone
|
||||||
|
|
||||||
# A message, containing one or two sentences, to help device users get help
|
# A message, containing one or two sentences, to help device users get help or
|
||||||
# or give them more details about what’s happening to their device.
|
# give them more details about what’s happening to their device. Zero-touch
|
||||||
# Zero-touch enrollment shows this message before the device is provisioned.
|
# enrollment shows this message before the device is provisioned.
|
||||||
# Corresponds to the JSON property `customMessage`
|
# Corresponds to the JSON property `customMessage`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :custom_message
|
attr_accessor :custom_message
|
||||||
|
|
@ -227,27 +222,24 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :dpc_extras
|
attr_accessor :dpc_extras
|
||||||
|
|
||||||
# Required. The resource name of the selected DPC (device policy controller)
|
# Required. The resource name of the selected DPC (device policy controller) in
|
||||||
# in the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,
|
# the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs, call `
|
||||||
# call
|
# customers.dpcs.list`.
|
||||||
# `customers.dpcs.list`.
|
|
||||||
# Corresponds to the JSON property `dpcResourcePath`
|
# Corresponds to the JSON property `dpcResourcePath`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :dpc_resource_path
|
attr_accessor :dpc_resource_path
|
||||||
|
|
||||||
# Required. Whether this is the default configuration that zero-touch
|
# Required. Whether this is the default configuration that zero-touch enrollment
|
||||||
# enrollment applies to any new devices the organization purchases in the
|
# applies to any new devices the organization purchases in the future. Only one
|
||||||
# future. Only one customer configuration can be the default. Setting this
|
# customer configuration can be the default. Setting this value to `true`,
|
||||||
# value to `true`, changes the previous default configuration's `isDefault`
|
# changes the previous default configuration's `isDefault` value to `false`.
|
||||||
# value to `false`.
|
|
||||||
# Corresponds to the JSON property `isDefault`
|
# Corresponds to the JSON property `isDefault`
|
||||||
# @return [Boolean]
|
# @return [Boolean]
|
||||||
attr_accessor :is_default
|
attr_accessor :is_default
|
||||||
alias_method :is_default?, :is_default
|
alias_method :is_default?, :is_default
|
||||||
|
|
||||||
# Output only. The API resource name in the format
|
# Output only. The API resource name in the format `customers/[CUSTOMER_ID]/
|
||||||
# `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
|
# configurations/[CONFIGURATION_ID]`. Assigned by the server.
|
||||||
# the server.
|
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
@ -294,21 +286,19 @@ module Google
|
||||||
class CustomerApplyConfigurationRequest
|
class CustomerApplyConfigurationRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Required. The configuration applied to the device in the format
|
# Required. The configuration applied to the device in the format `customers/[
|
||||||
# `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
|
# CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
|
||||||
# Corresponds to the JSON property `configuration`
|
# Corresponds to the JSON property `configuration`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :configuration
|
attr_accessor :configuration
|
||||||
|
|
||||||
# A `DeviceReference` is an API abstraction that lets you supply a _device_
|
# A `DeviceReference` is an API abstraction that lets you supply a _device_
|
||||||
# argument to a method using one of the following identifier types:
|
# argument to a method using one of the following identifier types: * A numeric
|
||||||
# * A numeric API resource ID.
|
# API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to
|
||||||
# * Real-world hardware IDs, such as IMEI number, belonging to the manufactured
|
# the manufactured device. Methods that operate on devices take a `
|
||||||
# device.
|
# DeviceReference` as a parameter type because it's more flexible for the caller.
|
||||||
# Methods that operate on devices take a `DeviceReference` as a parameter type
|
# To learn more about device identifiers, read [Identifiers](https://developers.
|
||||||
# because it's more flexible for the caller. To learn more about device
|
# google.com/zero-touch/guides/identifiers).
|
||||||
# identifiers, read
|
|
||||||
# [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
|
|
||||||
# Corresponds to the JSON property `device`
|
# Corresponds to the JSON property `device`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceReference]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceReference]
|
||||||
attr_accessor :device
|
attr_accessor :device
|
||||||
|
|
@ -352,8 +342,8 @@ module Google
|
||||||
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Company>]
|
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Company>]
|
||||||
attr_accessor :customers
|
attr_accessor :customers
|
||||||
|
|
||||||
# A token used to access the next page of results. Omitted if no further
|
# A token used to access the next page of results. Omitted if no further results
|
||||||
# results are available.
|
# are available.
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -378,8 +368,8 @@ module Google
|
||||||
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Device>]
|
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Device>]
|
||||||
attr_accessor :devices
|
attr_accessor :devices
|
||||||
|
|
||||||
# A token used to access the next page of results. Omitted if no further
|
# A token used to access the next page of results. Omitted if no further results
|
||||||
# results are available.
|
# are available.
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -399,8 +389,7 @@ module Google
|
||||||
class CustomerListDpcsResponse
|
class CustomerListDpcsResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The list of DPCs available to the customer that support zero-touch
|
# The list of DPCs available to the customer that support zero-touch enrollment.
|
||||||
# enrollment.
|
|
||||||
# Corresponds to the JSON property `dpcs`
|
# Corresponds to the JSON property `dpcs`
|
||||||
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Dpc>]
|
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Dpc>]
|
||||||
attr_accessor :dpcs
|
attr_accessor :dpcs
|
||||||
|
|
@ -420,14 +409,12 @@ module Google
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# A `DeviceReference` is an API abstraction that lets you supply a _device_
|
# A `DeviceReference` is an API abstraction that lets you supply a _device_
|
||||||
# argument to a method using one of the following identifier types:
|
# argument to a method using one of the following identifier types: * A numeric
|
||||||
# * A numeric API resource ID.
|
# API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to
|
||||||
# * Real-world hardware IDs, such as IMEI number, belonging to the manufactured
|
# the manufactured device. Methods that operate on devices take a `
|
||||||
# device.
|
# DeviceReference` as a parameter type because it's more flexible for the caller.
|
||||||
# Methods that operate on devices take a `DeviceReference` as a parameter type
|
# To learn more about device identifiers, read [Identifiers](https://developers.
|
||||||
# because it's more flexible for the caller. To learn more about device
|
# google.com/zero-touch/guides/identifiers).
|
||||||
# identifiers, read
|
|
||||||
# [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
|
|
||||||
# Corresponds to the JSON property `device`
|
# Corresponds to the JSON property `device`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceReference]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceReference]
|
||||||
attr_accessor :device
|
attr_accessor :device
|
||||||
|
|
@ -447,14 +434,12 @@ module Google
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# A `DeviceReference` is an API abstraction that lets you supply a _device_
|
# A `DeviceReference` is an API abstraction that lets you supply a _device_
|
||||||
# argument to a method using one of the following identifier types:
|
# argument to a method using one of the following identifier types: * A numeric
|
||||||
# * A numeric API resource ID.
|
# API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to
|
||||||
# * Real-world hardware IDs, such as IMEI number, belonging to the manufactured
|
# the manufactured device. Methods that operate on devices take a `
|
||||||
# device.
|
# DeviceReference` as a parameter type because it's more flexible for the caller.
|
||||||
# Methods that operate on devices take a `DeviceReference` as a parameter type
|
# To learn more about device identifiers, read [Identifiers](https://developers.
|
||||||
# because it's more flexible for the caller. To learn more about device
|
# google.com/zero-touch/guides/identifiers).
|
||||||
# identifiers, read
|
|
||||||
# [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
|
|
||||||
# Corresponds to the JSON property `device`
|
# Corresponds to the JSON property `device`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceReference]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceReference]
|
||||||
attr_accessor :device
|
attr_accessor :device
|
||||||
|
|
@ -473,13 +458,10 @@ module Google
|
||||||
class Device
|
class Device
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Output only. The provisioning claims for a device. Devices claimed for
|
# Output only. The provisioning claims for a device. Devices claimed for zero-
|
||||||
# zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`.
|
# touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. Call `
|
||||||
# Call
|
# partners.devices.unclaim` or `partners.devices.unclaimAsync` to remove the
|
||||||
# `partners.devices.unclaim`
|
# device from zero-touch enrollment.
|
||||||
# or
|
|
||||||
# `partners.devices.unclaimAsync`
|
|
||||||
# to remove the device from zero-touch enrollment.
|
|
||||||
# Corresponds to the JSON property `claims`
|
# Corresponds to the JSON property `claims`
|
||||||
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::DeviceClaim>]
|
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::DeviceClaim>]
|
||||||
attr_accessor :claims
|
attr_accessor :claims
|
||||||
|
|
@ -494,21 +476,21 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :device_id
|
attr_accessor :device_id
|
||||||
|
|
||||||
# Encapsulates hardware and product IDs to identify a manufactured device.
|
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
||||||
# To understand requirements on identifier sets, read
|
# understand requirements on identifier sets, read [Identifiers](https://
|
||||||
# [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
|
# developers.google.com/zero-touch/guides/identifiers).
|
||||||
# Corresponds to the JSON property `deviceIdentifier`
|
# Corresponds to the JSON property `deviceIdentifier`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
||||||
attr_accessor :device_identifier
|
attr_accessor :device_identifier
|
||||||
|
|
||||||
# Metadata entries that can be attached to a `Device`. To learn more, read
|
# Metadata entries that can be attached to a `Device`. To learn more, read [
|
||||||
# [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
# Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
||||||
# Corresponds to the JSON property `deviceMetadata`
|
# Corresponds to the JSON property `deviceMetadata`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata]
|
||||||
attr_accessor :device_metadata
|
attr_accessor :device_metadata
|
||||||
|
|
||||||
# Output only. The API resource name in the format
|
# Output only. The API resource name in the format `partners/[PARTNER_ID]/
|
||||||
# `partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.
|
# devices/[DEVICE_ID]`. Assigned by the server.
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
@ -528,10 +510,10 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A record of a device claimed by a reseller for a customer. Devices claimed
|
# A record of a device claimed by a reseller for a customer. Devices claimed for
|
||||||
# for zero-touch enrollment have a claim with the type
|
# zero-touch enrollment have a claim with the type `SECTION_TYPE_ZERO_TOUCH`. To
|
||||||
# `SECTION_TYPE_ZERO_TOUCH`. To learn more, read
|
# learn more, read [Claim devices for customers](/zero-touch/guides/how-it-works#
|
||||||
# [Claim devices for customers](/zero-touch/guides/how-it-works#claim).
|
# claim).
|
||||||
class DeviceClaim
|
class DeviceClaim
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -550,8 +532,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :section_type
|
attr_accessor :section_type
|
||||||
|
|
||||||
# The timestamp when the device will exit ‘vacation mode’. This value is
|
# The timestamp when the device will exit ‘vacation mode’. This value is present
|
||||||
# present iff the device is in 'vacation mode'.
|
# iff the device is in 'vacation mode'.
|
||||||
# Corresponds to the JSON property `vacationModeExpireTime`
|
# Corresponds to the JSON property `vacationModeExpireTime`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :vacation_mode_expire_time
|
attr_accessor :vacation_mode_expire_time
|
||||||
|
|
@ -576,9 +558,9 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Encapsulates hardware and product IDs to identify a manufactured device.
|
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
||||||
# To understand requirements on identifier sets, read
|
# understand requirements on identifier sets, read [Identifiers](https://
|
||||||
# [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
|
# developers.google.com/zero-touch/guides/identifiers).
|
||||||
class DeviceIdentifier
|
class DeviceIdentifier
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -587,10 +569,9 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :imei
|
attr_accessor :imei
|
||||||
|
|
||||||
# The device manufacturer’s name. Matches the device's built-in
|
# The device manufacturer’s name. Matches the device's built-in value returned
|
||||||
# value returned from `android.os.Build.MANUFACTURER`. Allowed values are
|
# from `android.os.Build.MANUFACTURER`. Allowed values are listed in [
|
||||||
# listed in
|
# manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
|
||||||
# [manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).
|
|
||||||
# Corresponds to the JSON property `manufacturer`
|
# Corresponds to the JSON property `manufacturer`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :manufacturer
|
attr_accessor :manufacturer
|
||||||
|
|
@ -600,9 +581,9 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :meid
|
attr_accessor :meid
|
||||||
|
|
||||||
# The device model's name. Matches the device's built-in value returned from
|
# The device model's name. Matches the device's built-in value returned from `
|
||||||
# `android.os.Build.MODEL`. Allowed values are listed in
|
# android.os.Build.MODEL`. Allowed values are listed in [models](/zero-touch/
|
||||||
# [models](/zero-touch/resources/manufacturer-names#model-names).
|
# resources/manufacturer-names#model-names).
|
||||||
# Corresponds to the JSON property `model`
|
# Corresponds to the JSON property `model`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :model
|
attr_accessor :model
|
||||||
|
|
@ -627,8 +608,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Metadata entries that can be attached to a `Device`. To learn more, read
|
# Metadata entries that can be attached to a `Device`. To learn more, read [
|
||||||
# [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
# Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
||||||
class DeviceMetadata
|
class DeviceMetadata
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -648,14 +629,12 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# A `DeviceReference` is an API abstraction that lets you supply a _device_
|
# A `DeviceReference` is an API abstraction that lets you supply a _device_
|
||||||
# argument to a method using one of the following identifier types:
|
# argument to a method using one of the following identifier types: * A numeric
|
||||||
# * A numeric API resource ID.
|
# API resource ID. * Real-world hardware IDs, such as IMEI number, belonging to
|
||||||
# * Real-world hardware IDs, such as IMEI number, belonging to the manufactured
|
# the manufactured device. Methods that operate on devices take a `
|
||||||
# device.
|
# DeviceReference` as a parameter type because it's more flexible for the caller.
|
||||||
# Methods that operate on devices take a `DeviceReference` as a parameter type
|
# To learn more about device identifiers, read [Identifiers](https://developers.
|
||||||
# because it's more flexible for the caller. To learn more about device
|
# google.com/zero-touch/guides/identifiers).
|
||||||
# identifiers, read
|
|
||||||
# [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
|
|
||||||
class DeviceReference
|
class DeviceReference
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -664,9 +643,9 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :device_id
|
attr_accessor :device_id
|
||||||
|
|
||||||
# Encapsulates hardware and product IDs to identify a manufactured device.
|
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
||||||
# To understand requirements on identifier sets, read
|
# understand requirements on identifier sets, read [Identifiers](https://
|
||||||
# [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
|
# developers.google.com/zero-touch/guides/identifiers).
|
||||||
# Corresponds to the JSON property `deviceIdentifier`
|
# Corresponds to the JSON property `deviceIdentifier`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
||||||
attr_accessor :device_identifier
|
attr_accessor :device_identifier
|
||||||
|
|
@ -682,15 +661,15 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Tracks the status of a long-running operation to asynchronously update a
|
# Tracks the status of a long-running operation to asynchronously update a batch
|
||||||
# batch of reseller metadata attached to devices. To learn more, read
|
# of reseller metadata attached to devices. To learn more, read [Long‑running
|
||||||
# [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
|
# batch operations](/zero-touch/guides/how-it-works#operations).
|
||||||
class DevicesLongRunningOperationMetadata
|
class DevicesLongRunningOperationMetadata
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The number of metadata updates in the operation. This might be different
|
# The number of metadata updates in the operation. This might be different from
|
||||||
# from the number of updates in the request if the API can't parse some of
|
# the number of updates in the request if the API can't parse some of the
|
||||||
# the updates.
|
# updates.
|
||||||
# Corresponds to the JSON property `devicesCount`
|
# Corresponds to the JSON property `devicesCount`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :devices_count
|
attr_accessor :devices_count
|
||||||
|
|
@ -700,9 +679,9 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :processing_status
|
attr_accessor :processing_status
|
||||||
|
|
||||||
# The processing progress of the operation. Measured as a number from 0 to
|
# The processing progress of the operation. Measured as a number from 0 to 100.
|
||||||
# 100. A value of 10O doesnt always mean the operation completed—check for
|
# A value of 10O doesnt always mean the operation completed—check for the
|
||||||
# the inclusion of a `done` field.
|
# inclusion of a `done` field.
|
||||||
# Corresponds to the JSON property `progress`
|
# Corresponds to the JSON property `progress`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :progress
|
attr_accessor :progress
|
||||||
|
|
@ -720,20 +699,19 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Tracks the status of a long-running operation to claim, unclaim, or attach
|
# Tracks the status of a long-running operation to claim, unclaim, or attach
|
||||||
# metadata to devices. To learn more, read
|
# metadata to devices. To learn more, read [Long‑running batch operations](/zero-
|
||||||
# [Long‑running batch operations](/zero-touch/guides/how-it-works#operations).
|
# touch/guides/how-it-works#operations).
|
||||||
class DevicesLongRunningOperationResponse
|
class DevicesLongRunningOperationResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The processing status for each device in the operation.
|
# The processing status for each device in the operation. One `PerDeviceStatus`
|
||||||
# One `PerDeviceStatus` per device. The list order matches the items in the
|
# per device. The list order matches the items in the original request.
|
||||||
# original request.
|
|
||||||
# Corresponds to the JSON property `perDeviceStatus`
|
# Corresponds to the JSON property `perDeviceStatus`
|
||||||
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::OperationPerDevice>]
|
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::OperationPerDevice>]
|
||||||
attr_accessor :per_device_status
|
attr_accessor :per_device_status
|
||||||
|
|
||||||
# A summary of how many items in the operation the server processed
|
# A summary of how many items in the operation the server processed successfully.
|
||||||
# successfully. Updated as the operation progresses.
|
# Updated as the operation progresses.
|
||||||
# Corresponds to the JSON property `successCount`
|
# Corresponds to the JSON property `successCount`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :success_count
|
attr_accessor :success_count
|
||||||
|
|
@ -749,11 +727,11 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# An EMM's DPC ([device policy
|
# An EMM's DPC ([device policy controller](http://developer.android.com/work/dpc/
|
||||||
# controller](http://developer.android.com/work/dpc/build-dpc.html)).
|
# build-dpc.html)). Zero-touch enrollment installs a DPC (listed in the `
|
||||||
# Zero-touch enrollment installs a DPC (listed in the `Configuration`) on a
|
# Configuration`) on a device to maintain the customer's mobile policies. All
|
||||||
# device to maintain the customer's mobile policies. All the DPCs listed by the
|
# the DPCs listed by the API support zero-touch enrollment and are available in
|
||||||
# API support zero-touch enrollment and are available in Google Play.
|
# Google Play.
|
||||||
class Dpc
|
class Dpc
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -763,17 +741,16 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :dpc_name
|
attr_accessor :dpc_name
|
||||||
|
|
||||||
# Output only. The API resource name in the format
|
# Output only. The API resource name in the format `customers/[CUSTOMER_ID]/dpcs/
|
||||||
# `customers/[CUSTOMER_ID]/dpcs/[DPC_ID]`. Assigned by
|
# [DPC_ID]`. Assigned by the server. To maintain a reference to a DPC across
|
||||||
# the server. To maintain a reference to a DPC across customer accounts,
|
# customer accounts, persist and match the last path component (`DPC_ID`).
|
||||||
# persist and match the last path component (`DPC_ID`).
|
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# Output only. The DPC's Android application ID that looks like a Java
|
# Output only. The DPC's Android application ID that looks like a Java package
|
||||||
# package name. Zero-touch enrollment installs the DPC app onto a device
|
# name. Zero-touch enrollment installs the DPC app onto a device using this
|
||||||
# using this identifier.
|
# identifier.
|
||||||
# Corresponds to the JSON property `packageName`
|
# Corresponds to the JSON property `packageName`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :package_name
|
attr_accessor :package_name
|
||||||
|
|
@ -790,13 +767,11 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A generic empty message that you can re-use to avoid defining duplicated
|
# A generic empty message that you can re-use to avoid defining duplicated empty
|
||||||
# empty messages in your APIs. A typical example is to use it as the request
|
# messages in your APIs. A typical example is to use it as the request or the
|
||||||
# or the response type of an API method. For instance:
|
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
||||||
# service Foo `
|
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
||||||
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
# `Empty` is empty JSON object ````.
|
||||||
# `
|
|
||||||
# The JSON representation for `Empty` is empty JSON object ````.
|
|
||||||
class Empty
|
class Empty
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -813,15 +788,15 @@ module Google
|
||||||
class FindDevicesByDeviceIdentifierRequest
|
class FindDevicesByDeviceIdentifierRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Encapsulates hardware and product IDs to identify a manufactured device.
|
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
||||||
# To understand requirements on identifier sets, read
|
# understand requirements on identifier sets, read [Identifiers](https://
|
||||||
# [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
|
# developers.google.com/zero-touch/guides/identifiers).
|
||||||
# Corresponds to the JSON property `deviceIdentifier`
|
# Corresponds to the JSON property `deviceIdentifier`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
||||||
attr_accessor :device_identifier
|
attr_accessor :device_identifier
|
||||||
|
|
||||||
# Required. The maximum number of devices to show in a page of results. Must
|
# Required. The maximum number of devices to show in a page of results. Must be
|
||||||
# be between 1 and 100 inclusive.
|
# between 1 and 100 inclusive.
|
||||||
# Corresponds to the JSON property `limit`
|
# Corresponds to the JSON property `limit`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :limit
|
attr_accessor :limit
|
||||||
|
|
@ -852,8 +827,8 @@ module Google
|
||||||
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Device>]
|
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Device>]
|
||||||
attr_accessor :devices
|
attr_accessor :devices
|
||||||
|
|
||||||
# A token used to access the next page of results. Omitted if no further
|
# A token used to access the next page of results. Omitted if no further results
|
||||||
# results are available.
|
# are available.
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -884,8 +859,8 @@ module Google
|
||||||
# @return [Array<Fixnum>]
|
# @return [Array<Fixnum>]
|
||||||
attr_accessor :customer_id
|
attr_accessor :customer_id
|
||||||
|
|
||||||
# Required. The maximum number of devices to show in a page of results. Must
|
# Required. The maximum number of devices to show in a page of results. Must be
|
||||||
# be between 1 and 100 inclusive.
|
# between 1 and 100 inclusive.
|
||||||
# Corresponds to the JSON property `limit`
|
# Corresponds to the JSON property `limit`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :limit
|
attr_accessor :limit
|
||||||
|
|
@ -922,8 +897,8 @@ module Google
|
||||||
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Device>]
|
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Device>]
|
||||||
attr_accessor :devices
|
attr_accessor :devices
|
||||||
|
|
||||||
# A token used to access the next page of results.
|
# A token used to access the next page of results. Omitted if no further results
|
||||||
# Omitted if no further results are available.
|
# are available.
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -1024,8 +999,8 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :total_size
|
attr_accessor :total_size
|
||||||
|
|
||||||
# List of vendors of the reseller partner. Fields `name`, `companyId` and
|
# List of vendors of the reseller partner. Fields `name`, `companyId` and `
|
||||||
# `companyName` are populated to the Company object.
|
# companyName` are populated to the Company object.
|
||||||
# Corresponds to the JSON property `vendors`
|
# Corresponds to the JSON property `vendors`
|
||||||
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Company>]
|
# @return [Array<Google::Apis::AndroiddeviceprovisioningV1::Company>]
|
||||||
attr_accessor :vendors
|
attr_accessor :vendors
|
||||||
|
|
@ -1047,20 +1022,19 @@ module Google
|
||||||
class Operation
|
class Operation
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# If the value is `false`, it means the operation is still in progress.
|
# If the value is `false`, it means the operation is still in progress. If `true`
|
||||||
# If `true`, the operation is completed, and either `error` or `response` is
|
# , the operation is completed, and either `error` or `response` is available.
|
||||||
# available.
|
|
||||||
# Corresponds to the JSON property `done`
|
# Corresponds to the JSON property `done`
|
||||||
# @return [Boolean]
|
# @return [Boolean]
|
||||||
attr_accessor :done
|
attr_accessor :done
|
||||||
alias_method :done?, :done
|
alias_method :done?, :done
|
||||||
|
|
||||||
# The `Status` type defines a logical error model that is suitable for
|
# The `Status` type defines a logical error model that is suitable for different
|
||||||
# different programming environments, including REST APIs and RPC APIs. It is
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
||||||
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
||||||
# three pieces of data: error code, error message, and error details.
|
# data: error code, error message, and error details. You can find out more
|
||||||
# You can find out more about this error model and how to work with it in the
|
# about this error model and how to work with it in the [API Design Guide](https:
|
||||||
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
# //cloud.google.com/apis/design/errors).
|
||||||
# Corresponds to the JSON property `error`
|
# Corresponds to the JSON property `error`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::Status]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::Status]
|
||||||
attr_accessor :error
|
attr_accessor :error
|
||||||
|
|
@ -1072,8 +1046,8 @@ module Google
|
||||||
attr_accessor :metadata
|
attr_accessor :metadata
|
||||||
|
|
||||||
# The server-assigned name, which is only unique within the same service that
|
# The server-assigned name, which is only unique within the same service that
|
||||||
# originally returns it. If you use the default HTTP mapping, the
|
# originally returns it. If you use the default HTTP mapping, the `name` should
|
||||||
# `name` should be a resource name ending with `operations/`unique_id``.
|
# be a resource name ending with `operations/`unique_id``.
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
@ -1098,8 +1072,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A task for each device in the operation. Corresponds to each device
|
# A task for each device in the operation. Corresponds to each device change in
|
||||||
# change in the request.
|
# the request.
|
||||||
class OperationPerDevice
|
class OperationPerDevice
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -1145,15 +1119,15 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :customer_id
|
attr_accessor :customer_id
|
||||||
|
|
||||||
# Encapsulates hardware and product IDs to identify a manufactured device.
|
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
||||||
# To understand requirements on identifier sets, read
|
# understand requirements on identifier sets, read [Identifiers](https://
|
||||||
# [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
|
# developers.google.com/zero-touch/guides/identifiers).
|
||||||
# Corresponds to the JSON property `deviceIdentifier`
|
# Corresponds to the JSON property `deviceIdentifier`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
||||||
attr_accessor :device_identifier
|
attr_accessor :device_identifier
|
||||||
|
|
||||||
# Metadata entries that can be attached to a `Device`. To learn more, read
|
# Metadata entries that can be attached to a `Device`. To learn more, read [
|
||||||
# [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
# Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
||||||
# Corresponds to the JSON property `deviceMetadata`
|
# Corresponds to the JSON property `deviceMetadata`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata]
|
||||||
attr_accessor :device_metadata
|
attr_accessor :device_metadata
|
||||||
|
|
@ -1185,9 +1159,9 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :device_id
|
attr_accessor :device_id
|
||||||
|
|
||||||
# Encapsulates hardware and product IDs to identify a manufactured device.
|
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
||||||
# To understand requirements on identifier sets, read
|
# understand requirements on identifier sets, read [Identifiers](https://
|
||||||
# [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
|
# developers.google.com/zero-touch/guides/identifiers).
|
||||||
# Corresponds to the JSON property `deviceIdentifier`
|
# Corresponds to the JSON property `deviceIdentifier`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
||||||
attr_accessor :device_identifier
|
attr_accessor :device_identifier
|
||||||
|
|
@ -1198,8 +1172,7 @@ module Google
|
||||||
attr_accessor :section_type
|
attr_accessor :section_type
|
||||||
|
|
||||||
# Optional. The duration of the vacation unlock starting from when the request
|
# Optional. The duration of the vacation unlock starting from when the request
|
||||||
# is
|
# is processed. (1 day is treated as 24 hours)
|
||||||
# processed. (1 day is treated as 24 hours)
|
|
||||||
# Corresponds to the JSON property `vacationModeDays`
|
# Corresponds to the JSON property `vacationModeDays`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :vacation_mode_days
|
attr_accessor :vacation_mode_days
|
||||||
|
|
@ -1260,12 +1233,12 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# The `Status` type defines a logical error model that is suitable for
|
# The `Status` type defines a logical error model that is suitable for different
|
||||||
# different programming environments, including REST APIs and RPC APIs. It is
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
||||||
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
||||||
# three pieces of data: error code, error message, and error details.
|
# data: error code, error message, and error details. You can find out more
|
||||||
# You can find out more about this error model and how to work with it in the
|
# about this error model and how to work with it in the [API Design Guide](https:
|
||||||
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
# //cloud.google.com/apis/design/errors).
|
||||||
class Status
|
class Status
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -1274,15 +1247,15 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :code
|
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.
|
# message types for APIs to use.
|
||||||
# Corresponds to the JSON property `details`
|
# Corresponds to the JSON property `details`
|
||||||
# @return [Array<Hash<String,Object>>]
|
# @return [Array<Hash<String,Object>>]
|
||||||
attr_accessor :details
|
attr_accessor :details
|
||||||
|
|
||||||
# A developer-facing error message, which should be in English. Any
|
# A developer-facing error message, which should be in English. Any user-facing
|
||||||
# user-facing error message should be localized and sent in the
|
# error message should be localized and sent in the google.rpc.Status.details
|
||||||
# google.rpc.Status.details field, or localized by the client.
|
# field, or localized by the client.
|
||||||
# Corresponds to the JSON property `message`
|
# Corresponds to the JSON property `message`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :message
|
attr_accessor :message
|
||||||
|
|
@ -1308,9 +1281,9 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :device_id
|
attr_accessor :device_id
|
||||||
|
|
||||||
# Encapsulates hardware and product IDs to identify a manufactured device.
|
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
||||||
# To understand requirements on identifier sets, read
|
# understand requirements on identifier sets, read [Identifiers](https://
|
||||||
# [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
|
# developers.google.com/zero-touch/guides/identifiers).
|
||||||
# Corresponds to the JSON property `deviceIdentifier`
|
# Corresponds to the JSON property `deviceIdentifier`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
||||||
attr_accessor :device_identifier
|
attr_accessor :device_identifier
|
||||||
|
|
@ -1387,8 +1360,8 @@ module Google
|
||||||
class UpdateDeviceMetadataRequest
|
class UpdateDeviceMetadataRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Metadata entries that can be attached to a `Device`. To learn more, read
|
# Metadata entries that can be attached to a `Device`. To learn more, read [
|
||||||
# [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
# Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
||||||
# Corresponds to the JSON property `deviceMetadata`
|
# Corresponds to the JSON property `deviceMetadata`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata]
|
||||||
attr_accessor :device_metadata
|
attr_accessor :device_metadata
|
||||||
|
|
@ -1412,15 +1385,15 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :device_id
|
attr_accessor :device_id
|
||||||
|
|
||||||
# Encapsulates hardware and product IDs to identify a manufactured device.
|
# Encapsulates hardware and product IDs to identify a manufactured device. To
|
||||||
# To understand requirements on identifier sets, read
|
# understand requirements on identifier sets, read [Identifiers](https://
|
||||||
# [Identifiers](https://developers.google.com/zero-touch/guides/identifiers).
|
# developers.google.com/zero-touch/guides/identifiers).
|
||||||
# Corresponds to the JSON property `deviceIdentifier`
|
# Corresponds to the JSON property `deviceIdentifier`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceIdentifier]
|
||||||
attr_accessor :device_identifier
|
attr_accessor :device_identifier
|
||||||
|
|
||||||
# Metadata entries that can be attached to a `Device`. To learn more, read
|
# Metadata entries that can be attached to a `Device`. To learn more, read [
|
||||||
# [Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
# Device metadata](https://developers.google.com/zero-touch/guides/metadata).
|
||||||
# Corresponds to the JSON property `deviceMetadata`
|
# Corresponds to the JSON property `deviceMetadata`
|
||||||
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata]
|
# @return [Google::Apis::AndroiddeviceprovisioningV1::DeviceMetadata]
|
||||||
attr_accessor :device_metadata
|
attr_accessor :device_metadata
|
||||||
|
|
|
||||||
|
|
@ -50,8 +50,8 @@ module Google
|
||||||
|
|
||||||
# Lists the user's customer accounts.
|
# Lists the user's customer accounts.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of customers to show in a page of results.
|
# The maximum number of customers to show in a page of results. A number between
|
||||||
# A number between 1 and 100 (inclusive).
|
# 1 and 100 (inclusive).
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A token specifying which result page to return.
|
# A token specifying which result page to return.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -85,8 +85,8 @@ module Google
|
||||||
# Creates a new configuration. Once created, a customer can apply the
|
# Creates a new configuration. Once created, a customer can apply the
|
||||||
# configuration to devices.
|
# configuration to devices.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The customer that manages the configuration. An API resource name
|
# Required. The customer that manages the configuration. An API resource name in
|
||||||
# in the format `customers/[CUSTOMER_ID]`.
|
# the format `customers/[CUSTOMER_ID]`.
|
||||||
# @param [Google::Apis::AndroiddeviceprovisioningV1::Configuration] configuration_object
|
# @param [Google::Apis::AndroiddeviceprovisioningV1::Configuration] configuration_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -120,8 +120,8 @@ module Google
|
||||||
# Deletes an unused configuration. The API call fails if the customer has
|
# Deletes an unused configuration. The API call fails if the customer has
|
||||||
# devices with the configuration applied.
|
# devices with the configuration applied.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The configuration to delete. An API resource name in the format
|
# Required. The configuration to delete. An API resource name in the format `
|
||||||
# `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the
|
# customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the
|
||||||
# configuration is applied to any devices, the API call fails.
|
# configuration is applied to any devices, the API call fails.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -152,8 +152,8 @@ module Google
|
||||||
|
|
||||||
# Gets the details of a configuration.
|
# Gets the details of a configuration.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The configuration to get. An API resource name in the format
|
# Required. The configuration to get. An API resource name in the format `
|
||||||
# `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
|
# customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -183,8 +183,8 @@ module Google
|
||||||
|
|
||||||
# Lists a customer's configurations.
|
# Lists a customer's configurations.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The customer that manages the listed configurations. An API
|
# Required. The customer that manages the listed configurations. An API resource
|
||||||
# resource name in the format `customers/[CUSTOMER_ID]`.
|
# name in the format `customers/[CUSTOMER_ID]`.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -214,15 +214,14 @@ module Google
|
||||||
|
|
||||||
# Updates a configuration's field values.
|
# Updates a configuration's field values.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Output only. The API resource name in the format
|
# Output only. The API resource name in the format `customers/[CUSTOMER_ID]/
|
||||||
# `customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by
|
# configurations/[CONFIGURATION_ID]`. Assigned by the server.
|
||||||
# the server.
|
|
||||||
# @param [Google::Apis::AndroiddeviceprovisioningV1::Configuration] configuration_object
|
# @param [Google::Apis::AndroiddeviceprovisioningV1::Configuration] configuration_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# Required. The field mask applied to the target `Configuration` before
|
# Required. The field mask applied to the target `Configuration` before updating
|
||||||
# updating the fields. To learn more about using field masks, read
|
# the fields. To learn more about using field masks, read [FieldMask](/protocol-
|
||||||
# [FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in
|
# buffers/docs/reference/google.protobuf#fieldmask) in the Protocol Buffers
|
||||||
# the Protocol Buffers documentation.
|
# documentation.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -257,8 +256,8 @@ module Google
|
||||||
# enrollment. After applying a configuration to a device, the device
|
# enrollment. After applying a configuration to a device, the device
|
||||||
# automatically provisions itself on first boot, or next factory reset.
|
# automatically provisions itself on first boot, or next factory reset.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The customer managing the device. An API resource name in the
|
# Required. The customer managing the device. An API resource name in the format
|
||||||
# format `customers/[CUSTOMER_ID]`.
|
# `customers/[CUSTOMER_ID]`.
|
||||||
# @param [Google::Apis::AndroiddeviceprovisioningV1::CustomerApplyConfigurationRequest] customer_apply_configuration_request_object
|
# @param [Google::Apis::AndroiddeviceprovisioningV1::CustomerApplyConfigurationRequest] customer_apply_configuration_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -291,8 +290,8 @@ module Google
|
||||||
|
|
||||||
# Gets the details of a device.
|
# Gets the details of a device.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The device to get. An API resource name in the format
|
# Required. The device to get. An API resource name in the format `customers/[
|
||||||
# `customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`.
|
# CUSTOMER_ID]/devices/[DEVICE_ID]`.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -325,8 +324,8 @@ module Google
|
||||||
# Required. The customer managing the devices. An API resource name in the
|
# Required. The customer managing the devices. An API resource name in the
|
||||||
# format `customers/[CUSTOMER_ID]`.
|
# format `customers/[CUSTOMER_ID]`.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of devices to show in a page of results.
|
# The maximum number of devices to show in a page of results. Must be between 1
|
||||||
# Must be between 1 and 100 inclusive.
|
# and 100 inclusive.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A token specifying which result page to return.
|
# A token specifying which result page to return.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -360,8 +359,8 @@ module Google
|
||||||
|
|
||||||
# Removes a configuration from device.
|
# Removes a configuration from device.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The customer managing the device in the format
|
# Required. The customer managing the device in the format `customers/[
|
||||||
# `customers/[CUSTOMER_ID]`.
|
# CUSTOMER_ID]`.
|
||||||
# @param [Google::Apis::AndroiddeviceprovisioningV1::CustomerRemoveConfigurationRequest] customer_remove_configuration_request_object
|
# @param [Google::Apis::AndroiddeviceprovisioningV1::CustomerRemoveConfigurationRequest] customer_remove_configuration_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -392,13 +391,12 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Unclaims a device from a customer and removes it from zero-touch
|
# Unclaims a device from a customer and removes it from zero-touch enrollment.
|
||||||
# enrollment.
|
|
||||||
# After removing a device, a customer must contact their reseller to register
|
# After removing a device, a customer must contact their reseller to register
|
||||||
# the device into zero-touch enrollment again.
|
# the device into zero-touch enrollment again.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The customer managing the device. An API resource name in the
|
# Required. The customer managing the device. An API resource name in the format
|
||||||
# format `customers/[CUSTOMER_ID]`.
|
# `customers/[CUSTOMER_ID]`.
|
||||||
# @param [Google::Apis::AndroiddeviceprovisioningV1::CustomerUnclaimDeviceRequest] customer_unclaim_device_request_object
|
# @param [Google::Apis::AndroiddeviceprovisioningV1::CustomerUnclaimDeviceRequest] customer_unclaim_device_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -429,8 +427,7 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists the DPCs (device policy controllers) that support zero-touch
|
# Lists the DPCs (device policy controllers) that support zero-touch enrollment.
|
||||||
# enrollment.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The customer that can use the DPCs in configurations. An API
|
# Required. The customer that can use the DPCs in configurations. An API
|
||||||
# resource name in the format `customers/[CUSTOMER_ID]`.
|
# resource name in the format `customers/[CUSTOMER_ID]`.
|
||||||
|
|
@ -461,9 +458,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the latest state of a long-running operation. Clients can use this
|
# Gets the latest state of a long-running operation. Clients can use this method
|
||||||
# method to poll the operation result at intervals as recommended by the API
|
# to poll the operation result at intervals as recommended by the API service.
|
||||||
# service.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource.
|
# The name of the operation resource.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -494,10 +490,10 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Creates a customer for zero-touch enrollment. After the method returns
|
# Creates a customer for zero-touch enrollment. After the method returns
|
||||||
# successfully, admin and owner roles can manage devices and EMM configs
|
# successfully, admin and owner roles can manage devices and EMM configs by
|
||||||
# by calling API methods or using their zero-touch enrollment portal.
|
# calling API methods or using their zero-touch enrollment portal. The customer
|
||||||
# The customer receives an email that welcomes them to zero-touch enrollment
|
# receives an email that welcomes them to zero-touch enrollment and explains how
|
||||||
# and explains how to sign into the portal.
|
# to sign into the portal.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The parent resource ID in the format `partners/[PARTNER_ID]` that
|
# Required. The parent resource ID in the format `partners/[PARTNER_ID]` that
|
||||||
# identifies the reseller.
|
# identifies the reseller.
|
||||||
|
|
@ -531,14 +527,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists the customers that are enrolled to the reseller identified by the
|
# Lists the customers that are enrolled to the reseller identified by the `
|
||||||
# `partnerId` argument. This list includes customers that the reseller
|
# partnerId` argument. This list includes customers that the reseller created
|
||||||
# created and customers that enrolled themselves using the portal.
|
# and customers that enrolled themselves using the portal.
|
||||||
# @param [Fixnum] partner_id
|
# @param [Fixnum] partner_id
|
||||||
# Required. The ID of the reseller partner.
|
# Required. The ID of the reseller partner.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of results to be returned. If not specified or 0, all
|
# The maximum number of results to be returned. If not specified or 0, all the
|
||||||
# the records are returned.
|
# records are returned.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A token identifying a page of results returned by the server.
|
# A token identifying a page of results returned by the server.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -604,9 +600,9 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Claims a batch of devices for a customer asynchronously. Adds the devices
|
# Claims a batch of devices for a customer asynchronously. Adds the devices to
|
||||||
# to zero-touch enrollment. To learn more, read [Long‑running batch
|
# zero-touch enrollment. To learn more, read [Long‑running batch operations](/
|
||||||
# operations](/zero-touch/guides/how-it-works#operations).
|
# zero-touch/guides/how-it-works#operations).
|
||||||
# @param [Fixnum] partner_id
|
# @param [Fixnum] partner_id
|
||||||
# Required. The ID of the reseller partner.
|
# Required. The ID of the reseller partner.
|
||||||
# @param [Google::Apis::AndroiddeviceprovisioningV1::ClaimDevicesRequest] claim_devices_request_object
|
# @param [Google::Apis::AndroiddeviceprovisioningV1::ClaimDevicesRequest] claim_devices_request_object
|
||||||
|
|
@ -673,9 +669,8 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Finds devices claimed for customers. The results only contain devices
|
# Finds devices claimed for customers. The results only contain devices
|
||||||
# registered to the reseller that's identified by the `partnerId` argument.
|
# registered to the reseller that's identified by the `partnerId` argument. The
|
||||||
# The customer's devices purchased from other resellers don't appear in the
|
# customer's devices purchased from other resellers don't appear in the results.
|
||||||
# results.
|
|
||||||
# @param [Fixnum] partner_id
|
# @param [Fixnum] partner_id
|
||||||
# Required. The ID of the reseller partner.
|
# Required. The ID of the reseller partner.
|
||||||
# @param [Google::Apis::AndroiddeviceprovisioningV1::FindDevicesByOwnerRequest] find_devices_by_owner_request_object
|
# @param [Google::Apis::AndroiddeviceprovisioningV1::FindDevicesByOwnerRequest] find_devices_by_owner_request_object
|
||||||
|
|
@ -710,8 +705,8 @@ module Google
|
||||||
|
|
||||||
# Gets a device.
|
# Gets a device.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The device API resource name in the format
|
# Required. The device API resource name in the format `partners/[PARTNER_ID]/
|
||||||
# `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.
|
# devices/[DEVICE_ID]`.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -775,8 +770,7 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Unclaims a device from a customer and removes it from zero-touch
|
# Unclaims a device from a customer and removes it from zero-touch enrollment.
|
||||||
# enrollment.
|
|
||||||
# @param [Fixnum] partner_id
|
# @param [Fixnum] partner_id
|
||||||
# Required. The ID of the reseller partner.
|
# Required. The ID of the reseller partner.
|
||||||
# @param [Google::Apis::AndroiddeviceprovisioningV1::UnclaimDeviceRequest] unclaim_device_request_object
|
# @param [Google::Apis::AndroiddeviceprovisioningV1::UnclaimDeviceRequest] unclaim_device_request_object
|
||||||
|
|
@ -809,9 +803,9 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Unclaims a batch of devices for a customer asynchronously. Removes the
|
# Unclaims a batch of devices for a customer asynchronously. Removes the devices
|
||||||
# devices from zero-touch enrollment. To learn more, read [Long‑running batch
|
# from zero-touch enrollment. To learn more, read [Long‑running batch operations]
|
||||||
# operations](/zero-touch/guides/how-it-works#operations).
|
# (/zero-touch/guides/how-it-works#operations).
|
||||||
# @param [Fixnum] partner_id
|
# @param [Fixnum] partner_id
|
||||||
# Required. The reseller partner ID.
|
# Required. The reseller partner ID.
|
||||||
# @param [Google::Apis::AndroiddeviceprovisioningV1::UnclaimDevicesRequest] unclaim_devices_request_object
|
# @param [Google::Apis::AndroiddeviceprovisioningV1::UnclaimDevicesRequest] unclaim_devices_request_object
|
||||||
|
|
@ -845,9 +839,9 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Updates the reseller metadata attached to a batch of devices. This method
|
# Updates the reseller metadata attached to a batch of devices. This method
|
||||||
# updates devices asynchronously and returns an `Operation` that can be used
|
# updates devices asynchronously and returns an `Operation` that can be used to
|
||||||
# to track progress. Read [Long‑running batch
|
# track progress. Read [Long‑running batch operations](/zero-touch/guides/how-it-
|
||||||
# operations](/zero-touch/guides/how-it-works#operations).
|
# works#operations).
|
||||||
# @param [Fixnum] partner_id
|
# @param [Fixnum] partner_id
|
||||||
# Required. The reseller partner ID.
|
# Required. The reseller partner ID.
|
||||||
# @param [Google::Apis::AndroiddeviceprovisioningV1::UpdateDeviceMetadataInBatchRequest] update_device_metadata_in_batch_request_object
|
# @param [Google::Apis::AndroiddeviceprovisioningV1::UpdateDeviceMetadataInBatchRequest] update_device_metadata_in_batch_request_object
|
||||||
|
|
@ -918,8 +912,8 @@ module Google
|
||||||
|
|
||||||
# Lists the customers of the vendor.
|
# Lists the customers of the vendor.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The resource name in the format
|
# Required. The resource name in the format `partners/[PARTNER_ID]/vendors/[
|
||||||
# `partners/[PARTNER_ID]/vendors/[VENDOR_ID]`.
|
# VENDOR_ID]`.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of results to be returned.
|
# The maximum number of results to be returned.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ module Google
|
||||||
# @see https://developers.google.com/android-publisher
|
# @see https://developers.google.com/android-publisher
|
||||||
module AndroidpublisherV3
|
module AndroidpublisherV3
|
||||||
VERSION = 'V3'
|
VERSION = 'V3'
|
||||||
REVISION = '20200701'
|
REVISION = '20200801'
|
||||||
|
|
||||||
# View and manage your Google Play Developer account
|
# View and manage your Google Play Developer account
|
||||||
AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher'
|
AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher'
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -212,8 +212,8 @@ module Google
|
||||||
|
|
||||||
# Creates a new APK without uploading the APK itself to Google Play, instead
|
# Creates a new APK without uploading the APK itself to Google Play, instead
|
||||||
# hosting the APK at a specified URL. This function is only available to
|
# hosting the APK at a specified URL. This function is only available to
|
||||||
# organizations using Managed Play whose application is configured to
|
# organizations using Managed Play whose application is configured to restrict
|
||||||
# restrict distribution to the organizations.
|
# distribution to the organizations.
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# Package name of the app.
|
# Package name of the app.
|
||||||
# @param [String] edit_id
|
# @param [String] edit_id
|
||||||
|
|
@ -358,22 +358,19 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Uploads a new Android App Bundle to this edit.
|
# Uploads a new Android App Bundle to this edit. If you are using the Google API
|
||||||
# If you are using the Google API client libraries, please increase the
|
# client libraries, please increase the timeout of the http request before
|
||||||
# timeout of the http request before calling this endpoint
|
# calling this endpoint (a timeout of 2 minutes is recommended). See [Timeouts
|
||||||
# (a timeout of 2 minutes is recommended).
|
# and Errors](https://developers.google.com/api-client-library/java/google-api-
|
||||||
# See [Timeouts and
|
# java-client/errors) for an example in java.
|
||||||
# Errors](https://developers.google.com/api-client-library/java/google-api-java-
|
|
||||||
# client/errors)
|
|
||||||
# for an example in java.
|
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# Package name of the app.
|
# Package name of the app.
|
||||||
# @param [String] edit_id
|
# @param [String] edit_id
|
||||||
# Identifier of the edit.
|
# Identifier of the edit.
|
||||||
# @param [Boolean] ack_bundle_installation_warning
|
# @param [Boolean] ack_bundle_installation_warning
|
||||||
# Must be set to true if the bundle installation may trigger a warning on
|
# Must be set to true if the bundle installation may trigger a warning on user
|
||||||
# user devices (for example, if installation size may be over a threshold,
|
# devices (for example, if installation size may be over a threshold, typically
|
||||||
# typically 100 MB).
|
# 100 MB).
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -419,8 +416,7 @@ module Google
|
||||||
# @param [String] edit_id
|
# @param [String] edit_id
|
||||||
# Unique identifier for this edit.
|
# Unique identifier for this edit.
|
||||||
# @param [Fixnum] apk_version_code
|
# @param [Fixnum] apk_version_code
|
||||||
# The version code of the APK whose Deobfuscation File is being
|
# The version code of the APK whose Deobfuscation File is being uploaded.
|
||||||
# uploaded.
|
|
||||||
# @param [String] deobfuscation_file_type
|
# @param [String] deobfuscation_file_type
|
||||||
# The type of the deobfuscation file.
|
# The type of the deobfuscation file.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -574,8 +570,8 @@ module Google
|
||||||
# @param [String] edit_id
|
# @param [String] edit_id
|
||||||
# Identifier of the edit.
|
# Identifier of the edit.
|
||||||
# @param [Fixnum] apk_version_code
|
# @param [Fixnum] apk_version_code
|
||||||
# The version code of the APK whose expansion file configuration is being
|
# The version code of the APK whose expansion file configuration is being read
|
||||||
# read or modified.
|
# or modified.
|
||||||
# @param [String] expansion_file_type
|
# @param [String] expansion_file_type
|
||||||
# The file type of the file configuration which is being read or modified.
|
# The file type of the file configuration which is being read or modified.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -609,15 +605,14 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Patches the APK's expansion file configuration to reference another APK's
|
# Patches the APK's expansion file configuration to reference another APK's
|
||||||
# expansion file.
|
# expansion file. To add a new expansion file use the Upload method.
|
||||||
# To add a new expansion file use the Upload method.
|
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# Package name of the app.
|
# Package name of the app.
|
||||||
# @param [String] edit_id
|
# @param [String] edit_id
|
||||||
# Identifier of the edit.
|
# Identifier of the edit.
|
||||||
# @param [Fixnum] apk_version_code
|
# @param [Fixnum] apk_version_code
|
||||||
# The version code of the APK whose expansion file configuration is being
|
# The version code of the APK whose expansion file configuration is being read
|
||||||
# read or modified.
|
# or modified.
|
||||||
# @param [String] expansion_file_type
|
# @param [String] expansion_file_type
|
||||||
# The file type of the expansion file configuration which is being updated.
|
# The file type of the expansion file configuration which is being updated.
|
||||||
# @param [Google::Apis::AndroidpublisherV3::ExpansionFile] expansion_file_object
|
# @param [Google::Apis::AndroidpublisherV3::ExpansionFile] expansion_file_object
|
||||||
|
|
@ -654,15 +649,14 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Updates the APK's expansion file configuration to reference another APK's
|
# Updates the APK's expansion file configuration to reference another APK's
|
||||||
# expansion file.
|
# expansion file. To add a new expansion file use the Upload method.
|
||||||
# To add a new expansion file use the Upload method.
|
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# Package name of the app.
|
# Package name of the app.
|
||||||
# @param [String] edit_id
|
# @param [String] edit_id
|
||||||
# Identifier of the edit.
|
# Identifier of the edit.
|
||||||
# @param [Fixnum] apk_version_code
|
# @param [Fixnum] apk_version_code
|
||||||
# The version code of the APK whose expansion file configuration is being
|
# The version code of the APK whose expansion file configuration is being read
|
||||||
# read or modified.
|
# or modified.
|
||||||
# @param [String] expansion_file_type
|
# @param [String] expansion_file_type
|
||||||
# The file type of the file configuration which is being read or modified.
|
# The file type of the file configuration which is being read or modified.
|
||||||
# @param [Google::Apis::AndroidpublisherV3::ExpansionFile] expansion_file_object
|
# @param [Google::Apis::AndroidpublisherV3::ExpansionFile] expansion_file_object
|
||||||
|
|
@ -704,8 +698,8 @@ module Google
|
||||||
# @param [String] edit_id
|
# @param [String] edit_id
|
||||||
# Identifier of the edit.
|
# Identifier of the edit.
|
||||||
# @param [Fixnum] apk_version_code
|
# @param [Fixnum] apk_version_code
|
||||||
# The version code of the APK whose expansion file configuration is being
|
# The version code of the APK whose expansion file configuration is being read
|
||||||
# read or modified.
|
# or modified.
|
||||||
# @param [String] expansion_file_type
|
# @param [String] expansion_file_type
|
||||||
# The file type of the expansion file configuration which is being updated.
|
# The file type of the expansion file configuration which is being updated.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -754,8 +748,8 @@ module Google
|
||||||
# @param [String] edit_id
|
# @param [String] edit_id
|
||||||
# Identifier of the edit.
|
# Identifier of the edit.
|
||||||
# @param [String] language
|
# @param [String] language
|
||||||
# Language localization code (a BCP-47 language tag; for example, "de-AT"
|
# Language localization code (a BCP-47 language tag; for example, "de-AT" for
|
||||||
# for Austrian German).
|
# Austrian German).
|
||||||
# @param [String] image_type
|
# @param [String] image_type
|
||||||
# Type of the Image.
|
# Type of the Image.
|
||||||
# @param [String] image_id
|
# @param [String] image_id
|
||||||
|
|
@ -789,19 +783,18 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Deletes all images for the specified language and image type.
|
# Deletes all images for the specified language and image type. Returns an empty
|
||||||
# Returns an empty response if no images are found.
|
# response if no images are found.
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# Package name of the app.
|
# Package name of the app.
|
||||||
# @param [String] edit_id
|
# @param [String] edit_id
|
||||||
# Identifier of the edit.
|
# Identifier of the edit.
|
||||||
# @param [String] language
|
# @param [String] language
|
||||||
# Language localization code (a BCP-47 language tag; for example, "de-AT"
|
# Language localization code (a BCP-47 language tag; for example, "de-AT" for
|
||||||
# for Austrian German).
|
# Austrian German). Providing a language that is not supported by the App is a
|
||||||
# Providing a language that is not supported by the App is a no-op.
|
# no-op.
|
||||||
# @param [String] image_type
|
# @param [String] image_type
|
||||||
# Type of the Image.
|
# Type of the Image. Providing an image type that refers to no images is a no-op.
|
||||||
# Providing an image type that refers to no images is a no-op.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -838,9 +831,8 @@ module Google
|
||||||
# @param [String] edit_id
|
# @param [String] edit_id
|
||||||
# Identifier of the edit.
|
# Identifier of the edit.
|
||||||
# @param [String] language
|
# @param [String] language
|
||||||
# Language localization code (a BCP-47 language tag; for example, "de-AT"
|
# Language localization code (a BCP-47 language tag; for example, "de-AT" for
|
||||||
# for Austrian German).
|
# Austrian German). There must be a store listing for the specified language.
|
||||||
# There must be a store listing for the specified language.
|
|
||||||
# @param [String] image_type
|
# @param [String] image_type
|
||||||
# Type of the Image. Providing an image type that refers to no images will
|
# Type of the Image. Providing an image type that refers to no images will
|
||||||
# return an empty response.
|
# return an empty response.
|
||||||
|
|
@ -881,9 +873,9 @@ module Google
|
||||||
# @param [String] edit_id
|
# @param [String] edit_id
|
||||||
# Identifier of the edit.
|
# Identifier of the edit.
|
||||||
# @param [String] language
|
# @param [String] language
|
||||||
# Language localization code (a BCP-47 language tag; for example, "de-AT"
|
# Language localization code (a BCP-47 language tag; for example, "de-AT" for
|
||||||
# for Austrian German).
|
# Austrian German). Providing a language that is not supported by the App is a
|
||||||
# Providing a language that is not supported by the App is a no-op.
|
# no-op.
|
||||||
# @param [String] image_type
|
# @param [String] image_type
|
||||||
# Type of the Image.
|
# Type of the Image.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -932,8 +924,8 @@ module Google
|
||||||
# @param [String] edit_id
|
# @param [String] edit_id
|
||||||
# Identifier of the edit.
|
# Identifier of the edit.
|
||||||
# @param [String] language
|
# @param [String] language
|
||||||
# Language localization code (a BCP-47 language tag; for example, "de-AT"
|
# Language localization code (a BCP-47 language tag; for example, "de-AT" for
|
||||||
# for Austrian German).
|
# Austrian German).
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -998,8 +990,8 @@ module Google
|
||||||
# @param [String] edit_id
|
# @param [String] edit_id
|
||||||
# Identifier of the edit.
|
# Identifier of the edit.
|
||||||
# @param [String] language
|
# @param [String] language
|
||||||
# Language localization code (a BCP-47 language tag; for example, "de-AT"
|
# Language localization code (a BCP-47 language tag; for example, "de-AT" for
|
||||||
# for Austrian German).
|
# Austrian German).
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1068,8 +1060,8 @@ module Google
|
||||||
# @param [String] edit_id
|
# @param [String] edit_id
|
||||||
# Identifier of the edit.
|
# Identifier of the edit.
|
||||||
# @param [String] language
|
# @param [String] language
|
||||||
# Language localization code (a BCP-47 language tag; for example, "de-AT"
|
# Language localization code (a BCP-47 language tag; for example, "de-AT" for
|
||||||
# for Austrian German).
|
# Austrian German).
|
||||||
# @param [Google::Apis::AndroidpublisherV3::Listing] listing_object
|
# @param [Google::Apis::AndroidpublisherV3::Listing] listing_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -1108,8 +1100,8 @@ module Google
|
||||||
# @param [String] edit_id
|
# @param [String] edit_id
|
||||||
# Identifier of the edit.
|
# Identifier of the edit.
|
||||||
# @param [String] language
|
# @param [String] language
|
||||||
# Language localization code (a BCP-47 language tag; for example, "de-AT"
|
# Language localization code (a BCP-47 language tag; for example, "de-AT" for
|
||||||
# for Austrian German).
|
# Austrian German).
|
||||||
# @param [Google::Apis::AndroidpublisherV3::Listing] listing_object
|
# @param [Google::Apis::AndroidpublisherV3::Listing] listing_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -1472,9 +1464,9 @@ module Google
|
||||||
# Package name of the app.
|
# Package name of the app.
|
||||||
# @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object
|
# @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object
|
||||||
# @param [Boolean] auto_convert_missing_prices
|
# @param [Boolean] auto_convert_missing_prices
|
||||||
# If true the prices for all regions targeted by the parent app that don't
|
# If true the prices for all regions targeted by the parent app that don't have
|
||||||
# have a price specified for this in-app product will be auto converted to
|
# a price specified for this in-app product will be auto converted to the target
|
||||||
# the target currency based on the default price. Defaults to false.
|
# currency based on the default price. Defaults to false.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1551,9 +1543,9 @@ module Google
|
||||||
# Unique identifier for the in-app product.
|
# Unique identifier for the in-app product.
|
||||||
# @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object
|
# @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object
|
||||||
# @param [Boolean] auto_convert_missing_prices
|
# @param [Boolean] auto_convert_missing_prices
|
||||||
# If true the prices for all regions targeted by the parent app that don't
|
# If true the prices for all regions targeted by the parent app that don't have
|
||||||
# have a price specified for this in-app product will be auto converted to
|
# a price specified for this in-app product will be auto converted to the target
|
||||||
# the target currency based on the default price. Defaults to false.
|
# currency based on the default price. Defaults to false.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1592,9 +1584,9 @@ module Google
|
||||||
# Unique identifier for the in-app product.
|
# Unique identifier for the in-app product.
|
||||||
# @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object
|
# @param [Google::Apis::AndroidpublisherV3::InAppProduct] in_app_product_object
|
||||||
# @param [Boolean] auto_convert_missing_prices
|
# @param [Boolean] auto_convert_missing_prices
|
||||||
# If true the prices for all regions targeted by the parent app that don't
|
# If true the prices for all regions targeted by the parent app that don't have
|
||||||
# have a price specified for this in-app product will be auto converted to
|
# a price specified for this in-app product will be auto converted to the target
|
||||||
# the target currency based on the default price. Defaults to false.
|
# currency based on the default price. Defaults to false.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1626,14 +1618,11 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Uploads an APK to internal app sharing.
|
# Uploads an APK to internal app sharing. If you are using the Google API client
|
||||||
# If you are using the Google API client libraries, please increase the
|
# libraries, please increase the timeout of the http request before calling this
|
||||||
# timeout of the http request before calling this endpoint
|
# endpoint (a timeout of 2 minutes is recommended). See [Timeouts and Errors](
|
||||||
# (a timeout of 2 minutes is recommended).
|
# https://developers.google.com/api-client-library/java/google-api-java-client/
|
||||||
# See [Timeouts and
|
# errors) for an example in java.
|
||||||
# Errors](https://developers.google.com/api-client-library/java/google-api-java-
|
|
||||||
# client/errors)
|
|
||||||
# for an example in java.
|
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# Package name of the app.
|
# Package name of the app.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -1673,14 +1662,11 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Uploads an app bundle to internal app sharing.
|
# Uploads an app bundle to internal app sharing. If you are using the Google API
|
||||||
# If you are using the Google API client libraries, please increase the
|
# client libraries, please increase the timeout of the http request before
|
||||||
# timeout of the http request before calling this endpoint
|
# calling this endpoint (a timeout of 2 minutes is recommended). See [Timeouts
|
||||||
# (a timeout of 2 minutes is recommended).
|
# and Errors](https://developers.google.com/api-client-library/java/google-api-
|
||||||
# See [Timeouts and
|
# java-client/errors) for an example in java.
|
||||||
# Errors](https://developers.google.com/api-client-library/java/google-api-java-
|
|
||||||
# client/errors)
|
|
||||||
# for an example in java.
|
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# Package name of the app.
|
# Package name of the app.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -1722,16 +1708,16 @@ module Google
|
||||||
|
|
||||||
# Refund a user's subscription or in-app purchase order.
|
# Refund a user's subscription or in-app purchase order.
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# The package name of the application for which this subscription or in-app
|
# The package name of the application for which this subscription or in-app item
|
||||||
# item was purchased (for example, 'com.some.thing').
|
# was purchased (for example, 'com.some.thing').
|
||||||
# @param [String] order_id
|
# @param [String] order_id
|
||||||
# The order ID provided to the user when the subscription or in-app order was
|
# The order ID provided to the user when the subscription or in-app order was
|
||||||
# purchased.
|
# purchased.
|
||||||
# @param [Boolean] revoke
|
# @param [Boolean] revoke
|
||||||
# Whether to revoke the purchased item. If set to true, access to the
|
# Whether to revoke the purchased item. If set to true, access to the
|
||||||
# subscription or in-app item will be terminated immediately. If the item is
|
# subscription or in-app item will be terminated immediately. If the item is a
|
||||||
# a recurring subscription, all future payments will also be terminated.
|
# recurring subscription, all future payments will also be terminated. Consumed
|
||||||
# Consumed in-app items need to be handled by developer's app. (optional).
|
# in-app items need to be handled by developer's app. (optional).
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1761,13 +1747,12 @@ module Google
|
||||||
|
|
||||||
# Acknowledges a purchase of an inapp item.
|
# Acknowledges a purchase of an inapp item.
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# The package name of the application the inapp product was sold in (for
|
# The package name of the application the inapp product was sold in (for example,
|
||||||
# example, 'com.some.thing').
|
# 'com.some.thing').
|
||||||
# @param [String] product_id
|
# @param [String] product_id
|
||||||
# The inapp product SKU (for example, 'com.some.thing.inapp1').
|
# The inapp product SKU (for example, 'com.some.thing.inapp1').
|
||||||
# @param [String] token
|
# @param [String] token
|
||||||
# The token provided to the user's device when the inapp product was
|
# The token provided to the user's device when the inapp product was purchased.
|
||||||
# purchased.
|
|
||||||
# @param [Google::Apis::AndroidpublisherV3::ProductPurchasesAcknowledgeRequest] product_purchases_acknowledge_request_object
|
# @param [Google::Apis::AndroidpublisherV3::ProductPurchasesAcknowledgeRequest] product_purchases_acknowledge_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -1800,13 +1785,12 @@ module Google
|
||||||
|
|
||||||
# Checks the purchase and consumption status of an inapp item.
|
# Checks the purchase and consumption status of an inapp item.
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# The package name of the application the inapp product was sold in (for
|
# The package name of the application the inapp product was sold in (for example,
|
||||||
# example, 'com.some.thing').
|
# 'com.some.thing').
|
||||||
# @param [String] product_id
|
# @param [String] product_id
|
||||||
# The inapp product SKU (for example, 'com.some.thing.inapp1').
|
# The inapp product SKU (for example, 'com.some.thing.inapp1').
|
||||||
# @param [String] token
|
# @param [String] token
|
||||||
# The token provided to the user's device when the inapp product was
|
# The token provided to the user's device when the inapp product was purchased.
|
||||||
# purchased.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1838,13 +1822,12 @@ module Google
|
||||||
|
|
||||||
# Acknowledges a subscription purchase.
|
# Acknowledges a subscription purchase.
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# The package name of the application for which this subscription was
|
# The package name of the application for which this subscription was purchased (
|
||||||
# purchased (for example, 'com.some.thing').
|
# for example, 'com.some.thing').
|
||||||
# @param [String] subscription_id
|
# @param [String] subscription_id
|
||||||
# The purchased subscription ID (for example, 'monthly001').
|
# The purchased subscription ID (for example, 'monthly001').
|
||||||
# @param [String] token
|
# @param [String] token
|
||||||
# The token provided to the user's device when the subscription was
|
# The token provided to the user's device when the subscription was purchased.
|
||||||
# purchased.
|
|
||||||
# @param [Google::Apis::AndroidpublisherV3::SubscriptionPurchasesAcknowledgeRequest] subscription_purchases_acknowledge_request_object
|
# @param [Google::Apis::AndroidpublisherV3::SubscriptionPurchasesAcknowledgeRequest] subscription_purchases_acknowledge_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -1875,16 +1858,15 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Cancels a user's subscription purchase. The subscription remains valid
|
# Cancels a user's subscription purchase. The subscription remains valid until
|
||||||
# until its expiration time.
|
# its expiration time.
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# The package name of the application for which this subscription was
|
# The package name of the application for which this subscription was purchased (
|
||||||
# purchased (for example, 'com.some.thing').
|
# for example, 'com.some.thing').
|
||||||
# @param [String] subscription_id
|
# @param [String] subscription_id
|
||||||
# The purchased subscription ID (for example, 'monthly001').
|
# The purchased subscription ID (for example, 'monthly001').
|
||||||
# @param [String] token
|
# @param [String] token
|
||||||
# The token provided to the user's device when the subscription was
|
# The token provided to the user's device when the subscription was purchased.
|
||||||
# purchased.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1912,16 +1894,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Defers a user's subscription purchase until a specified future expiration
|
# Defers a user's subscription purchase until a specified future expiration time.
|
||||||
# time.
|
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# The package name of the application for which this subscription was
|
# The package name of the application for which this subscription was purchased (
|
||||||
# purchased (for example, 'com.some.thing').
|
# for example, 'com.some.thing').
|
||||||
# @param [String] subscription_id
|
# @param [String] subscription_id
|
||||||
# The purchased subscription ID (for example, 'monthly001').
|
# The purchased subscription ID (for example, 'monthly001').
|
||||||
# @param [String] token
|
# @param [String] token
|
||||||
# The token provided to the user's device when the subscription was
|
# The token provided to the user's device when the subscription was purchased.
|
||||||
# purchased.
|
|
||||||
# @param [Google::Apis::AndroidpublisherV3::SubscriptionPurchasesDeferRequest] subscription_purchases_defer_request_object
|
# @param [Google::Apis::AndroidpublisherV3::SubscriptionPurchasesDeferRequest] subscription_purchases_defer_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -1954,16 +1934,15 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Checks whether a user's subscription purchase is valid and returns its
|
# Checks whether a user's subscription purchase is valid and returns its expiry
|
||||||
# expiry time.
|
# time.
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# The package name of the application for which this subscription was
|
# The package name of the application for which this subscription was purchased (
|
||||||
# purchased (for example, 'com.some.thing').
|
# for example, 'com.some.thing').
|
||||||
# @param [String] subscription_id
|
# @param [String] subscription_id
|
||||||
# The purchased subscription ID (for example, 'monthly001').
|
# The purchased subscription ID (for example, 'monthly001').
|
||||||
# @param [String] token
|
# @param [String] token
|
||||||
# The token provided to the user's device when the subscription was
|
# The token provided to the user's device when the subscription was purchased.
|
||||||
# purchased.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1996,13 +1975,12 @@ module Google
|
||||||
# Refunds a user's subscription purchase, but the subscription remains valid
|
# Refunds a user's subscription purchase, but the subscription remains valid
|
||||||
# until its expiration time and it will continue to recur.
|
# until its expiration time and it will continue to recur.
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# The package name of the application for which this subscription was
|
# The package name of the application for which this subscription was purchased (
|
||||||
# purchased (for example, 'com.some.thing').
|
# for example, 'com.some.thing').
|
||||||
# @param [String] subscription_id
|
# @param [String] subscription_id
|
||||||
# "The purchased subscription ID (for example, 'monthly001').
|
# "The purchased subscription ID (for example, 'monthly001').
|
||||||
# @param [String] token
|
# @param [String] token
|
||||||
# The token provided to the user's device when the subscription was
|
# The token provided to the user's device when the subscription was purchased.
|
||||||
# purchased.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -2030,16 +2008,15 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Refunds and immediately revokes a user's subscription purchase. Access to
|
# Refunds and immediately revokes a user's subscription purchase. Access to the
|
||||||
# the subscription will be terminated immediately and it will stop recurring.
|
# subscription will be terminated immediately and it will stop recurring.
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# The package name of the application for which this subscription was
|
# The package name of the application for which this subscription was purchased (
|
||||||
# purchased (for example, 'com.some.thing').
|
# for example, 'com.some.thing').
|
||||||
# @param [String] subscription_id
|
# @param [String] subscription_id
|
||||||
# The purchased subscription ID (for example, 'monthly001').
|
# The purchased subscription ID (for example, 'monthly001').
|
||||||
# @param [String] token
|
# @param [String] token
|
||||||
# The token provided to the user's device when the subscription was
|
# The token provided to the user's device when the subscription was purchased.
|
||||||
# purchased.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -2072,43 +2049,38 @@ module Google
|
||||||
# The package name of the application for which voided purchases need to be
|
# The package name of the application for which voided purchases need to be
|
||||||
# returned (for example, 'com.some.thing').
|
# returned (for example, 'com.some.thing').
|
||||||
# @param [Fixnum] end_time
|
# @param [Fixnum] end_time
|
||||||
# The time, in milliseconds since the Epoch, of the newest voided purchase
|
# The time, in milliseconds since the Epoch, of the newest voided purchase that
|
||||||
# that you want to see in the response. The value of this parameter cannot
|
# you want to see in the response. The value of this parameter cannot be greater
|
||||||
# be greater than the current time and is ignored if a pagination token is
|
# than the current time and is ignored if a pagination token is set. Default
|
||||||
# set. Default value is current time.
|
# value is current time. Note: This filter is applied on the time at which the
|
||||||
# Note: This filter is applied on the time at which the record is seen as
|
# record is seen as voided by our systems and not the actual voided time
|
||||||
# voided by our systems and not the actual voided time returned in the
|
# returned in the response.
|
||||||
# response.
|
|
||||||
# @param [Fixnum] max_results
|
# @param [Fixnum] max_results
|
||||||
# Defines how many results the list operation should return.
|
# Defines how many results the list operation should return. The default number
|
||||||
# The default number depends on the resource collection.
|
# depends on the resource collection.
|
||||||
# @param [Fixnum] start_index
|
# @param [Fixnum] start_index
|
||||||
# Defines the index of the first element to return.
|
# Defines the index of the first element to return. This can only be used if
|
||||||
# This can only be used if indexed paging is enabled.
|
# indexed paging is enabled.
|
||||||
# @param [Fixnum] start_time
|
# @param [Fixnum] start_time
|
||||||
# The time, in milliseconds since the Epoch, of the oldest voided purchase
|
# The time, in milliseconds since the Epoch, of the oldest voided purchase that
|
||||||
# that you want to see in the response. The value of this parameter cannot
|
# you want to see in the response. The value of this parameter cannot be older
|
||||||
# be older than 30 days and is ignored if a pagination token is set.
|
# than 30 days and is ignored if a pagination token is set. Default value is
|
||||||
# Default value is current time minus 30 days.
|
# current time minus 30 days. Note: This filter is applied on the time at which
|
||||||
# Note: This filter is applied on the time at which the record is seen as
|
# the record is seen as voided by our systems and not the actual voided time
|
||||||
# voided by our systems and not the actual voided time returned in the
|
# returned in the response.
|
||||||
# response.
|
|
||||||
# @param [String] token
|
# @param [String] token
|
||||||
# Defines the token of the page to return, usually taken from
|
# Defines the token of the page to return, usually taken from TokenPagination.
|
||||||
# TokenPagination.
|
|
||||||
# This can only be used if token paging is enabled.
|
# This can only be used if token paging is enabled.
|
||||||
# @param [Fixnum] type
|
# @param [Fixnum] type
|
||||||
# The type of voided purchases that you want to see in the response.
|
# The type of voided purchases that you want to see in the response. Possible
|
||||||
# Possible values are:
|
# values are: 0. Only voided in-app product purchases will be returned in the
|
||||||
# 0. Only voided in-app product purchases will be returned in the
|
# response. This is the default value. 1. Both voided in-app purchases and
|
||||||
# response. This is the default value.
|
# voided subscription purchases will be returned in the response. Note: Before
|
||||||
# 1. Both voided in-app purchases and voided subscription purchases
|
# requesting to receive voided subscription purchases, you must switch to use
|
||||||
# will be returned in the response.
|
# orderId in the response which uniquely identifies one-time purchases and
|
||||||
# Note: Before requesting to receive voided subscription purchases, you
|
# subscriptions. Otherwise, you will receive multiple subscription orders with
|
||||||
# must switch to use orderId in the response which uniquely identifies
|
# the same PurchaseToken, because subscription renewal orders share the same
|
||||||
# one-time purchases and subscriptions. Otherwise, you will receive multiple
|
# PurchaseToken.
|
||||||
# subscription orders with the same PurchaseToken, because subscription
|
|
||||||
# renewal orders share the same PurchaseToken.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -2293,8 +2265,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Downloads a previously created system APK which is suitable for inclusion
|
# Downloads a previously created system APK which is suitable for inclusion in a
|
||||||
# in a system image.
|
# system image.
|
||||||
# @param [String] package_name
|
# @param [String] package_name
|
||||||
# Unique identifier of the Android app.
|
# Unique identifier of the Android app.
|
||||||
# @param [Fixnum] version_code
|
# @param [Fixnum] version_code
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ module Google
|
||||||
# @see https://cloud.google.com/billing/docs/how-to/budget-api-overview
|
# @see https://cloud.google.com/billing/docs/how-to/budget-api-overview
|
||||||
module BillingbudgetsV1beta1
|
module BillingbudgetsV1beta1
|
||||||
VERSION = 'V1beta1'
|
VERSION = 'V1beta1'
|
||||||
REVISION = '20200711'
|
REVISION = '20200801'
|
||||||
|
|
||||||
# View and manage your data across Google Cloud Platform services
|
# View and manage your data across Google Cloud Platform services
|
||||||
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||||
|
|
|
||||||
|
|
@ -22,45 +22,38 @@ module Google
|
||||||
module Apis
|
module Apis
|
||||||
module BillingbudgetsV1beta1
|
module BillingbudgetsV1beta1
|
||||||
|
|
||||||
# AllUpdatesRule defines notifications that are sent based on budget spend
|
# AllUpdatesRule defines notifications that are sent based on budget spend and
|
||||||
# and thresholds.
|
# thresholds.
|
||||||
class GoogleCloudBillingBudgetsV1beta1AllUpdatesRule
|
class GoogleCloudBillingBudgetsV1beta1AllUpdatesRule
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Optional. Targets to send notifications to when a threshold is exceeded. This
|
# Optional. Targets to send notifications to when a threshold is exceeded. This
|
||||||
# is in
|
# is in addition to default recipients who have billing account roles. The value
|
||||||
# addition to default recipients who have billing account roles.
|
# is the full REST resource name of a monitoring notification channel with the
|
||||||
# The value is the full REST resource name of a monitoring notification
|
# form `projects/`project_id`/notificationChannels/`channel_id``. A maximum of 5
|
||||||
# channel with the form
|
# channels are allowed. See https://cloud.google.com/billing/docs/how-to/budgets-
|
||||||
# `projects/`project_id`/notificationChannels/`channel_id``. A maximum of 5
|
# notification-recipients for more details.
|
||||||
# channels are allowed. See
|
|
||||||
# https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients
|
|
||||||
# for more details.
|
|
||||||
# Corresponds to the JSON property `monitoringNotificationChannels`
|
# Corresponds to the JSON property `monitoringNotificationChannels`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :monitoring_notification_channels
|
attr_accessor :monitoring_notification_channels
|
||||||
|
|
||||||
# Required. The name of the Cloud Pub/Sub topic where budget related messages
|
# Optional. The name of the Pub/Sub topic where budget related messages will be
|
||||||
# will be
|
# published, in the form `projects/`project_id`/topics/`topic_id``. Updates are
|
||||||
# published, in the form `projects/`project_id`/topics/`topic_id``. Updates
|
# sent at regular intervals to the topic. The topic needs to be created before
|
||||||
# are sent at regular intervals to the topic.
|
# the budget is created; see https://cloud.google.com/billing/docs/how-to/
|
||||||
# The topic needs to be created before the budget is created; see
|
# budgets#manage-notifications for more details. Caller is expected to have `
|
||||||
# https://cloud.google.com/billing/docs/how-to/budgets#manage-notifications
|
# pubsub.topics.setIamPolicy` permission on the topic when it's set for a budget,
|
||||||
# for more details.
|
# otherwise, the API call will fail with PERMISSION_DENIED. See https://cloud.
|
||||||
# Caller is expected to have
|
# google.com/billing/docs/how-to/budgets-programmatic-notifications for more
|
||||||
# `pubsub.topics.setIamPolicy` permission on the topic when it's set for a
|
# details on Pub/Sub roles and permissions.
|
||||||
# budget, otherwise, the API call will fail with PERMISSION_DENIED. See
|
|
||||||
# https://cloud.google.com/billing/docs/how-to/budgets-programmatic-
|
|
||||||
# notifications
|
|
||||||
# for more details on Pub/Sub roles and permissions.
|
|
||||||
# Corresponds to the JSON property `pubsubTopic`
|
# Corresponds to the JSON property `pubsubTopic`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :pubsub_topic
|
attr_accessor :pubsub_topic
|
||||||
|
|
||||||
# Required. The schema version of the notification sent to `pubsub_topic`.
|
# Optional. The schema version of the notification sent to `pubsub_topic`. Only "
|
||||||
# Only "1.0" is accepted. It represents the JSON schema as defined in
|
# 1.0" is accepted. It represents the JSON schema as defined in https://cloud.
|
||||||
# https://cloud.google.com/billing/docs/how-to/budgets-programmatic-
|
# google.com/billing/docs/how-to/budgets-programmatic-notifications#
|
||||||
# notifications#notification_format
|
# notification_format
|
||||||
# Corresponds to the JSON property `schemaVersion`
|
# Corresponds to the JSON property `schemaVersion`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :schema_version
|
attr_accessor :schema_version
|
||||||
|
|
@ -77,16 +70,16 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A budget is a plan that describes what you expect to spend on Cloud
|
# A budget is a plan that describes what you expect to spend on Cloud projects,
|
||||||
# projects, plus the rules to execute as spend is tracked against that plan,
|
# plus the rules to execute as spend is tracked against that plan, (for example,
|
||||||
# (for example, send an alert when 90% of the target spend is met).
|
# send an alert when 90% of the target spend is met). Currently all plans are
|
||||||
# Currently all plans are monthly budgets so the usage period(s) tracked are
|
# monthly budgets so the usage period(s) tracked are implied (calendar months of
|
||||||
# implied (calendar months of usage back-to-back).
|
# usage back-to-back).
|
||||||
class GoogleCloudBillingBudgetsV1beta1Budget
|
class GoogleCloudBillingBudgetsV1beta1Budget
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# AllUpdatesRule defines notifications that are sent based on budget spend
|
# AllUpdatesRule defines notifications that are sent based on budget spend and
|
||||||
# and thresholds.
|
# thresholds.
|
||||||
# Corresponds to the JSON property `allUpdatesRule`
|
# Corresponds to the JSON property `allUpdatesRule`
|
||||||
# @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1AllUpdatesRule]
|
# @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1AllUpdatesRule]
|
||||||
attr_accessor :all_updates_rule
|
attr_accessor :all_updates_rule
|
||||||
|
|
@ -101,28 +94,26 @@ module Google
|
||||||
# @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1Filter]
|
# @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1Filter]
|
||||||
attr_accessor :budget_filter
|
attr_accessor :budget_filter
|
||||||
|
|
||||||
# User data for display name in UI.
|
# User data for display name in UI. Validation: <= 60 chars.
|
||||||
# Validation: <= 60 chars.
|
|
||||||
# Corresponds to the JSON property `displayName`
|
# Corresponds to the JSON property `displayName`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :display_name
|
attr_accessor :display_name
|
||||||
|
|
||||||
# Optional. Etag to validate that the object is unchanged for a
|
# Optional. Etag to validate that the object is unchanged for a read-modify-
|
||||||
# read-modify-write operation.
|
# write operation. An empty etag will cause an update to overwrite other changes.
|
||||||
# An empty etag will cause an update to overwrite other changes.
|
|
||||||
# Corresponds to the JSON property `etag`
|
# Corresponds to the JSON property `etag`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :etag
|
attr_accessor :etag
|
||||||
|
|
||||||
# Output only. Resource name of the budget.
|
# Output only. Resource name of the budget. The resource name implies the scope
|
||||||
# The resource name implies the scope of a budget. Values are of the form
|
# of a budget. Values are of the form `billingAccounts/`billingAccountId`/
|
||||||
# `billingAccounts/`billingAccountId`/budgets/`budgetId``.
|
# budgets/`budgetId``.
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# Optional. Rules that trigger alerts (notifications of thresholds
|
# Optional. Rules that trigger alerts (notifications of thresholds being crossed)
|
||||||
# being crossed) when spend exceeds the specified percentages of the budget.
|
# when spend exceeds the specified percentages of the budget.
|
||||||
# Corresponds to the JSON property `thresholdRules`
|
# Corresponds to the JSON property `thresholdRules`
|
||||||
# @return [Array<Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1ThresholdRule>]
|
# @return [Array<Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1ThresholdRule>]
|
||||||
attr_accessor :threshold_rules
|
attr_accessor :threshold_rules
|
||||||
|
|
@ -147,11 +138,10 @@ module Google
|
||||||
class GoogleCloudBillingBudgetsV1beta1BudgetAmount
|
class GoogleCloudBillingBudgetsV1beta1BudgetAmount
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Describes a budget amount targeted to last period's spend.
|
# Describes a budget amount targeted to last period's spend. At this time, the
|
||||||
# At this time, the amount is automatically 100% of last period's spend;
|
# amount is automatically 100% of last period's spend; that is, there are no
|
||||||
# that is, there are no other options yet.
|
# other options yet. Future configuration will be described here (for example,
|
||||||
# Future configuration will be described here (for example, configuring a
|
# configuring a percentage of last period's spend).
|
||||||
# percentage of last period's spend).
|
|
||||||
# Corresponds to the JSON property `lastPeriodAmount`
|
# Corresponds to the JSON property `lastPeriodAmount`
|
||||||
# @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1LastPeriodAmount]
|
# @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1LastPeriodAmount]
|
||||||
attr_accessor :last_period_amount
|
attr_accessor :last_period_amount
|
||||||
|
|
@ -176,11 +166,11 @@ module Google
|
||||||
class GoogleCloudBillingBudgetsV1beta1CreateBudgetRequest
|
class GoogleCloudBillingBudgetsV1beta1CreateBudgetRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# A budget is a plan that describes what you expect to spend on Cloud
|
# A budget is a plan that describes what you expect to spend on Cloud projects,
|
||||||
# projects, plus the rules to execute as spend is tracked against that plan,
|
# plus the rules to execute as spend is tracked against that plan, (for example,
|
||||||
# (for example, send an alert when 90% of the target spend is met).
|
# send an alert when 90% of the target spend is met). Currently all plans are
|
||||||
# Currently all plans are monthly budgets so the usage period(s) tracked are
|
# monthly budgets so the usage period(s) tracked are implied (calendar months of
|
||||||
# implied (calendar months of usage back-to-back).
|
# usage back-to-back).
|
||||||
# Corresponds to the JSON property `budget`
|
# Corresponds to the JSON property `budget`
|
||||||
# @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1Budget]
|
# @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1Budget]
|
||||||
attr_accessor :budget
|
attr_accessor :budget
|
||||||
|
|
@ -205,40 +195,36 @@ module Google
|
||||||
attr_accessor :credit_types_treatment
|
attr_accessor :credit_types_treatment
|
||||||
|
|
||||||
# Optional. A single label and value pair specifying that usage from only this
|
# Optional. A single label and value pair specifying that usage from only this
|
||||||
# set of
|
# set of labeled resources should be included in the budget. Currently, multiple
|
||||||
# labeled resources should be included in the budget. Currently, multiple
|
# entries or multiple values per entry are not allowed. If omitted, the report
|
||||||
# entries or multiple values per entry are not allowed. If omitted, the
|
# will include all labeled and unlabeled usage.
|
||||||
# report will include all labeled and unlabeled usage.
|
|
||||||
# Corresponds to the JSON property `labels`
|
# Corresponds to the JSON property `labels`
|
||||||
# @return [Hash<String,Array<Object>>]
|
# @return [Hash<String,Array<Object>>]
|
||||||
attr_accessor :labels
|
attr_accessor :labels
|
||||||
|
|
||||||
# Optional. A set of projects of the form `projects/`project``,
|
# Optional. A set of projects of the form `projects/`project``, specifying that
|
||||||
# specifying that usage from only this set of projects should be
|
# usage from only this set of projects should be included in the budget. If
|
||||||
# included in the budget. If omitted, the report will include all usage for
|
# omitted, the report will include all usage for the billing account, regardless
|
||||||
# the billing account, regardless of which project the usage occurred on.
|
# of which project the usage occurred on. Only zero or one project can be
|
||||||
# Only zero or one project can be specified currently.
|
# specified currently.
|
||||||
# Corresponds to the JSON property `projects`
|
# Corresponds to the JSON property `projects`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :projects
|
attr_accessor :projects
|
||||||
|
|
||||||
# Optional. A set of services of the form `services/`service_id``,
|
# Optional. A set of services of the form `services/`service_id``, specifying
|
||||||
# specifying that usage from only this set of services should be
|
# that usage from only this set of services should be included in the budget. If
|
||||||
# included in the budget. If omitted, the report will include usage for
|
# omitted, the report will include usage for all the services. The service names
|
||||||
# all the services.
|
# are available through the Catalog API: https://cloud.google.com/billing/v1/how-
|
||||||
# The service names are available through the Catalog API:
|
# tos/catalog-api.
|
||||||
# https://cloud.google.com/billing/v1/how-tos/catalog-api.
|
|
||||||
# Corresponds to the JSON property `services`
|
# Corresponds to the JSON property `services`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :services
|
attr_accessor :services
|
||||||
|
|
||||||
# Optional. A set of subaccounts of the form `billingAccounts/`account_id``,
|
# Optional. A set of subaccounts of the form `billingAccounts/`account_id``,
|
||||||
# specifying
|
# specifying that usage from only this set of subaccounts should be included in
|
||||||
# that usage from only this set of subaccounts should be included in the
|
# the budget. If a subaccount is set to the name of the parent account, usage
|
||||||
# budget. If a subaccount is set to the name of the parent account,
|
# from the parent account will be included. If omitted, the report will include
|
||||||
# usage from the parent account will be included. If omitted, the
|
# usage from the parent account and all subaccounts, if they exist.
|
||||||
# report will include usage from the parent account and all
|
|
||||||
# subaccounts, if they exist.
|
|
||||||
# Corresponds to the JSON property `subaccounts`
|
# Corresponds to the JSON property `subaccounts`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :subaccounts
|
attr_accessor :subaccounts
|
||||||
|
|
@ -257,11 +243,10 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Describes a budget amount targeted to last period's spend.
|
# Describes a budget amount targeted to last period's spend. At this time, the
|
||||||
# At this time, the amount is automatically 100% of last period's spend;
|
# amount is automatically 100% of last period's spend; that is, there are no
|
||||||
# that is, there are no other options yet.
|
# other options yet. Future configuration will be described here (for example,
|
||||||
# Future configuration will be described here (for example, configuring a
|
# configuring a percentage of last period's spend).
|
||||||
# percentage of last period's spend).
|
|
||||||
class GoogleCloudBillingBudgetsV1beta1LastPeriodAmount
|
class GoogleCloudBillingBudgetsV1beta1LastPeriodAmount
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -283,8 +268,8 @@ module Google
|
||||||
# @return [Array<Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1Budget>]
|
# @return [Array<Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1Budget>]
|
||||||
attr_accessor :budgets
|
attr_accessor :budgets
|
||||||
|
|
||||||
# If not empty, indicates that there may be more budgets that match the
|
# If not empty, indicates that there may be more budgets that match the request;
|
||||||
# request; this value should be passed in a new `ListBudgetsRequest`.
|
# this value should be passed in a new `ListBudgetsRequest`.
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -300,13 +285,12 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# ThresholdRule contains a definition of a threshold which triggers
|
# ThresholdRule contains a definition of a threshold which triggers an alert (a
|
||||||
# an alert (a notification of a threshold being crossed) to be sent when
|
# notification of a threshold being crossed) to be sent when spend goes above
|
||||||
# spend goes above the specified amount.
|
# the specified amount. Alerts are automatically e-mailed to users with the
|
||||||
# Alerts are automatically e-mailed to users with the Billing Account
|
# Billing Account Administrator role or the Billing Account User role. The
|
||||||
# Administrator role or the Billing Account User role.
|
# thresholds here have no effect on notifications sent to anything configured
|
||||||
# The thresholds here have no effect on notifications sent to anything
|
# under `Budget.all_updates_rule`.
|
||||||
# configured under `Budget.all_updates_rule`.
|
|
||||||
class GoogleCloudBillingBudgetsV1beta1ThresholdRule
|
class GoogleCloudBillingBudgetsV1beta1ThresholdRule
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -316,9 +300,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :spend_basis
|
attr_accessor :spend_basis
|
||||||
|
|
||||||
# Required. Send an alert when this threshold is exceeded.
|
# Required. Send an alert when this threshold is exceeded. This is a 1.0-based
|
||||||
# This is a 1.0-based percentage, so 0.5 = 50%.
|
# percentage, so 0.5 = 50%. Validation: non-negative number.
|
||||||
# Validation: non-negative number.
|
|
||||||
# Corresponds to the JSON property `thresholdPercent`
|
# Corresponds to the JSON property `thresholdPercent`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :threshold_percent
|
attr_accessor :threshold_percent
|
||||||
|
|
@ -338,21 +321,20 @@ module Google
|
||||||
class GoogleCloudBillingBudgetsV1beta1UpdateBudgetRequest
|
class GoogleCloudBillingBudgetsV1beta1UpdateBudgetRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# A budget is a plan that describes what you expect to spend on Cloud
|
# A budget is a plan that describes what you expect to spend on Cloud projects,
|
||||||
# projects, plus the rules to execute as spend is tracked against that plan,
|
# plus the rules to execute as spend is tracked against that plan, (for example,
|
||||||
# (for example, send an alert when 90% of the target spend is met).
|
# send an alert when 90% of the target spend is met). Currently all plans are
|
||||||
# Currently all plans are monthly budgets so the usage period(s) tracked are
|
# monthly budgets so the usage period(s) tracked are implied (calendar months of
|
||||||
# implied (calendar months of usage back-to-back).
|
# usage back-to-back).
|
||||||
# Corresponds to the JSON property `budget`
|
# Corresponds to the JSON property `budget`
|
||||||
# @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1Budget]
|
# @return [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1Budget]
|
||||||
attr_accessor :budget
|
attr_accessor :budget
|
||||||
|
|
||||||
# Optional. Indicates which fields in the provided budget to update.
|
# Optional. Indicates which fields in the provided budget to update. Read-only
|
||||||
# Read-only fields (such as `name`) cannot be changed. If this is not
|
# fields (such as `name`) cannot be changed. If this is not provided, then only
|
||||||
# provided, then only fields with non-default values from the request are
|
# fields with non-default values from the request are updated. See https://
|
||||||
# updated. See
|
# developers.google.com/protocol-buffers/docs/proto3#default for more details
|
||||||
# https://developers.google.com/protocol-buffers/docs/proto3#default for more
|
# about default values.
|
||||||
# details about default values.
|
|
||||||
# Corresponds to the JSON property `updateMask`
|
# Corresponds to the JSON property `updateMask`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :update_mask
|
attr_accessor :update_mask
|
||||||
|
|
@ -368,13 +350,11 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A generic empty message that you can re-use to avoid defining duplicated
|
# A generic empty message that you can re-use to avoid defining duplicated empty
|
||||||
# empty messages in your APIs. A typical example is to use it as the request
|
# messages in your APIs. A typical example is to use it as the request or the
|
||||||
# or the response type of an API method. For instance:
|
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
||||||
# service Foo `
|
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
||||||
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
# `Empty` is empty JSON object ````.
|
||||||
# `
|
|
||||||
# The JSON representation for `Empty` is empty JSON object ````.
|
|
||||||
class GoogleProtobufEmpty
|
class GoogleProtobufEmpty
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -396,18 +376,17 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :currency_code
|
attr_accessor :currency_code
|
||||||
|
|
||||||
# Number of nano (10^-9) units of the amount.
|
# Number of nano (10^-9) units of the amount. The value must be between -999,999,
|
||||||
# The value must be between -999,999,999 and +999,999,999 inclusive.
|
# 999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be
|
||||||
# If `units` is positive, `nanos` must be positive or zero.
|
# positive or zero. If `units` is zero, `nanos` can be positive, zero, or
|
||||||
# If `units` is zero, `nanos` can be positive, zero, or negative.
|
# negative. If `units` is negative, `nanos` must be negative or zero. For
|
||||||
# If `units` is negative, `nanos` must be negative or zero.
|
# example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
|
||||||
# For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
|
|
||||||
# Corresponds to the JSON property `nanos`
|
# Corresponds to the JSON property `nanos`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :nanos
|
attr_accessor :nanos
|
||||||
|
|
||||||
# The whole units of the amount.
|
# The whole units of the amount. For example if `currencyCode` is `"USD"`, then
|
||||||
# For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
|
# 1 unit is one US dollar.
|
||||||
# Corresponds to the JSON property `units`
|
# Corresponds to the JSON property `units`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :units
|
attr_accessor :units
|
||||||
|
|
|
||||||
|
|
@ -48,12 +48,11 @@ module Google
|
||||||
@batch_path = 'batch'
|
@batch_path = 'batch'
|
||||||
end
|
end
|
||||||
|
|
||||||
# Creates a new budget. See
|
# Creates a new budget. See Quotas and limits for more information on the limits
|
||||||
# <a href="https://cloud.google.com/billing/quotas">Quotas and limits</a>
|
# of the number of budgets you can create.
|
||||||
# for more information on the limits of the number of budgets you can create.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the billing account to create the budget in. Values
|
# Required. The name of the billing account to create the budget in. Values are
|
||||||
# are of the form `billingAccounts/`billingAccountId``.
|
# of the form `billingAccounts/`billingAccountId``.
|
||||||
# @param [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1CreateBudgetRequest] google_cloud_billing_budgets_v1beta1_create_budget_request_object
|
# @param [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1CreateBudgetRequest] google_cloud_billing_budgets_v1beta1_create_budget_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -86,8 +85,8 @@ module Google
|
||||||
|
|
||||||
# Deletes a budget. Returns successfully if already deleted.
|
# Deletes a budget. Returns successfully if already deleted.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. Name of the budget to delete. Values are of the form
|
# Required. Name of the budget to delete. Values are of the form `
|
||||||
# `billingAccounts/`billingAccountId`/budgets/`budgetId``.
|
# billingAccounts/`billingAccountId`/budgets/`budgetId``.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -115,14 +114,13 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Returns a budget.
|
# Returns a budget. WARNING: There are some fields exposed on the Google Cloud
|
||||||
# WARNING: There are some fields exposed on the Google Cloud Console that
|
# Console that aren't available on this API. When reading from the API, you will
|
||||||
# aren't available on this API. When reading from the API, you will not
|
# not see these fields in the return value, though they may have been set in the
|
||||||
# see these fields in the return value, though they may have been set
|
# Cloud Console.
|
||||||
# in the Cloud Console.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. Name of budget to get. Values are of the form
|
# Required. Name of budget to get. Values are of the form `billingAccounts/`
|
||||||
# `billingAccounts/`billingAccountId`/budgets/`budgetId``.
|
# billingAccountId`/budgets/`budgetId``.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -150,21 +148,20 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Returns a list of budgets for a billing account.
|
# Returns a list of budgets for a billing account. WARNING: There are some
|
||||||
# WARNING: There are some fields exposed on the Google Cloud Console that
|
# fields exposed on the Google Cloud Console that aren't available on this API.
|
||||||
# aren't available on this API. When reading from the API, you will not
|
# When reading from the API, you will not see these fields in the return value,
|
||||||
# see these fields in the return value, though they may have been set
|
# though they may have been set in the Cloud Console.
|
||||||
# in the Cloud Console.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of billing account to list budgets under. Values
|
# Required. Name of billing account to list budgets under. Values are of the
|
||||||
# are of the form `billingAccounts/`billingAccountId``.
|
# form `billingAccounts/`billingAccountId``.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# Optional. The maximum number of budgets to return per page.
|
# Optional. The maximum number of budgets to return per page. The default and
|
||||||
# The default and maximum value are 100.
|
# maximum value are 100.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# Optional. The value returned by the last `ListBudgetsResponse` which
|
# Optional. The value returned by the last `ListBudgetsResponse` which indicates
|
||||||
# indicates that this is a continuation of a prior `ListBudgets` call,
|
# that this is a continuation of a prior `ListBudgets` call, and that the system
|
||||||
# and that the system should return the next page of data.
|
# should return the next page of data.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -194,14 +191,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Updates a budget and returns the updated budget.
|
# Updates a budget and returns the updated budget. WARNING: There are some
|
||||||
# WARNING: There are some fields exposed on the Google Cloud Console that
|
# fields exposed on the Google Cloud Console that aren't available on this API.
|
||||||
# aren't available on this API. Budget fields that are not exposed in
|
# Budget fields that are not exposed in this API will not be changed by this
|
||||||
# this API will not be changed by this method.
|
# method.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Output only. Resource name of the budget.
|
# Output only. Resource name of the budget. The resource name implies the scope
|
||||||
# The resource name implies the scope of a budget. Values are of the form
|
# of a budget. Values are of the form `billingAccounts/`billingAccountId`/
|
||||||
# `billingAccounts/`billingAccountId`/budgets/`budgetId``.
|
# budgets/`budgetId``.
|
||||||
# @param [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1UpdateBudgetRequest] google_cloud_billing_budgets_v1beta1_update_budget_request_object
|
# @param [Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1UpdateBudgetRequest] google_cloud_billing_budgets_v1beta1_update_budget_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
|
||||||
|
|
@ -20,13 +20,12 @@ module Google
|
||||||
module Apis
|
module Apis
|
||||||
# Blogger API v3
|
# Blogger API v3
|
||||||
#
|
#
|
||||||
# The Blogger API provides access to posts, comments and pages of a
|
# The Blogger API provides access to posts, comments and pages of a Blogger blog.
|
||||||
# Blogger blog.
|
|
||||||
#
|
#
|
||||||
# @see https://developers.google.com/blogger/docs/3.0/getting_started
|
# @see https://developers.google.com/blogger/docs/3.0/getting_started
|
||||||
module BloggerV2
|
module BloggerV2
|
||||||
VERSION = 'V2'
|
VERSION = 'V2'
|
||||||
REVISION = '20200405'
|
REVISION = '20200801'
|
||||||
|
|
||||||
# Manage your Blogger account
|
# Manage your Blogger account
|
||||||
AUTH_BLOGGER = 'https://www.googleapis.com/auth/blogger'
|
AUTH_BLOGGER = 'https://www.googleapis.com/auth/blogger'
|
||||||
|
|
|
||||||
|
|
@ -256,8 +256,7 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :photos_album_key
|
attr_accessor :photos_album_key
|
||||||
|
|
||||||
# Access permissions that the user has for the blog (ADMIN, AUTHOR, or
|
# Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).
|
||||||
# READER).
|
|
||||||
# Corresponds to the JSON property `role`
|
# Corresponds to the JSON property `role`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :role
|
attr_accessor :role
|
||||||
|
|
|
||||||
|
|
@ -22,8 +22,7 @@ module Google
|
||||||
module BloggerV2
|
module BloggerV2
|
||||||
# Blogger API v3
|
# Blogger API v3
|
||||||
#
|
#
|
||||||
# The Blogger API provides access to posts, comments and pages of a
|
# The Blogger API provides access to posts, comments and pages of a Blogger blog.
|
||||||
# Blogger blog.
|
|
||||||
#
|
#
|
||||||
# @example
|
# @example
|
||||||
# require 'google/apis/blogger_v2'
|
# require 'google/apis/blogger_v2'
|
||||||
|
|
|
||||||
|
|
@ -20,13 +20,12 @@ module Google
|
||||||
module Apis
|
module Apis
|
||||||
# Blogger API v3
|
# Blogger API v3
|
||||||
#
|
#
|
||||||
# The Blogger API provides access to posts, comments and pages of a
|
# The Blogger API provides access to posts, comments and pages of a Blogger blog.
|
||||||
# Blogger blog.
|
|
||||||
#
|
#
|
||||||
# @see https://developers.google.com/blogger/docs/3.0/getting_started
|
# @see https://developers.google.com/blogger/docs/3.0/getting_started
|
||||||
module BloggerV3
|
module BloggerV3
|
||||||
VERSION = 'V3'
|
VERSION = 'V3'
|
||||||
REVISION = '20200711'
|
REVISION = '20200801'
|
||||||
|
|
||||||
# Manage your Blogger account
|
# Manage your Blogger account
|
||||||
AUTH_BLOGGER = 'https://www.googleapis.com/auth/blogger'
|
AUTH_BLOGGER = 'https://www.googleapis.com/auth/blogger'
|
||||||
|
|
|
||||||
|
|
@ -256,8 +256,7 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :photos_album_key
|
attr_accessor :photos_album_key
|
||||||
|
|
||||||
# Access permissions that the user has for the blog (ADMIN, AUTHOR, or
|
# Access permissions that the user has for the blog (ADMIN, AUTHOR, or READER).
|
||||||
# READER).
|
|
||||||
# Corresponds to the JSON property `role`
|
# Corresponds to the JSON property `role`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :role
|
attr_accessor :role
|
||||||
|
|
|
||||||
|
|
@ -22,8 +22,7 @@ module Google
|
||||||
module BloggerV3
|
module BloggerV3
|
||||||
# Blogger API v3
|
# Blogger API v3
|
||||||
#
|
#
|
||||||
# The Blogger API provides access to posts, comments and pages of a
|
# The Blogger API provides access to posts, comments and pages of a Blogger blog.
|
||||||
# Blogger blog.
|
|
||||||
#
|
#
|
||||||
# @example
|
# @example
|
||||||
# require 'google/apis/blogger_v3'
|
# require 'google/apis/blogger_v3'
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ module Google
|
||||||
# @see https://developers.google.com/custom-search/v1/introduction
|
# @see https://developers.google.com/custom-search/v1/introduction
|
||||||
module CustomsearchV1
|
module CustomsearchV1
|
||||||
VERSION = 'V1'
|
VERSION = 'V1'
|
||||||
REVISION = '20200723'
|
REVISION = '20200801'
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -47,37 +47,30 @@ module Google
|
||||||
@batch_path = 'batch'
|
@batch_path = 'batch'
|
||||||
end
|
end
|
||||||
|
|
||||||
# Returns metadata about the search performed, metadata about the
|
# Returns metadata about the search performed, metadata about the engine used
|
||||||
# engine used for the search, and the search results.
|
# for the search, and the search results.
|
||||||
# @param [String] c2coff
|
# @param [String] c2coff
|
||||||
# Enables or disables [Simplified and Traditional Chinese
|
# Enables or disables [Simplified and Traditional Chinese Search](https://
|
||||||
# Search](https://developers.google.com/custom-search/docs/xml_results#
|
# developers.google.com/custom-search/docs/xml_results#chineseSearch). The
|
||||||
# chineseSearch).
|
# default value for this parameter is 0 (zero), meaning that the feature is
|
||||||
# The default value for this parameter is 0 (zero), meaning that the feature
|
# enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)
|
||||||
# is enabled. Supported values are:
|
|
||||||
# * `1`: Disabled
|
|
||||||
# * `0`: Enabled (default)
|
|
||||||
# @param [String] cr
|
# @param [String] cr
|
||||||
# Restricts search results to documents originating in a particular country.
|
# Restricts search results to documents originating in a particular country. You
|
||||||
# You may use [Boolean
|
# may use [Boolean operators](https://developers.google.com/custom-search/docs/
|
||||||
# operators](https://developers.google.com/custom-search/docs/
|
# xml_results_appendices#booleanOperators) in the cr parameter's value. Google
|
||||||
# xml_results_appendices#booleanOperators)
|
# Search determines the country of a document by analyzing: * the top-level
|
||||||
# in the cr parameter's value.
|
# domain (TLD) of the document's URL * the geographic location of the Web server'
|
||||||
# Google Search determines the country of a document by analyzing:
|
# s IP address See the [Country Parameter Values](https://developers.google.com/
|
||||||
# * the top-level domain (TLD) of the document's URL
|
# custom-search/docs/xml_results_appendices#countryCollections) page for a list
|
||||||
# * the geographic location of the Web server's IP address
|
# of valid values for this parameter.
|
||||||
# See the [Country Parameter
|
|
||||||
# Values](https://developers.google.com/custom-search/docs/
|
|
||||||
# xml_results_appendices#countryCollections)
|
|
||||||
# page for a list of valid values for this parameter.
|
|
||||||
# @param [String] cx
|
# @param [String] cx
|
||||||
# The Programmable Search Engine ID to use for this request.
|
# The Programmable Search Engine ID to use for this request.
|
||||||
# @param [String] date_restrict
|
# @param [String] date_restrict
|
||||||
# Restricts results to URLs based on date. Supported values include:
|
# Restricts results to URLs based on date. Supported values include: * `d[number]
|
||||||
# * `d[number]`: requests results from the specified number of past days.
|
# `: requests results from the specified number of past days. * `w[number]`:
|
||||||
# * `w[number]`: requests results from the specified number of past weeks.
|
# requests results from the specified number of past weeks. * `m[number]`:
|
||||||
# * `m[number]`: requests results from the specified number of past months.
|
# requests results from the specified number of past months. * `y[number]`:
|
||||||
# * `y[number]`: requests results from the specified number of past years.
|
# requests results from the specified number of past years.
|
||||||
# @param [String] exact_terms
|
# @param [String] exact_terms
|
||||||
# Identifies a phrase that all documents in the search results must contain.
|
# Identifies a phrase that all documents in the search results must contain.
|
||||||
# @param [String] exclude_terms
|
# @param [String] exclude_terms
|
||||||
|
|
@ -85,144 +78,80 @@ module Google
|
||||||
# search results.
|
# search results.
|
||||||
# @param [String] file_type
|
# @param [String] file_type
|
||||||
# Restricts results to files of a specified extension. A list of file types
|
# Restricts results to files of a specified extension. A list of file types
|
||||||
# indexable by Google can be found in Search Console [Help
|
# indexable by Google can be found in Search Console [Help Center](https://
|
||||||
# Center](https://support.google.com/webmasters/answer/35287).
|
# support.google.com/webmasters/answer/35287).
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# Controls turning on or off the duplicate content filter.
|
# Controls turning on or off the duplicate content filter. * See [Automatic
|
||||||
# * See [Automatic
|
|
||||||
# Filtering](https://developers.google.com/custom-search/docs/xml_results#
|
# Filtering](https://developers.google.com/custom-search/docs/xml_results#
|
||||||
# automaticFiltering)
|
# automaticFiltering) for more information about Google's search results filters.
|
||||||
# for more information about Google's search results filters. Note that host
|
# Note that host crowding filtering applies only to multi-site searches. * By
|
||||||
# crowding filtering applies only to multi-site searches.
|
# default, Google applies filtering to all search results to improve the quality
|
||||||
# * By default, Google applies filtering to all search results to improve the
|
# of those results. Acceptable values are: * `0`: Turns off duplicate content
|
||||||
# quality of those results.
|
# filter. * `1`: Turns on duplicate content filter.
|
||||||
# Acceptable values are:
|
|
||||||
# * `0`: Turns off duplicate content filter.
|
|
||||||
# * `1`: Turns on duplicate content filter.
|
|
||||||
# @param [String] gl
|
# @param [String] gl
|
||||||
# Geolocation of end user.
|
# Geolocation of end user. * The `gl` parameter value is a two-letter country
|
||||||
# * The `gl` parameter value is a two-letter country code. The `gl` parameter
|
# code. The `gl` parameter boosts search results whose country of origin matches
|
||||||
# boosts search results whose country of origin matches the parameter value.
|
# the parameter value. See the [Country Codes](https://developers.google.com/
|
||||||
# See the [Country
|
# custom-search/docs/xml_results_appendices#countryCodes) page for a list of
|
||||||
# Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#
|
# valid values. * Specifying a `gl` parameter value should lead to more relevant
|
||||||
# countryCodes)
|
# results. This is particularly true for international customers and, even more
|
||||||
# page for a list of valid values.
|
|
||||||
# * Specifying a `gl` parameter value should lead to more relevant results.
|
|
||||||
# This is particularly true for international customers and, even more
|
|
||||||
# specifically, for customers in English- speaking countries other than the
|
# specifically, for customers in English- speaking countries other than the
|
||||||
# United States.
|
# United States.
|
||||||
# @param [String] googlehost
|
# @param [String] googlehost
|
||||||
# **Deprecated**. Use the `gl` parameter for a similar effect.
|
# **Deprecated**. Use the `gl` parameter for a similar effect. The local Google
|
||||||
# The local Google domain (for example, google.com, google.de, or
|
# domain (for example, google.com, google.de, or google.fr) to use to perform
|
||||||
# google.fr) to use to perform the search.
|
# the search.
|
||||||
# @param [String] high_range
|
# @param [String] high_range
|
||||||
# Specifies the ending value for a search range.
|
# Specifies the ending value for a search range. * Use `lowRange` and `highRange`
|
||||||
# * Use `lowRange` and `highRange` to append an inclusive search range of
|
# to append an inclusive search range of `lowRange...highRange` to the query.
|
||||||
# `lowRange...highRange` to the query.
|
|
||||||
# @param [String] hl
|
# @param [String] hl
|
||||||
# Sets the user interface language.
|
# Sets the user interface language. * Explicitly setting this parameter improves
|
||||||
# * Explicitly setting this parameter improves the performance and the
|
# the performance and the quality of your search results. * See the [Interface
|
||||||
# quality of your search results.
|
|
||||||
# * See the [Interface
|
|
||||||
# Languages](https://developers.google.com/custom-search/docs/xml_results#
|
# Languages](https://developers.google.com/custom-search/docs/xml_results#
|
||||||
# wsInterfaceLanguages)
|
# wsInterfaceLanguages) section of [Internationalizing Queries and Results
|
||||||
# section of [Internationalizing Queries and Results
|
|
||||||
# Presentation](https://developers.google.com/custom-search/docs/xml_results#
|
# Presentation](https://developers.google.com/custom-search/docs/xml_results#
|
||||||
# wsInternationalizing)
|
# wsInternationalizing) for more information, and (Supported Interface Languages)
|
||||||
# for more information, and (Supported Interface
|
# [https://developers.google.com/custom-search/docs/xml_results_appendices#
|
||||||
# Languages)[https://developers.google.com/custom-search/docs/
|
# interfaceLanguages] for a list of supported languages.
|
||||||
# xml_results_appendices#interfaceLanguages]
|
|
||||||
# for a list of supported languages.
|
|
||||||
# @param [String] hq
|
# @param [String] hq
|
||||||
# Appends the specified query terms to the query, as if they were combined
|
# Appends the specified query terms to the query, as if they were combined with
|
||||||
# with a logical AND operator.
|
# a logical AND operator.
|
||||||
# @param [String] img_color_type
|
# @param [String] img_color_type
|
||||||
# Returns black and white, grayscale, transparent, or color images.
|
# Returns black and white, grayscale, transparent, or color images. Acceptable
|
||||||
# Acceptable values are:
|
# values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`:
|
||||||
# * `"color"`
|
# transparent background
|
||||||
# * `"gray"`
|
|
||||||
# * `"mono"`: black and white
|
|
||||||
# * `"trans"`: transparent background
|
|
||||||
# @param [String] img_dominant_color
|
# @param [String] img_dominant_color
|
||||||
# Returns images of a specific dominant color. Acceptable values are:
|
# Returns images of a specific dominant color. Acceptable values are: * `"black"`
|
||||||
# * `"black"`
|
# * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"
|
||||||
# * `"blue"`
|
# purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"`
|
||||||
# * `"brown"`
|
|
||||||
# * `"gray"`
|
|
||||||
# * `"green"`
|
|
||||||
# * `"orange"`
|
|
||||||
# * `"pink"`
|
|
||||||
# * `"purple"`
|
|
||||||
# * `"red"`
|
|
||||||
# * `"teal"`
|
|
||||||
# * `"white"`
|
|
||||||
# * `"yellow"`
|
|
||||||
# @param [String] img_size
|
# @param [String] img_size
|
||||||
# Returns images of a specified size. Acceptable values are:
|
# Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"
|
||||||
# * `"huge"`
|
# ` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"`
|
||||||
# * `"icon"`
|
|
||||||
# * `"large"`
|
|
||||||
# * `"medium"`
|
|
||||||
# * `"small"`
|
|
||||||
# * `"xlarge"`
|
|
||||||
# * `"xxlarge"`
|
|
||||||
# @param [String] img_type
|
# @param [String] img_type
|
||||||
# Returns images of a type. Acceptable values are:
|
# Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"
|
||||||
# * `"clipart"`
|
# lineart"` * `"stock"` * `"photo"` * `"animated"`
|
||||||
# * `"face"`
|
|
||||||
# * `"lineart"`
|
|
||||||
# * `"stock"`
|
|
||||||
# * `"photo"`
|
|
||||||
# * `"animated"`
|
|
||||||
# @param [String] link_site
|
# @param [String] link_site
|
||||||
# Specifies that all search results should contain a link to a particular
|
# Specifies that all search results should contain a link to a particular URL.
|
||||||
# URL.
|
|
||||||
# @param [String] low_range
|
# @param [String] low_range
|
||||||
# Specifies the starting value for a search range. Use `lowRange` and
|
# Specifies the starting value for a search range. Use `lowRange` and `highRange`
|
||||||
# `highRange` to append an inclusive search range of `lowRange...highRange`
|
# to append an inclusive search range of `lowRange...highRange` to the query.
|
||||||
# to the query.
|
|
||||||
# @param [String] lr
|
# @param [String] lr
|
||||||
# Restricts the search to documents written in a particular language (e.g.,
|
# Restricts the search to documents written in a particular language (e.g., `lr=
|
||||||
# `lr=lang_ja`).
|
# lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic * `"lang_bg"`:
|
||||||
# Acceptable values are:
|
# Bulgarian * `"lang_ca"`: Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `
|
||||||
# * `"lang_ar"`: Arabic
|
# "lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`:
|
||||||
# * `"lang_bg"`: Bulgarian
|
# Spanish * `"lang_et"`: Estonian * `"lang_fi"`: Finnish * `"lang_fr"`: French *
|
||||||
# * `"lang_ca"`: Catalan
|
# `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `"
|
||||||
# * `"lang_cs"`: Czech
|
# lang_is"`: Icelandic * `"lang_it"`: Italian * `"lang_iw"`: Hebrew * `"lang_ja"`
|
||||||
# * `"lang_da"`: Danish
|
# : Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`:
|
||||||
# * `"lang_de"`: German
|
# Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`: Polish * `
|
||||||
# * `"lang_el"`: Greek
|
# "lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"
|
||||||
# * `"lang_en"`: English
|
# lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`
|
||||||
# * `"lang_es"`: Spanish
|
# : Swedish * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"
|
||||||
# * `"lang_et"`: Estonian
|
# lang_zh-TW"`: Chinese (Traditional)
|
||||||
# * `"lang_fi"`: Finnish
|
|
||||||
# * `"lang_fr"`: French
|
|
||||||
# * `"lang_hr"`: Croatian
|
|
||||||
# * `"lang_hu"`: Hungarian
|
|
||||||
# * `"lang_id"`: Indonesian
|
|
||||||
# * `"lang_is"`: Icelandic
|
|
||||||
# * `"lang_it"`: Italian
|
|
||||||
# * `"lang_iw"`: Hebrew
|
|
||||||
# * `"lang_ja"`: Japanese
|
|
||||||
# * `"lang_ko"`: Korean
|
|
||||||
# * `"lang_lt"`: Lithuanian
|
|
||||||
# * `"lang_lv"`: Latvian
|
|
||||||
# * `"lang_nl"`: Dutch
|
|
||||||
# * `"lang_no"`: Norwegian
|
|
||||||
# * `"lang_pl"`: Polish
|
|
||||||
# * `"lang_pt"`: Portuguese
|
|
||||||
# * `"lang_ro"`: Romanian
|
|
||||||
# * `"lang_ru"`: Russian
|
|
||||||
# * `"lang_sk"`: Slovak
|
|
||||||
# * `"lang_sl"`: Slovenian
|
|
||||||
# * `"lang_sr"`: Serbian
|
|
||||||
# * `"lang_sv"`: Swedish
|
|
||||||
# * `"lang_tr"`: Turkish
|
|
||||||
# * `"lang_zh-CN"`: Chinese (Simplified)
|
|
||||||
# * `"lang_zh-TW"`: Chinese (Traditional)
|
|
||||||
# @param [Fixnum] num
|
# @param [Fixnum] num
|
||||||
# Number of search results to return.
|
# Number of search results to return. * Valid values are integers between 1 and
|
||||||
# * Valid values are integers between 1 and 10, inclusive.
|
# 10, inclusive.
|
||||||
# @param [String] or_terms
|
# @param [String] or_terms
|
||||||
# Provides additional search terms to check for in a document, where each
|
# Provides additional search terms to check for in a document, where each
|
||||||
# document in the search results must contain at least one of the additional
|
# document in the search results must contain at least one of the additional
|
||||||
|
|
@ -233,42 +162,35 @@ module Google
|
||||||
# Specifies that all search results should be pages that are related to the
|
# Specifies that all search results should be pages that are related to the
|
||||||
# specified URL.
|
# specified URL.
|
||||||
# @param [String] rights
|
# @param [String] rights
|
||||||
# Filters based on licensing. Supported values include: `cc_publicdomain`,
|
# Filters based on licensing. Supported values include: `cc_publicdomain`, `
|
||||||
# `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and
|
# cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and
|
||||||
# combinations of these. See [typical
|
# combinations of these. See [typical combinations](https://wiki.creativecommons.
|
||||||
# combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).
|
# org/wiki/CC_Search_integration).
|
||||||
# @param [String] safe
|
# @param [String] safe
|
||||||
# Search safety level. Acceptable values are:
|
# Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch
|
||||||
# * `"active"`: Enables SafeSearch filtering.
|
# filtering. * `"off"`: Disables SafeSearch filtering. (default)
|
||||||
# * `"off"`: Disables SafeSearch filtering. (default)
|
|
||||||
# @param [String] search_type
|
# @param [String] search_type
|
||||||
# Specifies the search type: `image`. If unspecified, results are limited to
|
# Specifies the search type: `image`. If unspecified, results are limited to
|
||||||
# webpages.
|
# webpages. Acceptable values are: * `"image"`: custom image search.
|
||||||
# Acceptable values are:
|
|
||||||
# * `"image"`: custom image search.
|
|
||||||
# @param [String] site_search
|
# @param [String] site_search
|
||||||
# Specifies a given site which should always be included or excluded from
|
# Specifies a given site which should always be included or excluded from
|
||||||
# results (see `siteSearchFilter` parameter, below).
|
# results (see `siteSearchFilter` parameter, below).
|
||||||
# @param [String] site_search_filter
|
# @param [String] site_search_filter
|
||||||
# Controls whether to include or exclude results from the site named in the
|
# Controls whether to include or exclude results from the site named in the `
|
||||||
# `siteSearch` parameter.
|
# siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`:
|
||||||
# Acceptable values are:
|
# include
|
||||||
# * `"e"`: exclude
|
|
||||||
# * `"i"`: include
|
|
||||||
# @param [String] sort
|
# @param [String] sort
|
||||||
# The sort expression to apply to the results. The sort parameter specifies
|
# The sort expression to apply to the results. The sort parameter specifies that
|
||||||
# that the results be sorted according to the specified expression i.e. sort
|
# the results be sorted according to the specified expression i.e. sort by date.
|
||||||
# by date.
|
# [Example: sort=date](https://developers.google.com/custom-search/docs/
|
||||||
# [Example:
|
# structured_search#sort-by-attribute).
|
||||||
# sort=date](https://developers.google.com/custom-search/docs/structured_search#
|
|
||||||
# sort-by-attribute).
|
|
||||||
# @param [Fixnum] start
|
# @param [Fixnum] start
|
||||||
# The index of the first result to return. The default number of results per
|
# The index of the first result to return. The default number of results per
|
||||||
# page is 10, so `&start=11` would start at the top of the second page of
|
# page is 10, so `&start=11` would start at the top of the second page of
|
||||||
# results. **Note**: The JSON API will never return more than 100 results,
|
# results. **Note**: The JSON API will never return more than 100 results, even
|
||||||
# even if more than 100 documents match the query, so setting the sum of
|
# if more than 100 documents match the query, so setting the sum of `start + num`
|
||||||
# `start + num` to a number greater than 100 will produce an error. Also note
|
# to a number greater than 100 will produce an error. Also note that the
|
||||||
# that the maximum value for `num` is 10.
|
# maximum value for `num` is 10.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -326,38 +248,30 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Returns metadata about the search performed, metadata about the
|
# Returns metadata about the search performed, metadata about the engine used
|
||||||
# engine used for the search, and the search results. Uses a small set
|
# for the search, and the search results. Uses a small set of url patterns.
|
||||||
# of url patterns.
|
|
||||||
# @param [String] c2coff
|
# @param [String] c2coff
|
||||||
# Enables or disables [Simplified and Traditional Chinese
|
# Enables or disables [Simplified and Traditional Chinese Search](https://
|
||||||
# Search](https://developers.google.com/custom-search/docs/xml_results#
|
# developers.google.com/custom-search/docs/xml_results#chineseSearch). The
|
||||||
# chineseSearch).
|
# default value for this parameter is 0 (zero), meaning that the feature is
|
||||||
# The default value for this parameter is 0 (zero), meaning that the feature
|
# enabled. Supported values are: * `1`: Disabled * `0`: Enabled (default)
|
||||||
# is enabled. Supported values are:
|
|
||||||
# * `1`: Disabled
|
|
||||||
# * `0`: Enabled (default)
|
|
||||||
# @param [String] cr
|
# @param [String] cr
|
||||||
# Restricts search results to documents originating in a particular country.
|
# Restricts search results to documents originating in a particular country. You
|
||||||
# You may use [Boolean
|
# may use [Boolean operators](https://developers.google.com/custom-search/docs/
|
||||||
# operators](https://developers.google.com/custom-search/docs/
|
# xml_results_appendices#booleanOperators) in the cr parameter's value. Google
|
||||||
# xml_results_appendices#booleanOperators)
|
# Search determines the country of a document by analyzing: * the top-level
|
||||||
# in the cr parameter's value.
|
# domain (TLD) of the document's URL * the geographic location of the Web server'
|
||||||
# Google Search determines the country of a document by analyzing:
|
# s IP address See the [Country Parameter Values](https://developers.google.com/
|
||||||
# * the top-level domain (TLD) of the document's URL
|
# custom-search/docs/xml_results_appendices#countryCollections) page for a list
|
||||||
# * the geographic location of the Web server's IP address
|
# of valid values for this parameter.
|
||||||
# See the [Country Parameter
|
|
||||||
# Values](https://developers.google.com/custom-search/docs/
|
|
||||||
# xml_results_appendices#countryCollections)
|
|
||||||
# page for a list of valid values for this parameter.
|
|
||||||
# @param [String] cx
|
# @param [String] cx
|
||||||
# The Programmable Search Engine ID to use for this request.
|
# The Programmable Search Engine ID to use for this request.
|
||||||
# @param [String] date_restrict
|
# @param [String] date_restrict
|
||||||
# Restricts results to URLs based on date. Supported values include:
|
# Restricts results to URLs based on date. Supported values include: * `d[number]
|
||||||
# * `d[number]`: requests results from the specified number of past days.
|
# `: requests results from the specified number of past days. * `w[number]`:
|
||||||
# * `w[number]`: requests results from the specified number of past weeks.
|
# requests results from the specified number of past weeks. * `m[number]`:
|
||||||
# * `m[number]`: requests results from the specified number of past months.
|
# requests results from the specified number of past months. * `y[number]`:
|
||||||
# * `y[number]`: requests results from the specified number of past years.
|
# requests results from the specified number of past years.
|
||||||
# @param [String] exact_terms
|
# @param [String] exact_terms
|
||||||
# Identifies a phrase that all documents in the search results must contain.
|
# Identifies a phrase that all documents in the search results must contain.
|
||||||
# @param [String] exclude_terms
|
# @param [String] exclude_terms
|
||||||
|
|
@ -365,144 +279,80 @@ module Google
|
||||||
# search results.
|
# search results.
|
||||||
# @param [String] file_type
|
# @param [String] file_type
|
||||||
# Restricts results to files of a specified extension. A list of file types
|
# Restricts results to files of a specified extension. A list of file types
|
||||||
# indexable by Google can be found in Search Console [Help
|
# indexable by Google can be found in Search Console [Help Center](https://
|
||||||
# Center](https://support.google.com/webmasters/answer/35287).
|
# support.google.com/webmasters/answer/35287).
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# Controls turning on or off the duplicate content filter.
|
# Controls turning on or off the duplicate content filter. * See [Automatic
|
||||||
# * See [Automatic
|
|
||||||
# Filtering](https://developers.google.com/custom-search/docs/xml_results#
|
# Filtering](https://developers.google.com/custom-search/docs/xml_results#
|
||||||
# automaticFiltering)
|
# automaticFiltering) for more information about Google's search results filters.
|
||||||
# for more information about Google's search results filters. Note that host
|
# Note that host crowding filtering applies only to multi-site searches. * By
|
||||||
# crowding filtering applies only to multi-site searches.
|
# default, Google applies filtering to all search results to improve the quality
|
||||||
# * By default, Google applies filtering to all search results to improve the
|
# of those results. Acceptable values are: * `0`: Turns off duplicate content
|
||||||
# quality of those results.
|
# filter. * `1`: Turns on duplicate content filter.
|
||||||
# Acceptable values are:
|
|
||||||
# * `0`: Turns off duplicate content filter.
|
|
||||||
# * `1`: Turns on duplicate content filter.
|
|
||||||
# @param [String] gl
|
# @param [String] gl
|
||||||
# Geolocation of end user.
|
# Geolocation of end user. * The `gl` parameter value is a two-letter country
|
||||||
# * The `gl` parameter value is a two-letter country code. The `gl` parameter
|
# code. The `gl` parameter boosts search results whose country of origin matches
|
||||||
# boosts search results whose country of origin matches the parameter value.
|
# the parameter value. See the [Country Codes](https://developers.google.com/
|
||||||
# See the [Country
|
# custom-search/docs/xml_results_appendices#countryCodes) page for a list of
|
||||||
# Codes](https://developers.google.com/custom-search/docs/xml_results_appendices#
|
# valid values. * Specifying a `gl` parameter value should lead to more relevant
|
||||||
# countryCodes)
|
# results. This is particularly true for international customers and, even more
|
||||||
# page for a list of valid values.
|
|
||||||
# * Specifying a `gl` parameter value should lead to more relevant results.
|
|
||||||
# This is particularly true for international customers and, even more
|
|
||||||
# specifically, for customers in English- speaking countries other than the
|
# specifically, for customers in English- speaking countries other than the
|
||||||
# United States.
|
# United States.
|
||||||
# @param [String] googlehost
|
# @param [String] googlehost
|
||||||
# **Deprecated**. Use the `gl` parameter for a similar effect.
|
# **Deprecated**. Use the `gl` parameter for a similar effect. The local Google
|
||||||
# The local Google domain (for example, google.com, google.de, or
|
# domain (for example, google.com, google.de, or google.fr) to use to perform
|
||||||
# google.fr) to use to perform the search.
|
# the search.
|
||||||
# @param [String] high_range
|
# @param [String] high_range
|
||||||
# Specifies the ending value for a search range.
|
# Specifies the ending value for a search range. * Use `lowRange` and `highRange`
|
||||||
# * Use `lowRange` and `highRange` to append an inclusive search range of
|
# to append an inclusive search range of `lowRange...highRange` to the query.
|
||||||
# `lowRange...highRange` to the query.
|
|
||||||
# @param [String] hl
|
# @param [String] hl
|
||||||
# Sets the user interface language.
|
# Sets the user interface language. * Explicitly setting this parameter improves
|
||||||
# * Explicitly setting this parameter improves the performance and the
|
# the performance and the quality of your search results. * See the [Interface
|
||||||
# quality of your search results.
|
|
||||||
# * See the [Interface
|
|
||||||
# Languages](https://developers.google.com/custom-search/docs/xml_results#
|
# Languages](https://developers.google.com/custom-search/docs/xml_results#
|
||||||
# wsInterfaceLanguages)
|
# wsInterfaceLanguages) section of [Internationalizing Queries and Results
|
||||||
# section of [Internationalizing Queries and Results
|
|
||||||
# Presentation](https://developers.google.com/custom-search/docs/xml_results#
|
# Presentation](https://developers.google.com/custom-search/docs/xml_results#
|
||||||
# wsInternationalizing)
|
# wsInternationalizing) for more information, and (Supported Interface Languages)
|
||||||
# for more information, and (Supported Interface
|
# [https://developers.google.com/custom-search/docs/xml_results_appendices#
|
||||||
# Languages)[https://developers.google.com/custom-search/docs/
|
# interfaceLanguages] for a list of supported languages.
|
||||||
# xml_results_appendices#interfaceLanguages]
|
|
||||||
# for a list of supported languages.
|
|
||||||
# @param [String] hq
|
# @param [String] hq
|
||||||
# Appends the specified query terms to the query, as if they were combined
|
# Appends the specified query terms to the query, as if they were combined with
|
||||||
# with a logical AND operator.
|
# a logical AND operator.
|
||||||
# @param [String] img_color_type
|
# @param [String] img_color_type
|
||||||
# Returns black and white, grayscale, transparent, or color images.
|
# Returns black and white, grayscale, transparent, or color images. Acceptable
|
||||||
# Acceptable values are:
|
# values are: * `"color"` * `"gray"` * `"mono"`: black and white * `"trans"`:
|
||||||
# * `"color"`
|
# transparent background
|
||||||
# * `"gray"`
|
|
||||||
# * `"mono"`: black and white
|
|
||||||
# * `"trans"`: transparent background
|
|
||||||
# @param [String] img_dominant_color
|
# @param [String] img_dominant_color
|
||||||
# Returns images of a specific dominant color. Acceptable values are:
|
# Returns images of a specific dominant color. Acceptable values are: * `"black"`
|
||||||
# * `"black"`
|
# * `"blue"` * `"brown"` * `"gray"` * `"green"` * `"orange"` * `"pink"` * `"
|
||||||
# * `"blue"`
|
# purple"` * `"red"` * `"teal"` * `"white"` * `"yellow"`
|
||||||
# * `"brown"`
|
|
||||||
# * `"gray"`
|
|
||||||
# * `"green"`
|
|
||||||
# * `"orange"`
|
|
||||||
# * `"pink"`
|
|
||||||
# * `"purple"`
|
|
||||||
# * `"red"`
|
|
||||||
# * `"teal"`
|
|
||||||
# * `"white"`
|
|
||||||
# * `"yellow"`
|
|
||||||
# @param [String] img_size
|
# @param [String] img_size
|
||||||
# Returns images of a specified size. Acceptable values are:
|
# Returns images of a specified size. Acceptable values are: * `"huge"` * `"icon"
|
||||||
# * `"huge"`
|
# ` * `"large"` * `"medium"` * `"small"` * `"xlarge"` * `"xxlarge"`
|
||||||
# * `"icon"`
|
|
||||||
# * `"large"`
|
|
||||||
# * `"medium"`
|
|
||||||
# * `"small"`
|
|
||||||
# * `"xlarge"`
|
|
||||||
# * `"xxlarge"`
|
|
||||||
# @param [String] img_type
|
# @param [String] img_type
|
||||||
# Returns images of a type. Acceptable values are:
|
# Returns images of a type. Acceptable values are: * `"clipart"` * `"face"` * `"
|
||||||
# * `"clipart"`
|
# lineart"` * `"stock"` * `"photo"` * `"animated"`
|
||||||
# * `"face"`
|
|
||||||
# * `"lineart"`
|
|
||||||
# * `"stock"`
|
|
||||||
# * `"photo"`
|
|
||||||
# * `"animated"`
|
|
||||||
# @param [String] link_site
|
# @param [String] link_site
|
||||||
# Specifies that all search results should contain a link to a particular
|
# Specifies that all search results should contain a link to a particular URL.
|
||||||
# URL.
|
|
||||||
# @param [String] low_range
|
# @param [String] low_range
|
||||||
# Specifies the starting value for a search range. Use `lowRange` and
|
# Specifies the starting value for a search range. Use `lowRange` and `highRange`
|
||||||
# `highRange` to append an inclusive search range of `lowRange...highRange`
|
# to append an inclusive search range of `lowRange...highRange` to the query.
|
||||||
# to the query.
|
|
||||||
# @param [String] lr
|
# @param [String] lr
|
||||||
# Restricts the search to documents written in a particular language (e.g.,
|
# Restricts the search to documents written in a particular language (e.g., `lr=
|
||||||
# `lr=lang_ja`).
|
# lang_ja`). Acceptable values are: * `"lang_ar"`: Arabic * `"lang_bg"`:
|
||||||
# Acceptable values are:
|
# Bulgarian * `"lang_ca"`: Catalan * `"lang_cs"`: Czech * `"lang_da"`: Danish * `
|
||||||
# * `"lang_ar"`: Arabic
|
# "lang_de"`: German * `"lang_el"`: Greek * `"lang_en"`: English * `"lang_es"`:
|
||||||
# * `"lang_bg"`: Bulgarian
|
# Spanish * `"lang_et"`: Estonian * `"lang_fi"`: Finnish * `"lang_fr"`: French *
|
||||||
# * `"lang_ca"`: Catalan
|
# `"lang_hr"`: Croatian * `"lang_hu"`: Hungarian * `"lang_id"`: Indonesian * `"
|
||||||
# * `"lang_cs"`: Czech
|
# lang_is"`: Icelandic * `"lang_it"`: Italian * `"lang_iw"`: Hebrew * `"lang_ja"`
|
||||||
# * `"lang_da"`: Danish
|
# : Japanese * `"lang_ko"`: Korean * `"lang_lt"`: Lithuanian * `"lang_lv"`:
|
||||||
# * `"lang_de"`: German
|
# Latvian * `"lang_nl"`: Dutch * `"lang_no"`: Norwegian * `"lang_pl"`: Polish * `
|
||||||
# * `"lang_el"`: Greek
|
# "lang_pt"`: Portuguese * `"lang_ro"`: Romanian * `"lang_ru"`: Russian * `"
|
||||||
# * `"lang_en"`: English
|
# lang_sk"`: Slovak * `"lang_sl"`: Slovenian * `"lang_sr"`: Serbian * `"lang_sv"`
|
||||||
# * `"lang_es"`: Spanish
|
# : Swedish * `"lang_tr"`: Turkish * `"lang_zh-CN"`: Chinese (Simplified) * `"
|
||||||
# * `"lang_et"`: Estonian
|
# lang_zh-TW"`: Chinese (Traditional)
|
||||||
# * `"lang_fi"`: Finnish
|
|
||||||
# * `"lang_fr"`: French
|
|
||||||
# * `"lang_hr"`: Croatian
|
|
||||||
# * `"lang_hu"`: Hungarian
|
|
||||||
# * `"lang_id"`: Indonesian
|
|
||||||
# * `"lang_is"`: Icelandic
|
|
||||||
# * `"lang_it"`: Italian
|
|
||||||
# * `"lang_iw"`: Hebrew
|
|
||||||
# * `"lang_ja"`: Japanese
|
|
||||||
# * `"lang_ko"`: Korean
|
|
||||||
# * `"lang_lt"`: Lithuanian
|
|
||||||
# * `"lang_lv"`: Latvian
|
|
||||||
# * `"lang_nl"`: Dutch
|
|
||||||
# * `"lang_no"`: Norwegian
|
|
||||||
# * `"lang_pl"`: Polish
|
|
||||||
# * `"lang_pt"`: Portuguese
|
|
||||||
# * `"lang_ro"`: Romanian
|
|
||||||
# * `"lang_ru"`: Russian
|
|
||||||
# * `"lang_sk"`: Slovak
|
|
||||||
# * `"lang_sl"`: Slovenian
|
|
||||||
# * `"lang_sr"`: Serbian
|
|
||||||
# * `"lang_sv"`: Swedish
|
|
||||||
# * `"lang_tr"`: Turkish
|
|
||||||
# * `"lang_zh-CN"`: Chinese (Simplified)
|
|
||||||
# * `"lang_zh-TW"`: Chinese (Traditional)
|
|
||||||
# @param [Fixnum] num
|
# @param [Fixnum] num
|
||||||
# Number of search results to return.
|
# Number of search results to return. * Valid values are integers between 1 and
|
||||||
# * Valid values are integers between 1 and 10, inclusive.
|
# 10, inclusive.
|
||||||
# @param [String] or_terms
|
# @param [String] or_terms
|
||||||
# Provides additional search terms to check for in a document, where each
|
# Provides additional search terms to check for in a document, where each
|
||||||
# document in the search results must contain at least one of the additional
|
# document in the search results must contain at least one of the additional
|
||||||
|
|
@ -513,42 +363,35 @@ module Google
|
||||||
# Specifies that all search results should be pages that are related to the
|
# Specifies that all search results should be pages that are related to the
|
||||||
# specified URL.
|
# specified URL.
|
||||||
# @param [String] rights
|
# @param [String] rights
|
||||||
# Filters based on licensing. Supported values include: `cc_publicdomain`,
|
# Filters based on licensing. Supported values include: `cc_publicdomain`, `
|
||||||
# `cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and
|
# cc_attribute`, `cc_sharealike`, `cc_noncommercial`, `cc_nonderived` and
|
||||||
# combinations of these. See [typical
|
# combinations of these. See [typical combinations](https://wiki.creativecommons.
|
||||||
# combinations](https://wiki.creativecommons.org/wiki/CC_Search_integration).
|
# org/wiki/CC_Search_integration).
|
||||||
# @param [String] safe
|
# @param [String] safe
|
||||||
# Search safety level. Acceptable values are:
|
# Search safety level. Acceptable values are: * `"active"`: Enables SafeSearch
|
||||||
# * `"active"`: Enables SafeSearch filtering.
|
# filtering. * `"off"`: Disables SafeSearch filtering. (default)
|
||||||
# * `"off"`: Disables SafeSearch filtering. (default)
|
|
||||||
# @param [String] search_type
|
# @param [String] search_type
|
||||||
# Specifies the search type: `image`. If unspecified, results are limited to
|
# Specifies the search type: `image`. If unspecified, results are limited to
|
||||||
# webpages.
|
# webpages. Acceptable values are: * `"image"`: custom image search.
|
||||||
# Acceptable values are:
|
|
||||||
# * `"image"`: custom image search.
|
|
||||||
# @param [String] site_search
|
# @param [String] site_search
|
||||||
# Specifies a given site which should always be included or excluded from
|
# Specifies a given site which should always be included or excluded from
|
||||||
# results (see `siteSearchFilter` parameter, below).
|
# results (see `siteSearchFilter` parameter, below).
|
||||||
# @param [String] site_search_filter
|
# @param [String] site_search_filter
|
||||||
# Controls whether to include or exclude results from the site named in the
|
# Controls whether to include or exclude results from the site named in the `
|
||||||
# `siteSearch` parameter.
|
# siteSearch` parameter. Acceptable values are: * `"e"`: exclude * `"i"`:
|
||||||
# Acceptable values are:
|
# include
|
||||||
# * `"e"`: exclude
|
|
||||||
# * `"i"`: include
|
|
||||||
# @param [String] sort
|
# @param [String] sort
|
||||||
# The sort expression to apply to the results. The sort parameter specifies
|
# The sort expression to apply to the results. The sort parameter specifies that
|
||||||
# that the results be sorted according to the specified expression i.e. sort
|
# the results be sorted according to the specified expression i.e. sort by date.
|
||||||
# by date.
|
# [Example: sort=date](https://developers.google.com/custom-search/docs/
|
||||||
# [Example:
|
# structured_search#sort-by-attribute).
|
||||||
# sort=date](https://developers.google.com/custom-search/docs/structured_search#
|
|
||||||
# sort-by-attribute).
|
|
||||||
# @param [Fixnum] start
|
# @param [Fixnum] start
|
||||||
# The index of the first result to return. The default number of results per
|
# The index of the first result to return. The default number of results per
|
||||||
# page is 10, so `&start=11` would start at the top of the second page of
|
# page is 10, so `&start=11` would start at the top of the second page of
|
||||||
# results. **Note**: The JSON API will never return more than 100 results,
|
# results. **Note**: The JSON API will never return more than 100 results, even
|
||||||
# even if more than 100 documents match the query, so setting the sum of
|
# if more than 100 documents match the query, so setting the sum of `start + num`
|
||||||
# `start + num` to a number greater than 100 will produce an error. Also note
|
# to a number greater than 100 will produce an error. Also note that the
|
||||||
# that the maximum value for `num` is 10.
|
# maximum value for `num` is 10.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,43 @@
|
||||||
|
# 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/datafusion_v1/service.rb'
|
||||||
|
require 'google/apis/datafusion_v1/classes.rb'
|
||||||
|
require 'google/apis/datafusion_v1/representations.rb'
|
||||||
|
|
||||||
|
module Google
|
||||||
|
module Apis
|
||||||
|
# Cloud Data Fusion API
|
||||||
|
#
|
||||||
|
# Cloud Data Fusion is a fully-managed, cloud native, enterprise data
|
||||||
|
# integration service for
|
||||||
|
# quickly building and managing data pipelines. It provides a graphical
|
||||||
|
# interface to increase
|
||||||
|
# time efficiency and reduce complexity, and allows business users,
|
||||||
|
# developers, and data
|
||||||
|
# scientists to easily and reliably build scalable data integration
|
||||||
|
# solutions to cleanse,
|
||||||
|
# prepare, blend, transfer and transform data without having to wrestle with
|
||||||
|
# infrastructure.
|
||||||
|
#
|
||||||
|
# @see https://cloud.google.com/data-fusion/docs
|
||||||
|
module DatafusionV1
|
||||||
|
VERSION = 'V1'
|
||||||
|
REVISION = '20200609'
|
||||||
|
|
||||||
|
# View and manage your data across Google Cloud Platform services
|
||||||
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,390 @@
|
||||||
|
# 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 DatafusionV1
|
||||||
|
|
||||||
|
class Accelerator
|
||||||
|
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 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 Expr
|
||||||
|
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 ListAvailableVersionsResponse
|
||||||
|
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 NetworkConfig
|
||||||
|
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 Policy
|
||||||
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||||
|
|
||||||
|
include Google::Apis::Core::JsonObjectSupport
|
||||||
|
end
|
||||||
|
|
||||||
|
class RestartInstanceRequest
|
||||||
|
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 Status
|
||||||
|
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 Version
|
||||||
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
||||||
|
|
||||||
|
include Google::Apis::Core::JsonObjectSupport
|
||||||
|
end
|
||||||
|
|
||||||
|
class Accelerator
|
||||||
|
# @private
|
||||||
|
class Representation < Google::Apis::Core::JsonRepresentation
|
||||||
|
property :accelerator_type, as: 'acceleratorType'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
class AuditConfig
|
||||||
|
# @private
|
||||||
|
class Representation < Google::Apis::Core::JsonRepresentation
|
||||||
|
collection :audit_log_configs, as: 'auditLogConfigs', class: Google::Apis::DatafusionV1::AuditLogConfig, decorator: Google::Apis::DatafusionV1::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::DatafusionV1::Expr, decorator: Google::Apis::DatafusionV1::Expr::Representation
|
||||||
|
|
||||||
|
collection :members, as: 'members'
|
||||||
|
property :role, as: 'role'
|
||||||
|
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 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 Instance
|
||||||
|
# @private
|
||||||
|
class Representation < Google::Apis::Core::JsonRepresentation
|
||||||
|
collection :accelerators, as: 'accelerators', class: Google::Apis::DatafusionV1::Accelerator, decorator: Google::Apis::DatafusionV1::Accelerator::Representation
|
||||||
|
|
||||||
|
property :api_endpoint, as: 'apiEndpoint'
|
||||||
|
collection :available_version, as: 'availableVersion', class: Google::Apis::DatafusionV1::Version, decorator: Google::Apis::DatafusionV1::Version::Representation
|
||||||
|
|
||||||
|
property :create_time, as: 'createTime'
|
||||||
|
property :description, as: 'description'
|
||||||
|
property :display_name, as: 'displayName'
|
||||||
|
property :enable_stackdriver_logging, as: 'enableStackdriverLogging'
|
||||||
|
property :enable_stackdriver_monitoring, as: 'enableStackdriverMonitoring'
|
||||||
|
property :gcs_bucket, as: 'gcsBucket'
|
||||||
|
hash :labels, as: 'labels'
|
||||||
|
property :name, as: 'name'
|
||||||
|
property :network_config, as: 'networkConfig', class: Google::Apis::DatafusionV1::NetworkConfig, decorator: Google::Apis::DatafusionV1::NetworkConfig::Representation
|
||||||
|
|
||||||
|
hash :options, as: 'options'
|
||||||
|
property :private_instance, as: 'privateInstance'
|
||||||
|
property :service_account, as: 'serviceAccount'
|
||||||
|
property :service_endpoint, as: 'serviceEndpoint'
|
||||||
|
property :state, as: 'state'
|
||||||
|
property :state_message, as: 'stateMessage'
|
||||||
|
property :type, as: 'type'
|
||||||
|
property :update_time, as: 'updateTime'
|
||||||
|
property :version, as: 'version'
|
||||||
|
property :zone, as: 'zone'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
class ListAvailableVersionsResponse
|
||||||
|
# @private
|
||||||
|
class Representation < Google::Apis::Core::JsonRepresentation
|
||||||
|
collection :available_versions, as: 'availableVersions', class: Google::Apis::DatafusionV1::Version, decorator: Google::Apis::DatafusionV1::Version::Representation
|
||||||
|
|
||||||
|
property :next_page_token, as: 'nextPageToken'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
class ListInstancesResponse
|
||||||
|
# @private
|
||||||
|
class Representation < Google::Apis::Core::JsonRepresentation
|
||||||
|
collection :instances, as: 'instances', class: Google::Apis::DatafusionV1::Instance, decorator: Google::Apis::DatafusionV1::Instance::Representation
|
||||||
|
|
||||||
|
property :next_page_token, as: 'nextPageToken'
|
||||||
|
collection :unreachable, as: 'unreachable'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
class ListLocationsResponse
|
||||||
|
# @private
|
||||||
|
class Representation < Google::Apis::Core::JsonRepresentation
|
||||||
|
collection :locations, as: 'locations', class: Google::Apis::DatafusionV1::Location, decorator: Google::Apis::DatafusionV1::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::DatafusionV1::Operation, decorator: Google::Apis::DatafusionV1::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 NetworkConfig
|
||||||
|
# @private
|
||||||
|
class Representation < Google::Apis::Core::JsonRepresentation
|
||||||
|
property :ip_allocation, as: 'ipAllocation'
|
||||||
|
property :network, as: 'network'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
class Operation
|
||||||
|
# @private
|
||||||
|
class Representation < Google::Apis::Core::JsonRepresentation
|
||||||
|
property :done, as: 'done'
|
||||||
|
property :error, as: 'error', class: Google::Apis::DatafusionV1::Status, decorator: Google::Apis::DatafusionV1::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 :create_time, as: 'createTime'
|
||||||
|
property :end_time, as: 'endTime'
|
||||||
|
property :requested_cancellation, as: 'requestedCancellation'
|
||||||
|
property :status_detail, as: 'statusDetail'
|
||||||
|
property :target, as: 'target'
|
||||||
|
property :verb, as: 'verb'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
class Policy
|
||||||
|
# @private
|
||||||
|
class Representation < Google::Apis::Core::JsonRepresentation
|
||||||
|
collection :audit_configs, as: 'auditConfigs', class: Google::Apis::DatafusionV1::AuditConfig, decorator: Google::Apis::DatafusionV1::AuditConfig::Representation
|
||||||
|
|
||||||
|
collection :bindings, as: 'bindings', class: Google::Apis::DatafusionV1::Binding, decorator: Google::Apis::DatafusionV1::Binding::Representation
|
||||||
|
|
||||||
|
property :etag, :base64 => true, as: 'etag'
|
||||||
|
property :version, as: 'version'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
class RestartInstanceRequest
|
||||||
|
# @private
|
||||||
|
class Representation < Google::Apis::Core::JsonRepresentation
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
class SetIamPolicyRequest
|
||||||
|
# @private
|
||||||
|
class Representation < Google::Apis::Core::JsonRepresentation
|
||||||
|
property :policy, as: 'policy', class: Google::Apis::DatafusionV1::Policy, decorator: Google::Apis::DatafusionV1::Policy::Representation
|
||||||
|
|
||||||
|
property :update_mask, as: 'updateMask'
|
||||||
|
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 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
|
||||||
|
|
||||||
|
class Version
|
||||||
|
# @private
|
||||||
|
class Representation < Google::Apis::Core::JsonRepresentation
|
||||||
|
property :default_version, as: 'defaultVersion'
|
||||||
|
property :version_number, as: 'versionNumber'
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
@ -0,0 +1,680 @@
|
||||||
|
# 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 DatafusionV1
|
||||||
|
# Cloud Data Fusion API
|
||||||
|
#
|
||||||
|
# Cloud Data Fusion is a fully-managed, cloud native, enterprise data
|
||||||
|
# integration service for
|
||||||
|
# quickly building and managing data pipelines. It provides a graphical
|
||||||
|
# interface to increase
|
||||||
|
# time efficiency and reduce complexity, and allows business users,
|
||||||
|
# developers, and data
|
||||||
|
# scientists to easily and reliably build scalable data integration
|
||||||
|
# solutions to cleanse,
|
||||||
|
# prepare, blend, transfer and transform data without having to wrestle with
|
||||||
|
# infrastructure.
|
||||||
|
#
|
||||||
|
# @example
|
||||||
|
# require 'google/apis/datafusion_v1'
|
||||||
|
#
|
||||||
|
# Datafusion = Google::Apis::DatafusionV1 # Alias the module
|
||||||
|
# service = Datafusion::DataFusionService.new
|
||||||
|
#
|
||||||
|
# @see https://cloud.google.com/data-fusion/docs
|
||||||
|
class DataFusionService < 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://datafusion.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::DatafusionV1::Location] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::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::DatafusionV1::Location::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::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 [Boolean] include_unrevealed_locations
|
||||||
|
# If true, the returned list will include locations which are not yet
|
||||||
|
# revealed.
|
||||||
|
# @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::DatafusionV1::ListLocationsResponse] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::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, include_unrevealed_locations: 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::DatafusionV1::ListLocationsResponse::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::ListLocationsResponse
|
||||||
|
command.params['name'] = name unless name.nil?
|
||||||
|
command.query['filter'] = filter unless filter.nil?
|
||||||
|
command.query['includeUnrevealedLocations'] = include_unrevealed_locations unless include_unrevealed_locations.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 new Data Fusion instance in the specified project and location.
|
||||||
|
# @param [String] parent
|
||||||
|
# The instance's project and location in the format
|
||||||
|
# projects/`project`/locations/`location`.
|
||||||
|
# @param [Google::Apis::DatafusionV1::Instance] instance_object
|
||||||
|
# @param [String] instance_id
|
||||||
|
# The name of the instance to create.
|
||||||
|
# @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::DatafusionV1::Operation] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::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::DatafusionV1::Instance::Representation
|
||||||
|
command.request_object = instance_object
|
||||||
|
command.response_representation = Google::Apis::DatafusionV1::Operation::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::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 Date Fusion instance.
|
||||||
|
# @param [String] name
|
||||||
|
# The instance resource name in the format
|
||||||
|
# projects/`project`/locations/`location`/instances/`instance`
|
||||||
|
# @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::DatafusionV1::Operation] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::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::DatafusionV1::Operation::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::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 Data Fusion instance.
|
||||||
|
# @param [String] name
|
||||||
|
# The instance resource name in the format
|
||||||
|
# projects/`project`/locations/`location`/instances/`instance`.
|
||||||
|
# @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::DatafusionV1::Instance] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::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::DatafusionV1::Instance::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::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
|
||||||
|
|
||||||
|
# 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.
|
||||||
|
# @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).
|
||||||
|
# @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::DatafusionV1::Policy] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::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_project_location_instance_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||||
|
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
|
||||||
|
command.response_representation = Google::Apis::DatafusionV1::Policy::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::Policy
|
||||||
|
command.params['resource'] = resource unless resource.nil?
|
||||||
|
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.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 Data Fusion instances in the specified project and location.
|
||||||
|
# @param [String] parent
|
||||||
|
# The project and location for which to retrieve instance information
|
||||||
|
# in the format projects/`project`/locations/`location`. If the location is
|
||||||
|
# specified as '-' (wildcard), then all regions available to the project
|
||||||
|
# are queried, and the results are aggregated.
|
||||||
|
# @param [String] filter
|
||||||
|
# List filter.
|
||||||
|
# @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.
|
||||||
|
# @param [String] page_token
|
||||||
|
# The next_page_token value to use if there are additional
|
||||||
|
# results to retrieve for this list request.
|
||||||
|
# @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::DatafusionV1::ListInstancesResponse] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::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::DatafusionV1::ListInstancesResponse::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::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 a single Data Fusion instance.
|
||||||
|
# @param [String] name
|
||||||
|
# Output only. The name of this instance is in the form of
|
||||||
|
# projects/`project`/locations/`location`/instances/`instance`.
|
||||||
|
# @param [Google::Apis::DatafusionV1::Instance] instance_object
|
||||||
|
# @param [String] update_mask
|
||||||
|
# Field mask is used to specify the fields that the update will overwrite
|
||||||
|
# in an instance resource. The fields specified in the update_mask are
|
||||||
|
# relative to the resource, not the full request.
|
||||||
|
# A field will be overwritten if it is in the mask.
|
||||||
|
# If the user does not provide a mask, all the supported fields (labels,
|
||||||
|
# options, and version currently) will be overwritten.
|
||||||
|
# @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::DatafusionV1::Operation] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::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::DatafusionV1::Instance::Representation
|
||||||
|
command.request_object = instance_object
|
||||||
|
command.response_representation = Google::Apis::DatafusionV1::Operation::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::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
|
||||||
|
|
||||||
|
# Restart a single Data Fusion instance.
|
||||||
|
# At the end of an operation instance is fully restarted.
|
||||||
|
# @param [String] name
|
||||||
|
# Name of the Data Fusion instance which need to be restarted in the form of
|
||||||
|
# projects/`project`/locations/`location`/instances/`instance`
|
||||||
|
# @param [Google::Apis::DatafusionV1::RestartInstanceRequest] restart_instance_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::DatafusionV1::Operation] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::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 restart_instance(name, restart_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||||
|
command = make_simple_command(:post, 'v1/{+name}:restart', options)
|
||||||
|
command.request_representation = Google::Apis::DatafusionV1::RestartInstanceRequest::Representation
|
||||||
|
command.request_object = restart_instance_request_object
|
||||||
|
command.response_representation = Google::Apis::DatafusionV1::Operation::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::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
|
||||||
|
|
||||||
|
# Sets the access control policy on the specified resource. Replaces any
|
||||||
|
# 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.
|
||||||
|
# @param [Google::Apis::DatafusionV1::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::DatafusionV1::Policy] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::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_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||||
|
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
|
||||||
|
command.request_representation = Google::Apis::DatafusionV1::SetIamPolicyRequest::Representation
|
||||||
|
command.request_object = set_iam_policy_request_object
|
||||||
|
command.response_representation = Google::Apis::DatafusionV1::Policy::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::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 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.
|
||||||
|
# @param [Google::Apis::DatafusionV1::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::DatafusionV1::TestIamPermissionsResponse] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::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_instance_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||||
|
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
|
||||||
|
command.request_representation = Google::Apis::DatafusionV1::TestIamPermissionsRequest::Representation
|
||||||
|
command.request_object = test_iam_permissions_request_object
|
||||||
|
command.response_representation = Google::Apis::DatafusionV1::TestIamPermissionsResponse::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::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
|
||||||
|
|
||||||
|
# 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::DatafusionV1::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::DatafusionV1::Empty] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::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::DatafusionV1::CancelOperationRequest::Representation
|
||||||
|
command.request_object = cancel_operation_request_object
|
||||||
|
command.response_representation = Google::Apis::DatafusionV1::Empty::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::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::DatafusionV1::Empty] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::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::DatafusionV1::Empty::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::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::DatafusionV1::Operation] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::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::DatafusionV1::Operation::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::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::DatafusionV1::ListOperationsResponse] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::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::DatafusionV1::ListOperationsResponse::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::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
|
||||||
|
|
||||||
|
# Lists possible versions for Data Fusion instances in the specified project
|
||||||
|
# and location.
|
||||||
|
# @param [String] parent
|
||||||
|
# Required. The project and location for which to retrieve instance information
|
||||||
|
# in the format projects/`project`/locations/`location`.
|
||||||
|
# @param [Boolean] latest_patch_only
|
||||||
|
# Whether or not to return the latest patch of every available minor version.
|
||||||
|
# If true, only the latest patch will be returned. Ex. if allowed versions is
|
||||||
|
# [6.1.1, 6.1.2, 6.2.0] then response will be [6.1.2, 6.2.0]
|
||||||
|
# @param [Fixnum] page_size
|
||||||
|
# The maximum number of items to return.
|
||||||
|
# @param [String] page_token
|
||||||
|
# The next_page_token value to use if there are additional
|
||||||
|
# results to retrieve for this list request.
|
||||||
|
# @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::DatafusionV1::ListAvailableVersionsResponse] parsed result object
|
||||||
|
# @yieldparam err [StandardError] error object if request failed
|
||||||
|
#
|
||||||
|
# @return [Google::Apis::DatafusionV1::ListAvailableVersionsResponse]
|
||||||
|
#
|
||||||
|
# @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_versions(parent, latest_patch_only: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||||||
|
command = make_simple_command(:get, 'v1/{+parent}/versions', options)
|
||||||
|
command.response_representation = Google::Apis::DatafusionV1::ListAvailableVersionsResponse::Representation
|
||||||
|
command.response_class = Google::Apis::DatafusionV1::ListAvailableVersionsResponse
|
||||||
|
command.params['parent'] = parent unless parent.nil?
|
||||||
|
command.query['latestPatchOnly'] = latest_patch_only unless latest_patch_only.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
|
||||||
|
|
@ -25,7 +25,7 @@ module Google
|
||||||
# @see https://developers.google.com/domains/rdap/
|
# @see https://developers.google.com/domains/rdap/
|
||||||
module DomainsrdapV1
|
module DomainsrdapV1
|
||||||
VERSION = 'V1'
|
VERSION = 'V1'
|
||||||
REVISION = '20200218'
|
REVISION = '20200803'
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
||||||
|
|
@ -23,34 +23,21 @@ module Google
|
||||||
module DomainsrdapV1
|
module DomainsrdapV1
|
||||||
|
|
||||||
# Message that represents an arbitrary HTTP body. It should only be used for
|
# 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
|
# payload formats that can't be represented as JSON, such as raw binary or an
|
||||||
# an HTML page.
|
# HTML page. This message can be used both in streaming and non-streaming API
|
||||||
# This message can be used both in streaming and non-streaming API methods in
|
# methods in the request as well as the response. It can be used as a top-level
|
||||||
# the request as well as the response.
|
# request field, which is convenient if one wants to extract parameters from
|
||||||
# It can be used as a top-level request field, which is convenient if one
|
# either the URL or HTTP template into the request fields and also want access
|
||||||
# wants to extract parameters from either the URL or HTTP template into the
|
# to the raw HTTP body. Example: message GetResourceRequest ` // A unique
|
||||||
# request fields and also want access to the raw HTTP body.
|
# request id. string request_id = 1; // The raw HTTP body is bound to this field.
|
||||||
# Example:
|
# google.api.HttpBody http_body = 2; ` service ResourceService ` rpc
|
||||||
# message GetResourceRequest `
|
# GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc
|
||||||
# // A unique request id.
|
# UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); ` Example
|
||||||
# string request_id = 1;
|
# with streaming methods: service CaldavService ` rpc GetCalendar(stream google.
|
||||||
# // The raw HTTP body is bound to this field.
|
# api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream
|
||||||
# google.api.HttpBody http_body = 2;
|
# google.api.HttpBody) returns (stream google.api.HttpBody); ` Use of this type
|
||||||
# `
|
# only changes how the request and response bodies are handled, all other
|
||||||
# service ResourceService `
|
# features will continue to work unchanged.
|
||||||
# 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
|
class HttpBody
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -65,8 +52,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :data
|
attr_accessor :data
|
||||||
|
|
||||||
# Application specific response metadata. Must be set in the first response
|
# Application specific response metadata. Must be set in the first response for
|
||||||
# for streaming APIs.
|
# streaming APIs.
|
||||||
# Corresponds to the JSON property `extensions`
|
# Corresponds to the JSON property `extensions`
|
||||||
# @return [Array<Hash<String,Object>>]
|
# @return [Array<Hash<String,Object>>]
|
||||||
attr_accessor :extensions
|
attr_accessor :extensions
|
||||||
|
|
@ -83,8 +70,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Links object defined in [section 4.2 of RFC
|
# Links object defined in [section 4.2 of RFC 7483](https://tools.ietf.org/html/
|
||||||
# 7483](https://tools.ietf.org/html/rfc7483#section-4.2).
|
# rfc7483#section-4.2).
|
||||||
class Link
|
class Link
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -139,8 +126,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Notices object defined in [section 4.3 of RFC
|
# Notices object defined in [section 4.3 of RFC 7483](https://tools.ietf.org/
|
||||||
# 7483](https://tools.ietf.org/html/rfc7483#section-4.3).
|
# html/rfc7483#section-4.3).
|
||||||
class Notice
|
class Notice
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -159,11 +146,10 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :title
|
attr_accessor :title
|
||||||
|
|
||||||
# Type values defined in [section 10.2.1 of RFC
|
# Type values defined in [section 10.2.1 of RFC 7483](https://tools.ietf.org/
|
||||||
# 7483](https://tools.ietf.org/html/rfc7483#section-10.2.1) specific to a
|
# html/rfc7483#section-10.2.1) specific to a whole response: "result set
|
||||||
# whole response: "result set truncated due to authorization", "result set
|
# truncated due to authorization", "result set truncated due to excessive load",
|
||||||
# truncated due to excessive load", "result set truncated due to
|
# "result set truncated due to unexplainable reasons".
|
||||||
# unexplainable reasons".
|
|
||||||
# Corresponds to the JSON property `type`
|
# Corresponds to the JSON property `type`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :type
|
attr_accessor :type
|
||||||
|
|
@ -196,40 +182,27 @@ module Google
|
||||||
attr_accessor :error_code
|
attr_accessor :error_code
|
||||||
|
|
||||||
# Message that represents an arbitrary HTTP body. It should only be used for
|
# 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
|
# payload formats that can't be represented as JSON, such as raw binary or an
|
||||||
# an HTML page.
|
# HTML page. This message can be used both in streaming and non-streaming API
|
||||||
# This message can be used both in streaming and non-streaming API methods in
|
# methods in the request as well as the response. It can be used as a top-level
|
||||||
# the request as well as the response.
|
# request field, which is convenient if one wants to extract parameters from
|
||||||
# It can be used as a top-level request field, which is convenient if one
|
# either the URL or HTTP template into the request fields and also want access
|
||||||
# wants to extract parameters from either the URL or HTTP template into the
|
# to the raw HTTP body. Example: message GetResourceRequest ` // A unique
|
||||||
# request fields and also want access to the raw HTTP body.
|
# request id. string request_id = 1; // The raw HTTP body is bound to this field.
|
||||||
# Example:
|
# google.api.HttpBody http_body = 2; ` service ResourceService ` rpc
|
||||||
# message GetResourceRequest `
|
# GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc
|
||||||
# // A unique request id.
|
# UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); ` Example
|
||||||
# string request_id = 1;
|
# with streaming methods: service CaldavService ` rpc GetCalendar(stream google.
|
||||||
# // The raw HTTP body is bound to this field.
|
# api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream
|
||||||
# google.api.HttpBody http_body = 2;
|
# google.api.HttpBody) returns (stream google.api.HttpBody); ` Use of this type
|
||||||
# `
|
# only changes how the request and response bodies are handled, all other
|
||||||
# service ResourceService `
|
# features will continue to work unchanged.
|
||||||
# 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.
|
|
||||||
# Corresponds to the JSON property `jsonResponse`
|
# Corresponds to the JSON property `jsonResponse`
|
||||||
# @return [Google::Apis::DomainsrdapV1::HttpBody]
|
# @return [Google::Apis::DomainsrdapV1::HttpBody]
|
||||||
attr_accessor :json_response
|
attr_accessor :json_response
|
||||||
|
|
||||||
# Error language code. Error response info fields are defined in [section 6
|
# Error language code. Error response info fields are defined in [section 6 of
|
||||||
# of RFC 7483](https://tools.ietf.org/html/rfc7483#section-6).
|
# RFC 7483](https://tools.ietf.org/html/rfc7483#section-6).
|
||||||
# Corresponds to the JSON property `lang`
|
# Corresponds to the JSON property `lang`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :lang
|
attr_accessor :lang
|
||||||
|
|
|
||||||
|
|
@ -47,8 +47,8 @@ module Google
|
||||||
@batch_path = 'batch'
|
@batch_path = 'batch'
|
||||||
end
|
end
|
||||||
|
|
||||||
# The RDAP API recognizes this command from the RDAP specification but
|
# The RDAP API recognizes this command from the RDAP specification but does not
|
||||||
# does not support it. The response is a formatted 501 error.
|
# support it. The response is a formatted 501 error.
|
||||||
# @param [String] autnum_id
|
# @param [String] autnum_id
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -107,8 +107,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# The RDAP API recognizes this command from the RDAP specification but
|
# The RDAP API recognizes this command from the RDAP specification but does not
|
||||||
# does not support it. The response is a formatted 501 error.
|
# support it. The response is a formatted 501 error.
|
||||||
# @param [String] entity_id
|
# @param [String] entity_id
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -137,8 +137,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# The RDAP API recognizes this command from the RDAP specification but
|
# The RDAP API recognizes this command from the RDAP specification but does not
|
||||||
# does not support it. The response is a formatted 501 error.
|
# support it. The response is a formatted 501 error.
|
||||||
# @param [String] ip_id
|
# @param [String] ip_id
|
||||||
# @param [String] ip_id1
|
# @param [String] ip_id1
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -169,8 +169,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# The RDAP API recognizes this command from the RDAP specification but
|
# The RDAP API recognizes this command from the RDAP specification but does not
|
||||||
# does not support it. The response is a formatted 501 error.
|
# support it. The response is a formatted 501 error.
|
||||||
# @param [String] nameserver_id
|
# @param [String] nameserver_id
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -199,8 +199,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# The RDAP API recognizes this command from the RDAP specification but
|
# The RDAP API recognizes this command from the RDAP specification but does not
|
||||||
# does not support it. The response is a formatted 501 error.
|
# support it. The response is a formatted 501 error.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -227,8 +227,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# The RDAP API recognizes this command from the RDAP specification but
|
# The RDAP API recognizes this command from the RDAP specification but does not
|
||||||
# does not support it. The response is a formatted 501 error.
|
# support it. The response is a formatted 501 error.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -282,8 +282,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# The RDAP API recognizes this command from the RDAP specification but
|
# The RDAP API recognizes this command from the RDAP specification but does not
|
||||||
# does not support it. The response is a formatted 501 error.
|
# support it. The response is a formatted 501 error.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -310,8 +310,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# The RDAP API recognizes this command from the RDAP specification but
|
# The RDAP API recognizes this command from the RDAP specification but does not
|
||||||
# does not support it. The response is a formatted 501 error.
|
# support it. The response is a formatted 501 error.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ module Google
|
||||||
# @see https://developers.google.com/fact-check/tools/api/
|
# @see https://developers.google.com/fact-check/tools/api/
|
||||||
module FactchecktoolsV1alpha1
|
module FactchecktoolsV1alpha1
|
||||||
VERSION = 'V1alpha1'
|
VERSION = 'V1alpha1'
|
||||||
REVISION = '20200215'
|
REVISION = '20200801'
|
||||||
|
|
||||||
# View your email address
|
# View your email address
|
||||||
AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email'
|
AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email'
|
||||||
|
|
|
||||||
|
|
@ -73,7 +73,7 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :job_title
|
attr_accessor :job_title
|
||||||
|
|
||||||
# A person or organization stating the claim. For instance, "John Doe".<br>
|
# A person or organization stating the claim. For instance, "John Doe".
|
||||||
# Corresponds to `ClaimReview.itemReviewed.author.name`.
|
# Corresponds to `ClaimReview.itemReviewed.author.name`.
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
|
|
@ -101,8 +101,7 @@ module Google
|
||||||
class GoogleFactcheckingFactchecktoolsV1alpha1ClaimRating
|
class GoogleFactcheckingFactchecktoolsV1alpha1ClaimRating
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# For numeric ratings, the best value possible in the scale from worst to
|
# For numeric ratings, the best value possible in the scale from worst to best.
|
||||||
# best.<br>
|
|
||||||
# Corresponds to `ClaimReview.reviewRating.bestRating`.
|
# Corresponds to `ClaimReview.reviewRating.bestRating`.
|
||||||
# Corresponds to the JSON property `bestRating`
|
# Corresponds to the JSON property `bestRating`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
|
|
@ -119,20 +118,18 @@ module Google
|
||||||
attr_accessor :rating_explanation
|
attr_accessor :rating_explanation
|
||||||
|
|
||||||
# A numeric rating of this claim, in the range worstRating — bestRating
|
# A numeric rating of this claim, in the range worstRating — bestRating
|
||||||
# inclusive.<br>
|
# inclusive. Corresponds to `ClaimReview.reviewRating.ratingValue`.
|
||||||
# Corresponds to `ClaimReview.reviewRating.ratingValue`.
|
|
||||||
# Corresponds to the JSON property `ratingValue`
|
# Corresponds to the JSON property `ratingValue`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :rating_value
|
attr_accessor :rating_value
|
||||||
|
|
||||||
# The truthfulness rating as a human-readible short word or phrase.<br>
|
# The truthfulness rating as a human-readible short word or phrase. Corresponds
|
||||||
# Corresponds to `ClaimReview.reviewRating.alternateName`.
|
# to `ClaimReview.reviewRating.alternateName`.
|
||||||
# Corresponds to the JSON property `textualRating`
|
# Corresponds to the JSON property `textualRating`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :textual_rating
|
attr_accessor :textual_rating
|
||||||
|
|
||||||
# For numeric ratings, the worst value possible in the scale from worst to
|
# For numeric ratings, the worst value possible in the scale from worst to best.
|
||||||
# best.<br>
|
|
||||||
# Corresponds to `ClaimReview.reviewRating.worstRating`.
|
# Corresponds to `ClaimReview.reviewRating.worstRating`.
|
||||||
# Corresponds to the JSON property `worstRating`
|
# Corresponds to the JSON property `worstRating`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
|
|
@ -211,8 +208,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :image_url
|
attr_accessor :image_url
|
||||||
|
|
||||||
# Name of the organization that is publishing the fact check.<br>
|
# Name of the organization that is publishing the fact check. Corresponds to `
|
||||||
# Corresponds to `ClaimReview.author.name`.
|
# ClaimReview.author.name`.
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
@ -228,16 +225,15 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Fields for an individual `ClaimReview` element.
|
# Fields for an individual `ClaimReview` element. Except for sub-messages that
|
||||||
# Except for sub-messages that group fields together, each of these fields
|
# group fields together, each of these fields correspond those in https://schema.
|
||||||
# correspond those in https://schema.org/ClaimReview. We list the precise
|
# org/ClaimReview. We list the precise mapping for each field.
|
||||||
# mapping for each field.
|
|
||||||
class GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkup
|
class GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkup
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# A list of links to works in which this claim appears, aside from the one
|
# A list of links to works in which this claim appears, aside from the one
|
||||||
# specified in `claim_first_appearance`.<br>
|
# specified in `claim_first_appearance`. Corresponds to `ClaimReview.
|
||||||
# Corresponds to `ClaimReview.itemReviewed[@type=Claim].appearance.url`.
|
# itemReviewed[@type=Claim].appearance.url`.
|
||||||
# Corresponds to the JSON property `claimAppearances`
|
# Corresponds to the JSON property `claimAppearances`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :claim_appearances
|
attr_accessor :claim_appearances
|
||||||
|
|
@ -247,26 +243,26 @@ module Google
|
||||||
# @return [Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimAuthor]
|
# @return [Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimAuthor]
|
||||||
attr_accessor :claim_author
|
attr_accessor :claim_author
|
||||||
|
|
||||||
# The date when the claim was made or entered public discourse.<br>
|
# The date when the claim was made or entered public discourse. Corresponds to `
|
||||||
# Corresponds to `ClaimReview.itemReviewed.datePublished`.
|
# ClaimReview.itemReviewed.datePublished`.
|
||||||
# Corresponds to the JSON property `claimDate`
|
# Corresponds to the JSON property `claimDate`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :claim_date
|
attr_accessor :claim_date
|
||||||
|
|
||||||
# A link to a work in which this claim first appears.<br>
|
# A link to a work in which this claim first appears. Corresponds to `
|
||||||
# Corresponds to `ClaimReview.itemReviewed[@type=Claim].firstAppearance.url`.
|
# ClaimReview.itemReviewed[@type=Claim].firstAppearance.url`.
|
||||||
# Corresponds to the JSON property `claimFirstAppearance`
|
# Corresponds to the JSON property `claimFirstAppearance`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :claim_first_appearance
|
attr_accessor :claim_first_appearance
|
||||||
|
|
||||||
# The location where this claim was made.<br>
|
# The location where this claim was made. Corresponds to `ClaimReview.
|
||||||
# Corresponds to `ClaimReview.itemReviewed.name`.
|
# itemReviewed.name`.
|
||||||
# Corresponds to the JSON property `claimLocation`
|
# Corresponds to the JSON property `claimLocation`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :claim_location
|
attr_accessor :claim_location
|
||||||
|
|
||||||
# A short summary of the claim being evaluated.<br>
|
# A short summary of the claim being evaluated. Corresponds to `ClaimReview.
|
||||||
# Corresponds to `ClaimReview.claimReviewed`.
|
# claimReviewed`.
|
||||||
# Corresponds to the JSON property `claimReviewed`
|
# Corresponds to the JSON property `claimReviewed`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :claim_reviewed
|
attr_accessor :claim_reviewed
|
||||||
|
|
@ -278,7 +274,7 @@ module Google
|
||||||
|
|
||||||
# This field is optional, and will default to the page URL. We provide this
|
# This field is optional, and will default to the page URL. We provide this
|
||||||
# field to allow you the override the default value, but the only permitted
|
# field to allow you the override the default value, but the only permitted
|
||||||
# override is the page URL plus an optional anchor link ("page jump").<br>
|
# override is the page URL plus an optional anchor link ("page jump").
|
||||||
# Corresponds to `ClaimReview.url`
|
# Corresponds to `ClaimReview.url`
|
||||||
# Corresponds to the JSON property `url`
|
# Corresponds to the JSON property `url`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
|
|
@ -310,32 +306,30 @@ module Google
|
||||||
# @return [Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewAuthor]
|
# @return [Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewAuthor]
|
||||||
attr_accessor :claim_review_author
|
attr_accessor :claim_review_author
|
||||||
|
|
||||||
# A list of individual claim reviews for this page.
|
# A list of individual claim reviews for this page. Each item in the list
|
||||||
# Each item in the list corresponds to one `ClaimReview` element.
|
# corresponds to one `ClaimReview` element.
|
||||||
# Corresponds to the JSON property `claimReviewMarkups`
|
# Corresponds to the JSON property `claimReviewMarkups`
|
||||||
# @return [Array<Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkup>]
|
# @return [Array<Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkup>]
|
||||||
attr_accessor :claim_review_markups
|
attr_accessor :claim_review_markups
|
||||||
|
|
||||||
# The name of this `ClaimReview` markup page resource, in the form of
|
# The name of this `ClaimReview` markup page resource, in the form of `pages/`
|
||||||
# `pages/`page_id``. Except for update requests, this field is output-only
|
# page_id``. Except for update requests, this field is output-only and should
|
||||||
# and should not be set by the user.
|
# not be set by the user.
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# The URL of the page associated with this `ClaimReview` markup.
|
# The URL of the page associated with this `ClaimReview` markup. While every
|
||||||
# While every individual `ClaimReview` has its own URL field, semantically
|
# individual `ClaimReview` has its own URL field, semantically this is a page-
|
||||||
# this is a page-level field, and each `ClaimReview` on this page will use
|
# level field, and each `ClaimReview` on this page will use this value unless
|
||||||
# this value unless individually overridden.<br>
|
# individually overridden. Corresponds to `ClaimReview.url`
|
||||||
# Corresponds to `ClaimReview.url`
|
|
||||||
# Corresponds to the JSON property `pageUrl`
|
# Corresponds to the JSON property `pageUrl`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :page_url
|
attr_accessor :page_url
|
||||||
|
|
||||||
# The date when the fact check was published.
|
# The date when the fact check was published. Similar to the URL, semantically
|
||||||
# Similar to the URL, semantically this is a page-level field, and each
|
# this is a page-level field, and each `ClaimReview` on this page will contain
|
||||||
# `ClaimReview` on this page will contain the same value.<br>
|
# the same value. Corresponds to `ClaimReview.datePublished`
|
||||||
# Corresponds to `ClaimReview.datePublished`
|
|
||||||
# Corresponds to the JSON property `publishDate`
|
# Corresponds to the JSON property `publishDate`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :publish_date
|
attr_accessor :publish_date
|
||||||
|
|
@ -370,9 +364,8 @@ module Google
|
||||||
# @return [Array<Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1Claim>]
|
# @return [Array<Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1Claim>]
|
||||||
attr_accessor :claims
|
attr_accessor :claims
|
||||||
|
|
||||||
# The next pagination token in the Search response. It should be used as the
|
# The next pagination token in the Search response. It should be used as the `
|
||||||
# `page_token` for the following request. An empty value means no more
|
# page_token` for the following request. An empty value means no more results.
|
||||||
# results.
|
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -397,9 +390,8 @@ module Google
|
||||||
# @return [Array<Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage>]
|
# @return [Array<Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage>]
|
||||||
attr_accessor :claim_review_markup_pages
|
attr_accessor :claim_review_markup_pages
|
||||||
|
|
||||||
# The next pagination token in the Search response. It should be used as the
|
# The next pagination token in the Search response. It should be used as the `
|
||||||
# `page_token` for the following request. An empty value means no more
|
# page_token` for the following request. An empty value means no more results.
|
||||||
# results.
|
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -424,9 +416,9 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# Host-level site name, without the protocol or "www" prefix. For instance,
|
# Host-level site name, without the protocol or "www" prefix. For instance, "
|
||||||
# "awesomefactchecks.com". This value of this field is based purely on the
|
# awesomefactchecks.com". This value of this field is based purely on the claim
|
||||||
# claim review URL.
|
# review URL.
|
||||||
# Corresponds to the JSON property `site`
|
# Corresponds to the JSON property `site`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :site
|
attr_accessor :site
|
||||||
|
|
@ -442,13 +434,11 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A generic empty message that you can re-use to avoid defining duplicated
|
# A generic empty message that you can re-use to avoid defining duplicated empty
|
||||||
# empty messages in your APIs. A typical example is to use it as the request
|
# messages in your APIs. A typical example is to use it as the request or the
|
||||||
# or the response type of an API method. For instance:
|
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
||||||
# service Foo `
|
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
||||||
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
# `Empty` is empty JSON object ````.
|
||||||
# `
|
|
||||||
# The JSON representation for `Empty` is empty JSON object ````.
|
|
||||||
class GoogleProtobufEmpty
|
class GoogleProtobufEmpty
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -50,23 +50,22 @@ module Google
|
||||||
# Search through fact-checked claims.
|
# Search through fact-checked claims.
|
||||||
# @param [String] language_code
|
# @param [String] language_code
|
||||||
# The BCP-47 language code, such as "en-US" or "sr-Latn". Can be used to
|
# The BCP-47 language code, such as "en-US" or "sr-Latn". Can be used to
|
||||||
# restrict results by language, though we do not currently consider the
|
# restrict results by language, though we do not currently consider the region.
|
||||||
# region.
|
|
||||||
# @param [Fixnum] max_age_days
|
# @param [Fixnum] max_age_days
|
||||||
# The maximum age of the returned search results, in days.
|
# The maximum age of the returned search results, in days. Age is determined by
|
||||||
# Age is determined by either claim date or review date, whichever is newer.
|
# either claim date or review date, whichever is newer.
|
||||||
# @param [Fixnum] offset
|
# @param [Fixnum] offset
|
||||||
# An integer that specifies the current offset (that is, starting result
|
# An integer that specifies the current offset (that is, starting result
|
||||||
# location) in search results. This field is only considered if `page_token`
|
# location) in search results. This field is only considered if `page_token` is
|
||||||
# is unset. For example, 0 means to return results starting from the first
|
# unset. For example, 0 means to return results starting from the first matching
|
||||||
# matching result, and 10 means to return from the 11th result.
|
# result, and 10 means to return from the 11th result.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The pagination size. We will return up to that many results. Defaults to
|
# The pagination size. We will return up to that many results. Defaults to 10 if
|
||||||
# 10 if not set.
|
# not set.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The pagination token. You may provide the `next_page_token` returned from a
|
# The pagination token. You may provide the `next_page_token` returned from a
|
||||||
# previous List request, if any, in order to get the next page. All other
|
# previous List request, if any, in order to get the next page. All other fields
|
||||||
# fields must have the same values as in the previous request.
|
# must have the same values as in the previous request.
|
||||||
# @param [String] query
|
# @param [String] query
|
||||||
# Textual query string. Required unless `review_publisher_site_filter` is
|
# Textual query string. Required unless `review_publisher_site_filter` is
|
||||||
# specified.
|
# specified.
|
||||||
|
|
@ -195,29 +194,28 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# List the `ClaimReview` markup pages for a specific URL or for an
|
# List the `ClaimReview` markup pages for a specific URL or for an organization.
|
||||||
# organization.
|
|
||||||
# @param [Fixnum] offset
|
# @param [Fixnum] offset
|
||||||
# An integer that specifies the current offset (that is, starting result
|
# An integer that specifies the current offset (that is, starting result
|
||||||
# location) in search results. This field is only considered if `page_token`
|
# location) in search results. This field is only considered if `page_token` is
|
||||||
# is unset, and if the request is not for a specific URL. For example, 0
|
# unset, and if the request is not for a specific URL. For example, 0 means to
|
||||||
# means to return results starting from the first matching result, and 10
|
# return results starting from the first matching result, and 10 means to return
|
||||||
# means to return from the 11th result.
|
# from the 11th result.
|
||||||
# @param [String] organization
|
# @param [String] organization
|
||||||
# The organization for which we want to fetch markups for. For instance,
|
# The organization for which we want to fetch markups for. For instance, "site.
|
||||||
# "site.com". Cannot be specified along with an URL.
|
# com". Cannot be specified along with an URL.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The pagination size. We will return up to that many results. Defaults to
|
# The pagination size. We will return up to that many results. Defaults to 10 if
|
||||||
# 10 if not set. Has no effect if a URL is requested.
|
# not set. Has no effect if a URL is requested.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The pagination token. You may provide the `next_page_token` returned from a
|
# The pagination token. You may provide the `next_page_token` returned from a
|
||||||
# previous List request, if any, in order to get the next page. All other
|
# previous List request, if any, in order to get the next page. All other fields
|
||||||
# fields must have the same values as in the previous request.
|
# must have the same values as in the previous request.
|
||||||
# @param [String] url
|
# @param [String] url
|
||||||
# The URL from which to get `ClaimReview` markup. There will be at most one
|
# The URL from which to get `ClaimReview` markup. There will be at most one
|
||||||
# result. If markup is associated with a more canonical version of the URL
|
# result. If markup is associated with a more canonical version of the URL
|
||||||
# provided, we will return that URL instead. Cannot be specified along with
|
# provided, we will return that URL instead. Cannot be specified along with an
|
||||||
# an organization.
|
# organization.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -249,15 +247,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Update for all `ClaimReview` markup on a page
|
# Update for all `ClaimReview` markup on a page Note that this is a full update.
|
||||||
# Note that this is a full update. To retain the existing `ClaimReview`
|
# To retain the existing `ClaimReview` markup on a page, first perform a Get
|
||||||
# markup on a page, first perform a Get operation, then modify the returned
|
# operation, then modify the returned markup, and finally call Update with the
|
||||||
# markup, and finally call Update with the entire `ClaimReview` markup as the
|
# entire `ClaimReview` markup as the body.
|
||||||
# body.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of this `ClaimReview` markup page resource, in the form of
|
# The name of this `ClaimReview` markup page resource, in the form of `pages/`
|
||||||
# `pages/`page_id``. Except for update requests, this field is output-only
|
# page_id``. Except for update requests, this field is output-only and should
|
||||||
# and should not be set by the user.
|
# not be set by the user.
|
||||||
# @param [Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage] google_factchecking_factchecktools_v1alpha1_claim_review_markup_page_object
|
# @param [Google::Apis::FactchecktoolsV1alpha1::GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage] google_factchecking_factchecktools_v1alpha1_claim_review_markup_page_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,7 @@ module Google
|
||||||
# @see https://firebase.google.com/docs/hosting/
|
# @see https://firebase.google.com/docs/hosting/
|
||||||
module FirebasehostingV1
|
module FirebasehostingV1
|
||||||
VERSION = 'V1'
|
VERSION = 'V1'
|
||||||
REVISION = '20200629'
|
REVISION = '20200731'
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
||||||
|
|
@ -35,13 +35,11 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A generic empty message that you can re-use to avoid defining duplicated
|
# A generic empty message that you can re-use to avoid defining duplicated empty
|
||||||
# empty messages in your APIs. A typical example is to use it as the request
|
# messages in your APIs. A typical example is to use it as the request or the
|
||||||
# or the response type of an API method. For instance:
|
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
||||||
# service Foo `
|
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
||||||
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
# `Empty` is empty JSON object ````.
|
||||||
# `
|
|
||||||
# The JSON representation for `Empty` is empty JSON object ````.
|
|
||||||
class Empty
|
class Empty
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -84,47 +82,45 @@ module Google
|
||||||
class Operation
|
class Operation
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# If the value is `false`, it means the operation is still in progress.
|
# If the value is `false`, it means the operation is still in progress. If `true`
|
||||||
# If `true`, the operation is completed, and either `error` or `response` is
|
# , the operation is completed, and either `error` or `response` is available.
|
||||||
# available.
|
|
||||||
# Corresponds to the JSON property `done`
|
# Corresponds to the JSON property `done`
|
||||||
# @return [Boolean]
|
# @return [Boolean]
|
||||||
attr_accessor :done
|
attr_accessor :done
|
||||||
alias_method :done?, :done
|
alias_method :done?, :done
|
||||||
|
|
||||||
# The `Status` type defines a logical error model that is suitable for
|
# The `Status` type defines a logical error model that is suitable for different
|
||||||
# different programming environments, including REST APIs and RPC APIs. It is
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
||||||
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
||||||
# three pieces of data: error code, error message, and error details.
|
# data: error code, error message, and error details. You can find out more
|
||||||
# You can find out more about this error model and how to work with it in the
|
# about this error model and how to work with it in the [API Design Guide](https:
|
||||||
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
# //cloud.google.com/apis/design/errors).
|
||||||
# Corresponds to the JSON property `error`
|
# Corresponds to the JSON property `error`
|
||||||
# @return [Google::Apis::FirebasehostingV1::Status]
|
# @return [Google::Apis::FirebasehostingV1::Status]
|
||||||
attr_accessor :error
|
attr_accessor :error
|
||||||
|
|
||||||
# Service-specific metadata associated with the operation. It typically
|
# Service-specific metadata associated with the operation. It typically contains
|
||||||
# contains progress information and common metadata such as create time.
|
# progress information and common metadata such as create time. Some services
|
||||||
# Some services might not provide such metadata. Any method that returns a
|
# might not provide such metadata. Any method that returns a long-running
|
||||||
# long-running operation should document the metadata type, if any.
|
# operation should document the metadata type, if any.
|
||||||
# Corresponds to the JSON property `metadata`
|
# Corresponds to the JSON property `metadata`
|
||||||
# @return [Hash<String,Object>]
|
# @return [Hash<String,Object>]
|
||||||
attr_accessor :metadata
|
attr_accessor :metadata
|
||||||
|
|
||||||
# The server-assigned name, which is only unique within the same service that
|
# The server-assigned name, which is only unique within the same service that
|
||||||
# originally returns it. If you use the default HTTP mapping, the
|
# originally returns it. If you use the default HTTP mapping, the `name` should
|
||||||
# `name` should be a resource name ending with `operations/`unique_id``.
|
# be a resource name ending with `operations/`unique_id``.
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# The normal response of the operation in case of success. If the original
|
# 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
|
# method returns no data on success, such as `Delete`, the response is `google.
|
||||||
# `google.protobuf.Empty`. If the original method is standard
|
# protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
|
||||||
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
# the response should be the resource. For other methods, the response should
|
||||||
# methods, the response should have the type `XxxResponse`, where `Xxx`
|
# have the type `XxxResponse`, where `Xxx` is the original method name. For
|
||||||
# is the original method name. For example, if the original method name
|
# example, if the original method name is `TakeSnapshot()`, the inferred
|
||||||
# is `TakeSnapshot()`, the inferred response type is
|
# response type is `TakeSnapshotResponse`.
|
||||||
# `TakeSnapshotResponse`.
|
|
||||||
# Corresponds to the JSON property `response`
|
# Corresponds to the JSON property `response`
|
||||||
# @return [Hash<String,Object>]
|
# @return [Hash<String,Object>]
|
||||||
attr_accessor :response
|
attr_accessor :response
|
||||||
|
|
@ -143,12 +139,12 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# The `Status` type defines a logical error model that is suitable for
|
# The `Status` type defines a logical error model that is suitable for different
|
||||||
# different programming environments, including REST APIs and RPC APIs. It is
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
||||||
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
||||||
# three pieces of data: error code, error message, and error details.
|
# data: error code, error message, and error details. You can find out more
|
||||||
# You can find out more about this error model and how to work with it in the
|
# about this error model and how to work with it in the [API Design Guide](https:
|
||||||
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
# //cloud.google.com/apis/design/errors).
|
||||||
class Status
|
class Status
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -157,15 +153,15 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :code
|
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.
|
# message types for APIs to use.
|
||||||
# Corresponds to the JSON property `details`
|
# Corresponds to the JSON property `details`
|
||||||
# @return [Array<Hash<String,Object>>]
|
# @return [Array<Hash<String,Object>>]
|
||||||
attr_accessor :details
|
attr_accessor :details
|
||||||
|
|
||||||
# A developer-facing error message, which should be in English. Any
|
# A developer-facing error message, which should be in English. Any user-facing
|
||||||
# user-facing error message should be localized and sent in the
|
# error message should be localized and sent in the google.rpc.Status.details
|
||||||
# google.rpc.Status.details field, or localized by the client.
|
# field, or localized by the client.
|
||||||
# Corresponds to the JSON property `message`
|
# Corresponds to the JSON property `message`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :message
|
attr_accessor :message
|
||||||
|
|
|
||||||
|
|
@ -49,15 +49,13 @@ module Google
|
||||||
@batch_path = 'batch'
|
@batch_path = 'batch'
|
||||||
end
|
end
|
||||||
|
|
||||||
# Starts asynchronous cancellation on a long-running operation. The server
|
# Starts asynchronous cancellation on a long-running operation. The server makes
|
||||||
# makes a best effort to cancel the operation, but success is not
|
# a best effort to cancel the operation, but success is not guaranteed. If the
|
||||||
# guaranteed. If the server doesn't support this method, it returns
|
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
# Clients can use Operations.GetOperation or other methods to check whether the
|
||||||
# Operations.GetOperation or
|
# cancellation succeeded or whether the operation completed despite cancellation.
|
||||||
# other methods to check whether the cancellation succeeded or whether the
|
# On successful cancellation, the operation is not deleted; instead, it becomes
|
||||||
# operation completed despite cancellation. On successful cancellation,
|
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
||||||
# 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`.
|
# corresponding to `Code.CANCELLED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be cancelled.
|
# The name of the operation resource to be cancelled.
|
||||||
|
|
@ -91,10 +89,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Deletes a long-running operation. This method indicates that the client is
|
# Deletes a long-running operation. This method indicates that the client is no
|
||||||
# no longer interested in the operation result. It does not cancel the
|
# longer interested in the operation result. It does not cancel the operation.
|
||||||
# operation. If the server doesn't support this method, it returns
|
# If the server doesn't support this method, it returns `google.rpc.Code.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`.
|
# UNIMPLEMENTED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be deleted.
|
# The name of the operation resource to be deleted.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -124,15 +122,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists operations that match the specified filter in the request. If the
|
# Lists operations that match the specified filter in the request. If the server
|
||||||
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
||||||
# NOTE: the `name` binding allows API services to override the binding
|
# binding allows API services to override the binding to use different resource
|
||||||
# to use different resource name schemes, such as `users/*/operations`. To
|
# name schemes, such as `users/*/operations`. To override the binding, API
|
||||||
# override the binding, API services can add a binding such as
|
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
||||||
# `"/v1/`name=users/*`/operations"` to their service configuration.
|
# service configuration. For backwards compatibility, the default name includes
|
||||||
# For backwards compatibility, the default name includes the operations
|
# the operations collection id, however overriding users must ensure the name
|
||||||
# collection id, however overriding users must ensure the name binding
|
# binding is the parent resource, without the operations collection id.
|
||||||
# is the parent resource, without the operations collection id.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation's parent resource.
|
# The name of the operation's parent resource.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,7 @@ module Google
|
||||||
# @see https://firebase.google.com/docs/hosting/
|
# @see https://firebase.google.com/docs/hosting/
|
||||||
module FirebasehostingV1beta1
|
module FirebasehostingV1beta1
|
||||||
VERSION = 'V1beta1'
|
VERSION = 'V1beta1'
|
||||||
REVISION = '20200729'
|
REVISION = '20200731'
|
||||||
|
|
||||||
# View and manage your data across Google Cloud Platform services
|
# View and manage your data across Google Cloud Platform services
|
||||||
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||||
|
|
|
||||||
|
|
@ -22,8 +22,8 @@ module Google
|
||||||
module Apis
|
module Apis
|
||||||
module FirebasehostingV1beta1
|
module FirebasehostingV1beta1
|
||||||
|
|
||||||
# Contains metadata about the user who performed an action, such as creating
|
# Contains metadata about the user who performed an action, such as creating a
|
||||||
# a release or finalizing a version.
|
# release or finalizing a version.
|
||||||
class ActingUser
|
class ActingUser
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -32,8 +32,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :email
|
attr_accessor :email
|
||||||
|
|
||||||
# A profile image URL for the user. May not be present if the user has
|
# A profile image URL for the user. May not be present if the user has changed
|
||||||
# changed their email address or deleted their account.
|
# their email address or deleted their account.
|
||||||
# Corresponds to the JSON property `imageUrl`
|
# Corresponds to the JSON property `imageUrl`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :image_url
|
attr_accessor :image_url
|
||||||
|
|
@ -58,8 +58,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :domain_name
|
attr_accessor :domain_name
|
||||||
|
|
||||||
# The value that must be present as a TXT record on the domain name to
|
# The value that must be present as a TXT record on the domain name to satisfy
|
||||||
# satisfy the challenge.
|
# the challenge.
|
||||||
# Corresponds to the JSON property `token`
|
# Corresponds to the JSON property `token`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :token
|
attr_accessor :token
|
||||||
|
|
@ -79,8 +79,8 @@ module Google
|
||||||
class CertHttpChallenge
|
class CertHttpChallenge
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The URL path on which to serve the specified token to satisfy the
|
# The URL path on which to serve the specified token to satisfy the certificate
|
||||||
# certificate challenge.
|
# challenge.
|
||||||
# Corresponds to the JSON property `path`
|
# Corresponds to the JSON property `path`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :path
|
attr_accessor :path
|
||||||
|
|
@ -110,8 +110,8 @@ module Google
|
||||||
class CloudRunRewrite
|
class CloudRunRewrite
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Optional. User-provided region where the Cloud Run service is hosted.<br>
|
# Optional. User-provided region where the Cloud Run service is hosted. Defaults
|
||||||
# Defaults to `us-central1` if not supplied.
|
# to `us-central1` if not supplied.
|
||||||
# Corresponds to the JSON property `region`
|
# Corresponds to the JSON property `region`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :region
|
attr_accessor :region
|
||||||
|
|
@ -141,9 +141,9 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :domain_name
|
attr_accessor :domain_name
|
||||||
|
|
||||||
# Defines the behavior of a domain-level redirect. Domain redirects preserve
|
# Defines the behavior of a domain-level redirect. Domain redirects preserve the
|
||||||
# the path of the redirect but replace the requested domain with the one
|
# path of the redirect but replace the requested domain with the one specified
|
||||||
# specified in the redirect configuration.
|
# in the redirect configuration.
|
||||||
# Corresponds to the JSON property `domainRedirect`
|
# Corresponds to the JSON property `domainRedirect`
|
||||||
# @return [Google::Apis::FirebasehostingV1beta1::DomainRedirect]
|
# @return [Google::Apis::FirebasehostingV1beta1::DomainRedirect]
|
||||||
attr_accessor :domain_redirect
|
attr_accessor :domain_redirect
|
||||||
|
|
@ -203,8 +203,8 @@ module Google
|
||||||
# @return [Google::Apis::FirebasehostingV1beta1::CertHttpChallenge]
|
# @return [Google::Apis::FirebasehostingV1beta1::CertHttpChallenge]
|
||||||
attr_accessor :cert_challenge_http
|
attr_accessor :cert_challenge_http
|
||||||
|
|
||||||
# The certificate provisioning status; updated when Firebase Hosting
|
# The certificate provisioning status; updated when Firebase Hosting provisions
|
||||||
# provisions an SSL certificate for the domain.
|
# an SSL certificate for the domain.
|
||||||
# Corresponds to the JSON property `certStatus`
|
# Corresponds to the JSON property `certStatus`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :cert_status
|
attr_accessor :cert_status
|
||||||
|
|
@ -246,9 +246,9 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Defines the behavior of a domain-level redirect. Domain redirects preserve
|
# Defines the behavior of a domain-level redirect. Domain redirects preserve the
|
||||||
# the path of the redirect but replace the requested domain with the one
|
# path of the redirect but replace the requested domain with the one specified
|
||||||
# specified in the redirect configuration.
|
# in the redirect configuration.
|
||||||
class DomainRedirect
|
class DomainRedirect
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -273,13 +273,11 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A generic empty message that you can re-use to avoid defining duplicated
|
# A generic empty message that you can re-use to avoid defining duplicated empty
|
||||||
# empty messages in your APIs. A typical example is to use it as the request
|
# messages in your APIs. A typical example is to use it as the request or the
|
||||||
# or the response type of an API method. For instance:
|
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
||||||
# service Foo `
|
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
||||||
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
# `Empty` is empty JSON object ````.
|
||||||
# `
|
|
||||||
# The JSON representation for `Empty` is empty JSON object ````.
|
|
||||||
class Empty
|
class Empty
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -292,15 +290,14 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A [`header`](/docs/hosting/full-config#headers) is an object that specifies
|
# A [`header`](/docs/hosting/full-config#headers) is an object that specifies a
|
||||||
# a URL pattern that, if matched to the request URL path, triggers Hosting to
|
# URL pattern that, if matched to the request URL path, triggers Hosting to
|
||||||
# apply the specified custom response headers.
|
# apply the specified custom response headers.
|
||||||
class Header
|
class Header
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The user-supplied
|
# The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to
|
||||||
# [glob](/docs/hosting/full-config#glob_pattern_matching) to match
|
# match against the request URL path.
|
||||||
# against the request URL path.
|
|
||||||
# Corresponds to the JSON property `glob`
|
# Corresponds to the JSON property `glob`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :glob
|
attr_accessor :glob
|
||||||
|
|
@ -310,8 +307,7 @@ module Google
|
||||||
# @return [Hash<String,String>]
|
# @return [Hash<String,String>]
|
||||||
attr_accessor :headers
|
attr_accessor :headers
|
||||||
|
|
||||||
# The user-supplied RE2 regular expression to match against the request
|
# The user-supplied RE2 regular expression to match against the request URL path.
|
||||||
# URL path.
|
|
||||||
# Corresponds to the JSON property `regex`
|
# Corresponds to the JSON property `regex`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :regex
|
attr_accessor :regex
|
||||||
|
|
@ -357,10 +353,9 @@ module Google
|
||||||
class ListReleasesResponse
|
class ListReleasesResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# If there are additional releases remaining beyond the ones in this
|
# If there are additional releases remaining beyond the ones in this response,
|
||||||
# response, then supply this token in the next
|
# then supply this token in the next [`list`](../sites.versions.files/list) call
|
||||||
# [`list`](../sites.versions.files/list) call to continue with the next set
|
# to continue with the next set of releases.
|
||||||
# of releases.
|
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -436,47 +431,45 @@ module Google
|
||||||
class Operation
|
class Operation
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# If the value is `false`, it means the operation is still in progress.
|
# If the value is `false`, it means the operation is still in progress. If `true`
|
||||||
# If `true`, the operation is completed, and either `error` or `response` is
|
# , the operation is completed, and either `error` or `response` is available.
|
||||||
# available.
|
|
||||||
# Corresponds to the JSON property `done`
|
# Corresponds to the JSON property `done`
|
||||||
# @return [Boolean]
|
# @return [Boolean]
|
||||||
attr_accessor :done
|
attr_accessor :done
|
||||||
alias_method :done?, :done
|
alias_method :done?, :done
|
||||||
|
|
||||||
# The `Status` type defines a logical error model that is suitable for
|
# The `Status` type defines a logical error model that is suitable for different
|
||||||
# different programming environments, including REST APIs and RPC APIs. It is
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
||||||
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
||||||
# three pieces of data: error code, error message, and error details.
|
# data: error code, error message, and error details. You can find out more
|
||||||
# You can find out more about this error model and how to work with it in the
|
# about this error model and how to work with it in the [API Design Guide](https:
|
||||||
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
# //cloud.google.com/apis/design/errors).
|
||||||
# Corresponds to the JSON property `error`
|
# Corresponds to the JSON property `error`
|
||||||
# @return [Google::Apis::FirebasehostingV1beta1::Status]
|
# @return [Google::Apis::FirebasehostingV1beta1::Status]
|
||||||
attr_accessor :error
|
attr_accessor :error
|
||||||
|
|
||||||
# Service-specific metadata associated with the operation. It typically
|
# Service-specific metadata associated with the operation. It typically contains
|
||||||
# contains progress information and common metadata such as create time.
|
# progress information and common metadata such as create time. Some services
|
||||||
# Some services might not provide such metadata. Any method that returns a
|
# might not provide such metadata. Any method that returns a long-running
|
||||||
# long-running operation should document the metadata type, if any.
|
# operation should document the metadata type, if any.
|
||||||
# Corresponds to the JSON property `metadata`
|
# Corresponds to the JSON property `metadata`
|
||||||
# @return [Hash<String,Object>]
|
# @return [Hash<String,Object>]
|
||||||
attr_accessor :metadata
|
attr_accessor :metadata
|
||||||
|
|
||||||
# The server-assigned name, which is only unique within the same service that
|
# The server-assigned name, which is only unique within the same service that
|
||||||
# originally returns it. If you use the default HTTP mapping, the
|
# originally returns it. If you use the default HTTP mapping, the `name` should
|
||||||
# `name` should be a resource name ending with `operations/`unique_id``.
|
# be a resource name ending with `operations/`unique_id``.
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# The normal response of the operation in case of success. If the original
|
# 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
|
# method returns no data on success, such as `Delete`, the response is `google.
|
||||||
# `google.protobuf.Empty`. If the original method is standard
|
# protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
|
||||||
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
# the response should be the resource. For other methods, the response should
|
||||||
# methods, the response should have the type `XxxResponse`, where `Xxx`
|
# have the type `XxxResponse`, where `Xxx` is the original method name. For
|
||||||
# is the original method name. For example, if the original method name
|
# example, if the original method name is `TakeSnapshot()`, the inferred
|
||||||
# is `TakeSnapshot()`, the inferred response type is
|
# response type is `TakeSnapshotResponse`.
|
||||||
# `TakeSnapshotResponse`.
|
|
||||||
# Corresponds to the JSON property `response`
|
# Corresponds to the JSON property `response`
|
||||||
# @return [Hash<String,Object>]
|
# @return [Hash<String,Object>]
|
||||||
attr_accessor :response
|
attr_accessor :response
|
||||||
|
|
@ -499,10 +492,10 @@ module Google
|
||||||
class PopulateVersionFilesRequest
|
class PopulateVersionFilesRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# A set of file paths to the hashes corresponding to assets that should be
|
# A set of file paths to the hashes corresponding to assets that should be added
|
||||||
# added to the version. Note that a file path to an empty hash will remove
|
# to the version. Note that a file path to an empty hash will remove the path
|
||||||
# the path from the version. Calculate a hash by Gzipping the file then
|
# from the version. Calculate a hash by Gzipping the file then taking the SHA256
|
||||||
# taking the SHA256 hash of the newly compressed file.
|
# hash of the newly compressed file.
|
||||||
# Corresponds to the JSON property `files`
|
# Corresponds to the JSON property `files`
|
||||||
# @return [Hash<String,String>]
|
# @return [Hash<String,String>]
|
||||||
attr_accessor :files
|
attr_accessor :files
|
||||||
|
|
@ -527,10 +520,9 @@ module Google
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :upload_required_hashes
|
attr_accessor :upload_required_hashes
|
||||||
|
|
||||||
# The URL to which the files should be uploaded, in the format:
|
# The URL to which the files should be uploaded, in the format: "https://upload-
|
||||||
# <br>"https://upload-firebasehosting.googleapis.com/upload/sites/<var>site-name<
|
# firebasehosting.googleapis.com/upload/sites/site-name /versions/versionID/
|
||||||
# /var>/versions/<var>versionID</var>/files".
|
# files". Perform a multipart `POST` of the Gzipped file contents to the URL
|
||||||
# <br>Perform a multipart `POST` of the Gzipped file contents to the URL
|
|
||||||
# using a forward slash and the hash of the file appended to the end.
|
# using a forward slash and the hash of the file appended to the end.
|
||||||
# Corresponds to the JSON property `uploadUrl`
|
# Corresponds to the JSON property `uploadUrl`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
|
|
@ -547,9 +539,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Version preview configuration. If active and unexpired,
|
# Version preview configuration. If active and unexpired, this version will be
|
||||||
# this version will be accessible via a custom URL even
|
# accessible via a custom URL even if it is not the currently released version.
|
||||||
# if it is not the currently released version.
|
|
||||||
class PreviewConfig
|
class PreviewConfig
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -559,8 +550,8 @@ module Google
|
||||||
attr_accessor :active
|
attr_accessor :active
|
||||||
alias_method :active?, :active
|
alias_method :active?, :active
|
||||||
|
|
||||||
# Indicates the expiration time for previewing this
|
# Indicates the expiration time for previewing this version; preview URL
|
||||||
# version; preview URL requests received after this time will 404.
|
# requests received after this time will 404.
|
||||||
# Corresponds to the JSON property `expireTime`
|
# Corresponds to the JSON property `expireTime`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :expire_time
|
attr_accessor :expire_time
|
||||||
|
|
@ -577,38 +568,33 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL
|
# A [`redirect`](/docs/hosting/full-config#redirects) object specifies a URL
|
||||||
# pattern that, if matched to the request URL path, triggers Hosting to
|
# pattern that, if matched to the request URL path, triggers Hosting to respond
|
||||||
# respond with a redirect to the specified destination path.
|
# with a redirect to the specified destination path.
|
||||||
class Redirect
|
class Redirect
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The user-supplied
|
# The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to
|
||||||
# [glob](/docs/hosting/full-config#glob_pattern_matching) to match
|
# match against the request URL path.
|
||||||
# against the request URL path.
|
|
||||||
# Corresponds to the JSON property `glob`
|
# Corresponds to the JSON property `glob`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :glob
|
attr_accessor :glob
|
||||||
|
|
||||||
# Required. The value to put in the HTTP location header of the response.
|
# Required. The value to put in the HTTP location header of the response. The
|
||||||
# <br>The location can contain capture group values from the pattern using
|
# location can contain capture group values from the pattern using a `:` prefix
|
||||||
# a `:` prefix to identify the segment and an optional `*` to capture the
|
# to identify the segment and an optional `*` to capture the rest of the URL.
|
||||||
# rest of the URL.
|
# For example: "glob": "/:capture*", "statusCode": 301, "location": "https://
|
||||||
# For example:
|
# example.com/foo/:capture"
|
||||||
# <code>"glob": "/:capture*",
|
|
||||||
# <br>"statusCode": 301,
|
|
||||||
# <br>"location": "https://example.com/foo/:capture"</code>
|
|
||||||
# Corresponds to the JSON property `location`
|
# Corresponds to the JSON property `location`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :location
|
attr_accessor :location
|
||||||
|
|
||||||
# The user-supplied RE2 regular expression to match against the request
|
# The user-supplied RE2 regular expression to match against the request URL path.
|
||||||
# URL path.
|
|
||||||
# Corresponds to the JSON property `regex`
|
# Corresponds to the JSON property `regex`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :regex
|
attr_accessor :regex
|
||||||
|
|
||||||
# Required. The status HTTP code to return in the response. It must be a
|
# Required. The status HTTP code to return in the response. It must be a valid
|
||||||
# valid 3xx status code.
|
# 3xx status code.
|
||||||
# Corresponds to the JSON property `statusCode`
|
# Corresponds to the JSON property `statusCode`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :status_code
|
attr_accessor :status_code
|
||||||
|
|
@ -626,22 +612,20 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A `Release` is a particular
|
# A `Release` is a particular [collection of configurations and files](sites.
|
||||||
# [collection of configurations and files](sites.versions)
|
# versions) that is set to be public at a particular time.
|
||||||
# that is set to be public at a particular time.
|
|
||||||
class Release
|
class Release
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The deploy description when the release was created. The value can be up to
|
# The deploy description when the release was created. The value can be up to
|
||||||
# 512 characters.
|
# 512 characters.
|
||||||
# Corresponds to the JSON property `message`
|
# Corresponds to the JSON property `message`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :message
|
attr_accessor :message
|
||||||
|
|
||||||
# Output only. The unique identifier for the release, in the format:
|
# Output only. The unique identifier for the release, in the format: sites/ site-
|
||||||
# <code>sites/<var>site-name</var>/releases/<var>releaseID</var></code>
|
# name/releases/releaseID This name is provided in the response body when you
|
||||||
# This name is provided in the response body when you call the
|
# call the [`CreateRelease`](sites.releases/create) endpoint.
|
||||||
# [`CreateRelease`](sites.releases/create) endpoint.
|
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
@ -651,21 +635,20 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :release_time
|
attr_accessor :release_time
|
||||||
|
|
||||||
# Contains metadata about the user who performed an action, such as creating
|
# Contains metadata about the user who performed an action, such as creating a
|
||||||
# a release or finalizing a version.
|
# release or finalizing a version.
|
||||||
# Corresponds to the JSON property `releaseUser`
|
# Corresponds to the JSON property `releaseUser`
|
||||||
# @return [Google::Apis::FirebasehostingV1beta1::ActingUser]
|
# @return [Google::Apis::FirebasehostingV1beta1::ActingUser]
|
||||||
attr_accessor :release_user
|
attr_accessor :release_user
|
||||||
|
|
||||||
# Explains the reason for the release.
|
# Explains the reason for the release. Specify a value for this field only when
|
||||||
# <br>Specify a value for this field only when creating a `SITE_DISABLE`
|
# creating a `SITE_DISABLE` type release.
|
||||||
# type release.
|
|
||||||
# Corresponds to the JSON property `type`
|
# Corresponds to the JSON property `type`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :type
|
attr_accessor :type
|
||||||
|
|
||||||
# A `Version` is the collection of configuration and
|
# A `Version` is the collection of configuration and [static files](sites.
|
||||||
# [static files](sites.versions.files) that determine how a site is displayed.
|
# versions.files) that determine how a site is displayed.
|
||||||
# Corresponds to the JSON property `version`
|
# Corresponds to the JSON property `version`
|
||||||
# @return [Google::Apis::FirebasehostingV1beta1::Version]
|
# @return [Google::Apis::FirebasehostingV1beta1::Version]
|
||||||
attr_accessor :version
|
attr_accessor :version
|
||||||
|
|
@ -686,8 +669,8 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL
|
# A [`rewrite`](/docs/hosting/full-config#rewrites) object specifies a URL
|
||||||
# pattern that, if matched to the request URL path, triggers Hosting to
|
# pattern that, if matched to the request URL path, triggers Hosting to respond
|
||||||
# respond as if the service were given the specified destination URL.
|
# as if the service were given the specified destination URL.
|
||||||
class Rewrite
|
class Rewrite
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -697,15 +680,14 @@ module Google
|
||||||
attr_accessor :dynamic_links
|
attr_accessor :dynamic_links
|
||||||
alias_method :dynamic_links?, :dynamic_links
|
alias_method :dynamic_links?, :dynamic_links
|
||||||
|
|
||||||
# The function to proxy requests to. Must match the exported function
|
# The function to proxy requests to. Must match the exported function name
|
||||||
# name exactly.
|
# exactly.
|
||||||
# Corresponds to the JSON property `function`
|
# Corresponds to the JSON property `function`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :function
|
attr_accessor :function
|
||||||
|
|
||||||
# The user-supplied
|
# The user-supplied [glob](/docs/hosting/full-config#glob_pattern_matching) to
|
||||||
# [glob](/docs/hosting/full-config#glob_pattern_matching) to match
|
# match against the request URL path.
|
||||||
# against the request URL path.
|
|
||||||
# Corresponds to the JSON property `glob`
|
# Corresponds to the JSON property `glob`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :glob
|
attr_accessor :glob
|
||||||
|
|
@ -715,8 +697,7 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :path
|
attr_accessor :path
|
||||||
|
|
||||||
# The user-supplied RE2 regular expression to match against the request
|
# The user-supplied RE2 regular expression to match against the request URL path.
|
||||||
# URL path.
|
|
||||||
# Corresponds to the JSON property `regex`
|
# Corresponds to the JSON property `regex`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :regex
|
attr_accessor :regex
|
||||||
|
|
@ -748,8 +729,8 @@ module Google
|
||||||
# The configuration for how incoming requests to a site should be routed and
|
# The configuration for how incoming requests to a site should be routed and
|
||||||
# processed before serving content. The URL request paths are matched against
|
# processed before serving content. The URL request paths are matched against
|
||||||
# the specified URL patterns in the configuration, then Hosting applies the
|
# the specified URL patterns in the configuration, then Hosting applies the
|
||||||
# applicable configuration according to a specific
|
# applicable configuration according to a specific [priority order](/docs/
|
||||||
# [priority order](/docs/hosting/full-config#hosting_priority_order).
|
# hosting/full-config#hosting_priority_order).
|
||||||
class ServingConfig
|
class ServingConfig
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -771,16 +752,16 @@ module Google
|
||||||
# @return [Array<Google::Apis::FirebasehostingV1beta1::Header>]
|
# @return [Array<Google::Apis::FirebasehostingV1beta1::Header>]
|
||||||
attr_accessor :headers
|
attr_accessor :headers
|
||||||
|
|
||||||
# An array of objects (called redirect rules), where each rule specifies a
|
# An array of objects (called redirect rules), where each rule specifies a URL
|
||||||
# URL pattern that, if matched to the request URL path, triggers Hosting to
|
# pattern that, if matched to the request URL path, triggers Hosting to respond
|
||||||
# respond with a redirect to the specified destination path.
|
# with a redirect to the specified destination path.
|
||||||
# Corresponds to the JSON property `redirects`
|
# Corresponds to the JSON property `redirects`
|
||||||
# @return [Array<Google::Apis::FirebasehostingV1beta1::Redirect>]
|
# @return [Array<Google::Apis::FirebasehostingV1beta1::Redirect>]
|
||||||
attr_accessor :redirects
|
attr_accessor :redirects
|
||||||
|
|
||||||
# An array of objects (called rewrite rules), where each rule specifies a URL
|
# An array of objects (called rewrite rules), where each rule specifies a URL
|
||||||
# pattern that, if matched to the request URL path, triggers Hosting to
|
# pattern that, if matched to the request URL path, triggers Hosting to respond
|
||||||
# respond as if the service were given the specified destination URL.
|
# as if the service were given the specified destination URL.
|
||||||
# Corresponds to the JSON property `rewrites`
|
# Corresponds to the JSON property `rewrites`
|
||||||
# @return [Array<Google::Apis::FirebasehostingV1beta1::Rewrite>]
|
# @return [Array<Google::Apis::FirebasehostingV1beta1::Rewrite>]
|
||||||
attr_accessor :rewrites
|
attr_accessor :rewrites
|
||||||
|
|
@ -805,23 +786,22 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A `SiteConfig` contains metadata associated with a specific site that
|
# A `SiteConfig` contains metadata associated with a specific site that controls
|
||||||
# controls Firebase Hosting serving behavior
|
# Firebase Hosting serving behavior
|
||||||
class SiteConfig
|
class SiteConfig
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Whether or not web requests made by site visitors are logged via Cloud
|
# Whether or not web requests made by site visitors are logged via Cloud Logging.
|
||||||
# Logging.
|
|
||||||
# Corresponds to the JSON property `cloudLoggingEnabled`
|
# Corresponds to the JSON property `cloudLoggingEnabled`
|
||||||
# @return [Boolean]
|
# @return [Boolean]
|
||||||
attr_accessor :cloud_logging_enabled
|
attr_accessor :cloud_logging_enabled
|
||||||
alias_method :cloud_logging_enabled?, :cloud_logging_enabled
|
alias_method :cloud_logging_enabled?, :cloud_logging_enabled
|
||||||
|
|
||||||
# The number of FINALIZED versions that will be held for a site before
|
# The number of FINALIZED versions that will be held for a site before automatic
|
||||||
# automatic deletion. When a new version is deployed, content for versions
|
# deletion. When a new version is deployed, content for versions in storage in
|
||||||
# in storage in excess of this number will be deleted, and will no longer be
|
# excess of this number will be deleted, and will no longer be billed for
|
||||||
# billed for storage usage. Oldest versions will be deleted first; sites are
|
# storage usage. Oldest versions will be deleted first; sites are created with
|
||||||
# created with an unlimited number of max_versions by default.
|
# an unlimited number of max_versions by default.
|
||||||
# Corresponds to the JSON property `maxVersions`
|
# Corresponds to the JSON property `maxVersions`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :max_versions
|
attr_accessor :max_versions
|
||||||
|
|
@ -837,12 +817,12 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# The `Status` type defines a logical error model that is suitable for
|
# The `Status` type defines a logical error model that is suitable for different
|
||||||
# different programming environments, including REST APIs and RPC APIs. It is
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
||||||
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
||||||
# three pieces of data: error code, error message, and error details.
|
# data: error code, error message, and error details. You can find out more
|
||||||
# You can find out more about this error model and how to work with it in the
|
# about this error model and how to work with it in the [API Design Guide](https:
|
||||||
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
# //cloud.google.com/apis/design/errors).
|
||||||
class Status
|
class Status
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -851,15 +831,15 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :code
|
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.
|
# message types for APIs to use.
|
||||||
# Corresponds to the JSON property `details`
|
# Corresponds to the JSON property `details`
|
||||||
# @return [Array<Hash<String,Object>>]
|
# @return [Array<Hash<String,Object>>]
|
||||||
attr_accessor :details
|
attr_accessor :details
|
||||||
|
|
||||||
# A developer-facing error message, which should be in English. Any
|
# A developer-facing error message, which should be in English. Any user-facing
|
||||||
# user-facing error message should be localized and sent in the
|
# error message should be localized and sent in the google.rpc.Status.details
|
||||||
# google.rpc.Status.details field, or localized by the client.
|
# field, or localized by the client.
|
||||||
# Corresponds to the JSON property `message`
|
# Corresponds to the JSON property `message`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :message
|
attr_accessor :message
|
||||||
|
|
@ -876,16 +856,16 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A `Version` is the collection of configuration and
|
# A `Version` is the collection of configuration and [static files](sites.
|
||||||
# [static files](sites.versions.files) that determine how a site is displayed.
|
# versions.files) that determine how a site is displayed.
|
||||||
class Version
|
class Version
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The configuration for how incoming requests to a site should be routed and
|
# The configuration for how incoming requests to a site should be routed and
|
||||||
# processed before serving content. The URL request paths are matched against
|
# processed before serving content. The URL request paths are matched against
|
||||||
# the specified URL patterns in the configuration, then Hosting applies the
|
# the specified URL patterns in the configuration, then Hosting applies the
|
||||||
# applicable configuration according to a specific
|
# applicable configuration according to a specific [priority order](/docs/
|
||||||
# [priority order](/docs/hosting/full-config#hosting_priority_order).
|
# hosting/full-config#hosting_priority_order).
|
||||||
# Corresponds to the JSON property `config`
|
# Corresponds to the JSON property `config`
|
||||||
# @return [Google::Apis::FirebasehostingV1beta1::ServingConfig]
|
# @return [Google::Apis::FirebasehostingV1beta1::ServingConfig]
|
||||||
attr_accessor :config
|
attr_accessor :config
|
||||||
|
|
@ -895,8 +875,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :create_time
|
attr_accessor :create_time
|
||||||
|
|
||||||
# Contains metadata about the user who performed an action, such as creating
|
# Contains metadata about the user who performed an action, such as creating a
|
||||||
# a release or finalizing a version.
|
# release or finalizing a version.
|
||||||
# Corresponds to the JSON property `createUser`
|
# Corresponds to the JSON property `createUser`
|
||||||
# @return [Google::Apis::FirebasehostingV1beta1::ActingUser]
|
# @return [Google::Apis::FirebasehostingV1beta1::ActingUser]
|
||||||
attr_accessor :create_user
|
attr_accessor :create_user
|
||||||
|
|
@ -906,14 +886,14 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :delete_time
|
attr_accessor :delete_time
|
||||||
|
|
||||||
# Contains metadata about the user who performed an action, such as creating
|
# Contains metadata about the user who performed an action, such as creating a
|
||||||
# a release or finalizing a version.
|
# release or finalizing a version.
|
||||||
# Corresponds to the JSON property `deleteUser`
|
# Corresponds to the JSON property `deleteUser`
|
||||||
# @return [Google::Apis::FirebasehostingV1beta1::ActingUser]
|
# @return [Google::Apis::FirebasehostingV1beta1::ActingUser]
|
||||||
attr_accessor :delete_user
|
attr_accessor :delete_user
|
||||||
|
|
||||||
# Output only. The total number of files associated with the version.
|
# Output only. The total number of files associated with the version. This value
|
||||||
# <br>This value is calculated after a version is `FINALIZED`.
|
# is calculated after a version is `FINALIZED`.
|
||||||
# Corresponds to the JSON property `fileCount`
|
# Corresponds to the JSON property `fileCount`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :file_count
|
attr_accessor :file_count
|
||||||
|
|
@ -923,8 +903,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :finalize_time
|
attr_accessor :finalize_time
|
||||||
|
|
||||||
# Contains metadata about the user who performed an action, such as creating
|
# Contains metadata about the user who performed an action, such as creating a
|
||||||
# a release or finalizing a version.
|
# release or finalizing a version.
|
||||||
# Corresponds to the JSON property `finalizeUser`
|
# Corresponds to the JSON property `finalizeUser`
|
||||||
# @return [Google::Apis::FirebasehostingV1beta1::ActingUser]
|
# @return [Google::Apis::FirebasehostingV1beta1::ActingUser]
|
||||||
attr_accessor :finalize_user
|
attr_accessor :finalize_user
|
||||||
|
|
@ -934,41 +914,33 @@ module Google
|
||||||
# @return [Hash<String,String>]
|
# @return [Hash<String,String>]
|
||||||
attr_accessor :labels
|
attr_accessor :labels
|
||||||
|
|
||||||
# The unique identifier for a version, in the format:
|
# The unique identifier for a version, in the format: sites/site-name /versions/
|
||||||
# <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
|
# versionID This name is provided in the response body when you call the [`
|
||||||
# This name is provided in the response body when you call the
|
# CreateVersion`](../sites.versions/create) endpoint.
|
||||||
# [`CreateVersion`](../sites.versions/create) endpoint.
|
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# Version preview configuration. If active and unexpired,
|
# Version preview configuration. If active and unexpired, this version will be
|
||||||
# this version will be accessible via a custom URL even
|
# accessible via a custom URL even if it is not the currently released version.
|
||||||
# if it is not the currently released version.
|
|
||||||
# Corresponds to the JSON property `preview`
|
# Corresponds to the JSON property `preview`
|
||||||
# @return [Google::Apis::FirebasehostingV1beta1::PreviewConfig]
|
# @return [Google::Apis::FirebasehostingV1beta1::PreviewConfig]
|
||||||
attr_accessor :preview
|
attr_accessor :preview
|
||||||
|
|
||||||
# The deploy status of a version.
|
# The deploy status of a version. For a successful deploy, call the [`
|
||||||
# <br>
|
# CreateVersion`](sites.versions/create) endpoint to make a new version (`
|
||||||
# <br>For a successful deploy, call the
|
# CREATED` status), [upload all desired files](sites.versions/populateFiles) to
|
||||||
# [`CreateVersion`](sites.versions/create) endpoint to make a new version
|
# the version, then [update](sites.versions/patch) the version to the `FINALIZED`
|
||||||
# (`CREATED` status),
|
# status. Note that if you leave the version in the `CREATED` state for more
|
||||||
# [upload all desired files](sites.versions/populateFiles) to the version,
|
# than 12 hours, the system will automatically mark the version as `ABANDONED`.
|
||||||
# then [update](sites.versions/patch) the version to the `FINALIZED` status.
|
# You can also change the status of a version to `DELETED` by calling the [`
|
||||||
# <br>
|
# DeleteVersion`](sites.versions/delete) endpoint.
|
||||||
# <br>Note that if you leave the version in the `CREATED` state for more
|
|
||||||
# than 12 hours, the system will automatically mark the version as
|
|
||||||
# `ABANDONED`.
|
|
||||||
# <br>
|
|
||||||
# <br>You can also change the status of a version to `DELETED` by calling the
|
|
||||||
# [`DeleteVersion`](sites.versions/delete) endpoint.
|
|
||||||
# Corresponds to the JSON property `status`
|
# Corresponds to the JSON property `status`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :status
|
attr_accessor :status
|
||||||
|
|
||||||
# Output only. The total stored bytesize of the version.
|
# Output only. The total stored bytesize of the version. This value is
|
||||||
# <br>This value is calculated after a version is `FINALIZED`.
|
# calculated after a version is `FINALIZED`.
|
||||||
# Corresponds to the JSON property `versionBytes`
|
# Corresponds to the JSON property `versionBytes`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :version_bytes
|
attr_accessor :version_bytes
|
||||||
|
|
@ -1009,9 +981,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :path
|
attr_accessor :path
|
||||||
|
|
||||||
# Output only. The current status of a particular file in the specified
|
# Output only. The current status of a particular file in the specified version.
|
||||||
# version.
|
# The value will be either `pending upload` or `uploaded`.
|
||||||
# <br>The value will be either `pending upload` or `uploaded`.
|
|
||||||
# Corresponds to the JSON property `status`
|
# Corresponds to the JSON property `status`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :status
|
attr_accessor :status
|
||||||
|
|
|
||||||
|
|
@ -49,9 +49,8 @@ module Google
|
||||||
@batch_path = 'batch'
|
@batch_path = 'batch'
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the latest state of a long-running operation. Clients can use this
|
# Gets the latest state of a long-running operation. Clients can use this method
|
||||||
# method to poll the operation result at intervals as recommended by the API
|
# to poll the operation result at intervals as recommended by the API service.
|
||||||
# service.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource.
|
# The name of the operation resource.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -83,8 +82,8 @@ module Google
|
||||||
|
|
||||||
# Gets the Hosting metadata for a specific site.
|
# Gets the Hosting metadata for a specific site.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The site for which to get the SiteConfig, in the format:
|
# Required. The site for which to get the SiteConfig, in the format: sites/ site-
|
||||||
# <code>sites/<var>site-name</var>/config</code>
|
# name/config
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -114,15 +113,14 @@ module Google
|
||||||
|
|
||||||
# Sets the Hosting metadata for a specific site.
|
# Sets the Hosting metadata for a specific site.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The site for which to update the SiteConfig, in the format:
|
# Required. The site for which to update the SiteConfig, in the format: sites/
|
||||||
# <code>sites/<var>site-name</var>/config</code>
|
# site-name/config
|
||||||
# @param [Google::Apis::FirebasehostingV1beta1::SiteConfig] site_config_object
|
# @param [Google::Apis::FirebasehostingV1beta1::SiteConfig] site_config_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# A set of field names from your [site configuration](../sites.SiteConfig)
|
# A set of field names from your [site configuration](../sites.SiteConfig) that
|
||||||
# that you want to update.
|
# you want to update. A field will be overwritten if, and only if, it's in the
|
||||||
# <br>A field will be overwritten if, and only if, it's in the mask.
|
# mask. If a mask is not provided then a default mask of only [`max_versions`](..
|
||||||
# <br>If a mask is not provided then a default mask of only
|
# /sites.SiteConfig.max_versions) will be used.
|
||||||
# [`max_versions`](../sites.SiteConfig.max_versions) will be used.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -156,17 +154,14 @@ module Google
|
||||||
# Creates a new release which makes the content of the specified version
|
# Creates a new release which makes the content of the specified version
|
||||||
# actively display on the appropriate URL(s).
|
# actively display on the appropriate URL(s).
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The site that the release belongs to, in the format:
|
# Required. The site that the release belongs to, in the format: sites/ site-
|
||||||
# <code>sites/<var>site-name</var></code>
|
# name
|
||||||
# @param [Google::Apis::FirebasehostingV1beta1::Release] release_object
|
# @param [Google::Apis::FirebasehostingV1beta1::Release] release_object
|
||||||
# @param [String] version_name
|
# @param [String] version_name
|
||||||
# The unique identifier for a version, in the format:
|
# The unique identifier for a version, in the format: /sites/site-name /versions/
|
||||||
# <code>/sites/<var>site-name</var>/versions/<var>versionID</var></code>
|
# versionID The site-name in this version identifier must match the site-name in
|
||||||
# The <var>site-name</var> in this version identifier must match the
|
# the `parent` parameter. This query parameter must be empty if the `type` field
|
||||||
# <var>site-name</var> in the `parent` parameter.
|
# in the request body is `SITE_DISABLE`.
|
||||||
# <br>
|
|
||||||
# <br>This query parameter must be empty if the `type` field in the
|
|
||||||
# request body is `SITE_DISABLE`.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -199,8 +194,7 @@ module Google
|
||||||
|
|
||||||
# Lists the releases that have been created on the specified site.
|
# Lists the releases that have been created on the specified site.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The parent for which to list files, in the format:
|
# Required. The parent for which to list files, in the format: sites/site-name
|
||||||
# <code>sites/<var>site-name</var></code>
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The page size to return. Defaults to 100.
|
# The page size to return. Defaults to 100.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
|
|
@ -237,7 +231,7 @@ module Google
|
||||||
# Creates a domain mapping on the specified site.
|
# Creates a domain mapping on the specified site.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The parent to create the domain association for, in the format:
|
# Required. The parent to create the domain association for, in the format:
|
||||||
# <code>sites/<var>site-name</var></code>
|
# sites/site-name
|
||||||
# @param [Google::Apis::FirebasehostingV1beta1::Domain] domain_object
|
# @param [Google::Apis::FirebasehostingV1beta1::Domain] domain_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -330,8 +324,8 @@ module Google
|
||||||
|
|
||||||
# Lists the domains for the specified site.
|
# Lists the domains for the specified site.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The parent for which to list domains, in the format:
|
# Required. The parent for which to list domains, in the format: sites/ site-
|
||||||
# <code>sites/<var>site-name</var></code>
|
# name
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The page size to return. Defaults to 50.
|
# The page size to return. Defaults to 50.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
|
|
@ -365,8 +359,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Updates the specified domain mapping, creating the mapping as if it does
|
# Updates the specified domain mapping, creating the mapping as if it does not
|
||||||
# not exist.
|
# exist.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The name of the domain association to update or create, if an
|
# Required. The name of the domain association to update or create, if an
|
||||||
# association doesn't already exist.
|
# association doesn't already exist.
|
||||||
|
|
@ -403,17 +397,14 @@ module Google
|
||||||
# Creates a new release which makes the content of the specified version
|
# Creates a new release which makes the content of the specified version
|
||||||
# actively display on the appropriate URL(s).
|
# actively display on the appropriate URL(s).
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The site that the release belongs to, in the format:
|
# Required. The site that the release belongs to, in the format: sites/ site-
|
||||||
# <code>sites/<var>site-name</var></code>
|
# name
|
||||||
# @param [Google::Apis::FirebasehostingV1beta1::Release] release_object
|
# @param [Google::Apis::FirebasehostingV1beta1::Release] release_object
|
||||||
# @param [String] version_name
|
# @param [String] version_name
|
||||||
# The unique identifier for a version, in the format:
|
# The unique identifier for a version, in the format: /sites/site-name /versions/
|
||||||
# <code>/sites/<var>site-name</var>/versions/<var>versionID</var></code>
|
# versionID The site-name in this version identifier must match the site-name in
|
||||||
# The <var>site-name</var> in this version identifier must match the
|
# the `parent` parameter. This query parameter must be empty if the `type` field
|
||||||
# <var>site-name</var> in the `parent` parameter.
|
# in the request body is `SITE_DISABLE`.
|
||||||
# <br>
|
|
||||||
# <br>This query parameter must be empty if the `type` field in the
|
|
||||||
# request body is `SITE_DISABLE`.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -446,8 +437,7 @@ module Google
|
||||||
|
|
||||||
# Lists the releases that have been created on the specified site.
|
# Lists the releases that have been created on the specified site.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The parent for which to list files, in the format:
|
# Required. The parent for which to list files, in the format: sites/site-name
|
||||||
# <code>sites/<var>site-name</var></code>
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The page size to return. Defaults to 100.
|
# The page size to return. Defaults to 100.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
|
|
@ -483,8 +473,8 @@ module Google
|
||||||
|
|
||||||
# Creates a new version for a site.
|
# Creates a new version for a site.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The parent to create the version for, in the format:
|
# Required. The parent to create the version for, in the format: sites/ site-
|
||||||
# <code>sites/<var>site-name</var></code>
|
# name
|
||||||
# @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
|
# @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
|
||||||
# @param [Fixnum] size_bytes
|
# @param [Fixnum] size_bytes
|
||||||
# The self-reported size of the version. This value is used for a pre-emptive
|
# The self-reported size of the version. This value is used for a pre-emptive
|
||||||
|
|
@ -525,8 +515,8 @@ module Google
|
||||||
|
|
||||||
# Deletes the specified version.
|
# Deletes the specified version.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The name of the version to be deleted, in the format:
|
# Required. The name of the version to be deleted, in the format: sites/ site-
|
||||||
# <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
|
# name/versions/versionID
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -554,21 +544,18 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists the versions that have been created on the specified site.
|
# Lists the versions that have been created on the specified site. Will include
|
||||||
# Will include filtering in the future.
|
# filtering in the future.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The parent for which to list files, in the format:
|
# Required. The parent for which to list files, in the format: sites/site-name
|
||||||
# <code>sites/<var>site-name</var></code>
|
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# The filter string used to return a subset of versions in the response.
|
# The filter string used to return a subset of versions in the response.
|
||||||
# Currently supported fields for filtering are: name, status,
|
# Currently supported fields for filtering are: name, status, and create_time.
|
||||||
# and create_time. Filter processing will be implemented in accordance
|
# Filter processing will be implemented in accordance with go/filtering.
|
||||||
# with go/filtering.
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of versions to return. The service may return fewer than
|
# The maximum number of versions to return. The service may return fewer than
|
||||||
# this value.
|
# this value. If unspecified, at most 25 versions will be returned. The maximum
|
||||||
# If unspecified, at most 25 versions will be returned.
|
# value is 100; values above 100 will be coerced to 100
|
||||||
# The maximum value is 100; values above 100 will be coerced to 100
|
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The next_page_token from a previous request, if provided.
|
# The next_page_token from a previous request, if provided.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -601,24 +588,21 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Updates the specified metadata for a version. Note that this method will
|
# Updates the specified metadata for a version. Note that this method will fail
|
||||||
# fail with `FAILED_PRECONDITION` in the event of an invalid state
|
# with `FAILED_PRECONDITION` in the event of an invalid state transition. The
|
||||||
# transition. The only valid transition for a version is currently from a
|
# only valid transition for a version is currently from a `CREATED` status to a `
|
||||||
# `CREATED` status to a `FINALIZED` status.
|
# FINALIZED` status. Use [`DeleteVersion`](../sites.versions/delete) to set the
|
||||||
# Use [`DeleteVersion`](../sites.versions/delete) to set the status of a
|
# status of a version to `DELETED`.
|
||||||
# version to `DELETED`.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The unique identifier for a version, in the format:
|
# The unique identifier for a version, in the format: sites/site-name /versions/
|
||||||
# <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
|
# versionID This name is provided in the response body when you call the [`
|
||||||
# This name is provided in the response body when you call the
|
# CreateVersion`](../sites.versions/create) endpoint.
|
||||||
# [`CreateVersion`](../sites.versions/create) endpoint.
|
|
||||||
# @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
|
# @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# A set of field names from your [version](../sites.versions) that you want
|
# A set of field names from your [version](../sites.versions) that you want to
|
||||||
# to update.
|
# update. A field will be overwritten if, and only if, it's in the mask. If a
|
||||||
# <br>A field will be overwritten if, and only if, it's in the mask.
|
# mask is not provided then a default mask of only [`status`](../sites.versions#
|
||||||
# <br>If a mask is not provided then a default mask of only
|
# Version.FIELDS.status) will be used.
|
||||||
# [`status`](../sites.versions#Version.FIELDS.status) will be used.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -649,11 +633,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Adds content files to a version.
|
# Adds content files to a version. Each file must be under 2 GB.
|
||||||
# Each file must be under 2 GB.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The version to add files to, in the format:
|
# Required. The version to add files to, in the format: sites/site-name /
|
||||||
# <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
|
# versions/versionID
|
||||||
# @param [Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest] populate_version_files_request_object
|
# @param [Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest] populate_version_files_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -686,8 +669,8 @@ module Google
|
||||||
|
|
||||||
# Lists the remaining files to be uploaded for the specified version.
|
# Lists the remaining files to be uploaded for the specified version.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The parent to list files for, in the format:
|
# Required. The parent to list files for, in the format: sites/site-name /
|
||||||
# <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
|
# versions/versionID
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The page size to return. Defaults to 1000.
|
# The page size to return. Defaults to 1000.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
|
|
@ -727,8 +710,8 @@ module Google
|
||||||
|
|
||||||
# Gets the Hosting metadata for a specific site.
|
# Gets the Hosting metadata for a specific site.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The site for which to get the SiteConfig, in the format:
|
# Required. The site for which to get the SiteConfig, in the format: sites/ site-
|
||||||
# <code>sites/<var>site-name</var>/config</code>
|
# name/config
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -758,15 +741,14 @@ module Google
|
||||||
|
|
||||||
# Sets the Hosting metadata for a specific site.
|
# Sets the Hosting metadata for a specific site.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The site for which to update the SiteConfig, in the format:
|
# Required. The site for which to update the SiteConfig, in the format: sites/
|
||||||
# <code>sites/<var>site-name</var>/config</code>
|
# site-name/config
|
||||||
# @param [Google::Apis::FirebasehostingV1beta1::SiteConfig] site_config_object
|
# @param [Google::Apis::FirebasehostingV1beta1::SiteConfig] site_config_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# A set of field names from your [site configuration](../sites.SiteConfig)
|
# A set of field names from your [site configuration](../sites.SiteConfig) that
|
||||||
# that you want to update.
|
# you want to update. A field will be overwritten if, and only if, it's in the
|
||||||
# <br>A field will be overwritten if, and only if, it's in the mask.
|
# mask. If a mask is not provided then a default mask of only [`max_versions`](..
|
||||||
# <br>If a mask is not provided then a default mask of only
|
# /sites.SiteConfig.max_versions) will be used.
|
||||||
# [`max_versions`](../sites.SiteConfig.max_versions) will be used.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -800,17 +782,14 @@ module Google
|
||||||
# Creates a new release which makes the content of the specified version
|
# Creates a new release which makes the content of the specified version
|
||||||
# actively display on the appropriate URL(s).
|
# actively display on the appropriate URL(s).
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The site that the release belongs to, in the format:
|
# Required. The site that the release belongs to, in the format: sites/ site-
|
||||||
# <code>sites/<var>site-name</var></code>
|
# name
|
||||||
# @param [Google::Apis::FirebasehostingV1beta1::Release] release_object
|
# @param [Google::Apis::FirebasehostingV1beta1::Release] release_object
|
||||||
# @param [String] version_name
|
# @param [String] version_name
|
||||||
# The unique identifier for a version, in the format:
|
# The unique identifier for a version, in the format: /sites/site-name /versions/
|
||||||
# <code>/sites/<var>site-name</var>/versions/<var>versionID</var></code>
|
# versionID The site-name in this version identifier must match the site-name in
|
||||||
# The <var>site-name</var> in this version identifier must match the
|
# the `parent` parameter. This query parameter must be empty if the `type` field
|
||||||
# <var>site-name</var> in the `parent` parameter.
|
# in the request body is `SITE_DISABLE`.
|
||||||
# <br>
|
|
||||||
# <br>This query parameter must be empty if the `type` field in the
|
|
||||||
# request body is `SITE_DISABLE`.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -843,8 +822,7 @@ module Google
|
||||||
|
|
||||||
# Lists the releases that have been created on the specified site.
|
# Lists the releases that have been created on the specified site.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The parent for which to list files, in the format:
|
# Required. The parent for which to list files, in the format: sites/site-name
|
||||||
# <code>sites/<var>site-name</var></code>
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The page size to return. Defaults to 100.
|
# The page size to return. Defaults to 100.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
|
|
@ -881,7 +859,7 @@ module Google
|
||||||
# Creates a domain mapping on the specified site.
|
# Creates a domain mapping on the specified site.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The parent to create the domain association for, in the format:
|
# Required. The parent to create the domain association for, in the format:
|
||||||
# <code>sites/<var>site-name</var></code>
|
# sites/site-name
|
||||||
# @param [Google::Apis::FirebasehostingV1beta1::Domain] domain_object
|
# @param [Google::Apis::FirebasehostingV1beta1::Domain] domain_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -974,8 +952,8 @@ module Google
|
||||||
|
|
||||||
# Lists the domains for the specified site.
|
# Lists the domains for the specified site.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The parent for which to list domains, in the format:
|
# Required. The parent for which to list domains, in the format: sites/ site-
|
||||||
# <code>sites/<var>site-name</var></code>
|
# name
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The page size to return. Defaults to 50.
|
# The page size to return. Defaults to 50.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
|
|
@ -1009,8 +987,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Updates the specified domain mapping, creating the mapping as if it does
|
# Updates the specified domain mapping, creating the mapping as if it does not
|
||||||
# not exist.
|
# exist.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The name of the domain association to update or create, if an
|
# Required. The name of the domain association to update or create, if an
|
||||||
# association doesn't already exist.
|
# association doesn't already exist.
|
||||||
|
|
@ -1047,17 +1025,14 @@ module Google
|
||||||
# Creates a new release which makes the content of the specified version
|
# Creates a new release which makes the content of the specified version
|
||||||
# actively display on the appropriate URL(s).
|
# actively display on the appropriate URL(s).
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The site that the release belongs to, in the format:
|
# Required. The site that the release belongs to, in the format: sites/ site-
|
||||||
# <code>sites/<var>site-name</var></code>
|
# name
|
||||||
# @param [Google::Apis::FirebasehostingV1beta1::Release] release_object
|
# @param [Google::Apis::FirebasehostingV1beta1::Release] release_object
|
||||||
# @param [String] version_name
|
# @param [String] version_name
|
||||||
# The unique identifier for a version, in the format:
|
# The unique identifier for a version, in the format: /sites/site-name /versions/
|
||||||
# <code>/sites/<var>site-name</var>/versions/<var>versionID</var></code>
|
# versionID The site-name in this version identifier must match the site-name in
|
||||||
# The <var>site-name</var> in this version identifier must match the
|
# the `parent` parameter. This query parameter must be empty if the `type` field
|
||||||
# <var>site-name</var> in the `parent` parameter.
|
# in the request body is `SITE_DISABLE`.
|
||||||
# <br>
|
|
||||||
# <br>This query parameter must be empty if the `type` field in the
|
|
||||||
# request body is `SITE_DISABLE`.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1090,8 +1065,7 @@ module Google
|
||||||
|
|
||||||
# Lists the releases that have been created on the specified site.
|
# Lists the releases that have been created on the specified site.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The parent for which to list files, in the format:
|
# Required. The parent for which to list files, in the format: sites/site-name
|
||||||
# <code>sites/<var>site-name</var></code>
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The page size to return. Defaults to 100.
|
# The page size to return. Defaults to 100.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
|
|
@ -1127,8 +1101,8 @@ module Google
|
||||||
|
|
||||||
# Creates a new version for a site.
|
# Creates a new version for a site.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The parent to create the version for, in the format:
|
# Required. The parent to create the version for, in the format: sites/ site-
|
||||||
# <code>sites/<var>site-name</var></code>
|
# name
|
||||||
# @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
|
# @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
|
||||||
# @param [Fixnum] size_bytes
|
# @param [Fixnum] size_bytes
|
||||||
# The self-reported size of the version. This value is used for a pre-emptive
|
# The self-reported size of the version. This value is used for a pre-emptive
|
||||||
|
|
@ -1169,8 +1143,8 @@ module Google
|
||||||
|
|
||||||
# Deletes the specified version.
|
# Deletes the specified version.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The name of the version to be deleted, in the format:
|
# Required. The name of the version to be deleted, in the format: sites/ site-
|
||||||
# <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
|
# name/versions/versionID
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1198,21 +1172,18 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists the versions that have been created on the specified site.
|
# Lists the versions that have been created on the specified site. Will include
|
||||||
# Will include filtering in the future.
|
# filtering in the future.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The parent for which to list files, in the format:
|
# Required. The parent for which to list files, in the format: sites/site-name
|
||||||
# <code>sites/<var>site-name</var></code>
|
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# The filter string used to return a subset of versions in the response.
|
# The filter string used to return a subset of versions in the response.
|
||||||
# Currently supported fields for filtering are: name, status,
|
# Currently supported fields for filtering are: name, status, and create_time.
|
||||||
# and create_time. Filter processing will be implemented in accordance
|
# Filter processing will be implemented in accordance with go/filtering.
|
||||||
# with go/filtering.
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of versions to return. The service may return fewer than
|
# The maximum number of versions to return. The service may return fewer than
|
||||||
# this value.
|
# this value. If unspecified, at most 25 versions will be returned. The maximum
|
||||||
# If unspecified, at most 25 versions will be returned.
|
# value is 100; values above 100 will be coerced to 100
|
||||||
# The maximum value is 100; values above 100 will be coerced to 100
|
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The next_page_token from a previous request, if provided.
|
# The next_page_token from a previous request, if provided.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -1245,24 +1216,21 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Updates the specified metadata for a version. Note that this method will
|
# Updates the specified metadata for a version. Note that this method will fail
|
||||||
# fail with `FAILED_PRECONDITION` in the event of an invalid state
|
# with `FAILED_PRECONDITION` in the event of an invalid state transition. The
|
||||||
# transition. The only valid transition for a version is currently from a
|
# only valid transition for a version is currently from a `CREATED` status to a `
|
||||||
# `CREATED` status to a `FINALIZED` status.
|
# FINALIZED` status. Use [`DeleteVersion`](../sites.versions/delete) to set the
|
||||||
# Use [`DeleteVersion`](../sites.versions/delete) to set the status of a
|
# status of a version to `DELETED`.
|
||||||
# version to `DELETED`.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The unique identifier for a version, in the format:
|
# The unique identifier for a version, in the format: sites/site-name /versions/
|
||||||
# <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
|
# versionID This name is provided in the response body when you call the [`
|
||||||
# This name is provided in the response body when you call the
|
# CreateVersion`](../sites.versions/create) endpoint.
|
||||||
# [`CreateVersion`](../sites.versions/create) endpoint.
|
|
||||||
# @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
|
# @param [Google::Apis::FirebasehostingV1beta1::Version] version_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# A set of field names from your [version](../sites.versions) that you want
|
# A set of field names from your [version](../sites.versions) that you want to
|
||||||
# to update.
|
# update. A field will be overwritten if, and only if, it's in the mask. If a
|
||||||
# <br>A field will be overwritten if, and only if, it's in the mask.
|
# mask is not provided then a default mask of only [`status`](../sites.versions#
|
||||||
# <br>If a mask is not provided then a default mask of only
|
# Version.FIELDS.status) will be used.
|
||||||
# [`status`](../sites.versions#Version.FIELDS.status) will be used.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1293,11 +1261,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Adds content files to a version.
|
# Adds content files to a version. Each file must be under 2 GB.
|
||||||
# Each file must be under 2 GB.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The version to add files to, in the format:
|
# Required. The version to add files to, in the format: sites/site-name /
|
||||||
# <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
|
# versions/versionID
|
||||||
# @param [Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest] populate_version_files_request_object
|
# @param [Google::Apis::FirebasehostingV1beta1::PopulateVersionFilesRequest] populate_version_files_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -1330,8 +1297,8 @@ module Google
|
||||||
|
|
||||||
# Lists the remaining files to be uploaded for the specified version.
|
# Lists the remaining files to be uploaded for the specified version.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The parent to list files for, in the format:
|
# Required. The parent to list files for, in the format: sites/site-name /
|
||||||
# <code>sites/<var>site-name</var>/versions/<var>versionID</var></code>
|
# versions/versionID
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The page size to return. Defaults to 1000.
|
# The page size to return. Defaults to 1000.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,7 @@ module Google
|
||||||
# @see https://developers.google.com/gmail/postmaster
|
# @see https://developers.google.com/gmail/postmaster
|
||||||
module GmailpostmastertoolsV1beta1
|
module GmailpostmastertoolsV1beta1
|
||||||
VERSION = 'V1beta1'
|
VERSION = 'V1beta1'
|
||||||
REVISION = '20200719'
|
REVISION = '20200801'
|
||||||
|
|
||||||
# See email traffic metrics for the domains you have registered in Gmail Postmaster Tools
|
# See email traffic metrics for the domains you have registered in Gmail Postmaster Tools
|
||||||
AUTH_POSTMASTER_READONLY = 'https://www.googleapis.com/auth/postmaster.readonly'
|
AUTH_POSTMASTER_READONLY = 'https://www.googleapis.com/auth/postmaster.readonly'
|
||||||
|
|
|
||||||
|
|
@ -31,8 +31,7 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :error_class
|
attr_accessor :error_class
|
||||||
|
|
||||||
# The ratio of messages where the error occurred vs all authenticated
|
# The ratio of messages where the error occurred vs all authenticated traffic.
|
||||||
# traffic.
|
|
||||||
# Corresponds to the JSON property `errorRatio`
|
# Corresponds to the JSON property `errorRatio`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :error_ratio
|
attr_accessor :error_ratio
|
||||||
|
|
@ -58,15 +57,14 @@ module Google
|
||||||
class Domain
|
class Domain
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Timestamp when the user registered this domain. Assigned by
|
# Timestamp when the user registered this domain. Assigned by the server.
|
||||||
# the server.
|
|
||||||
# Corresponds to the JSON property `createTime`
|
# Corresponds to the JSON property `createTime`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :create_time
|
attr_accessor :create_time
|
||||||
|
|
||||||
# The resource name of the Domain.
|
# The resource name of the Domain. Domain names have the form `domains/`
|
||||||
# Domain names have the form `domains/`domain_name``, where domain_name
|
# domain_name``, where domain_name is the fully qualified domain name (i.e.,
|
||||||
# is the fully qualified domain name (i.e., mymail.mydomain.com).
|
# mymail.mydomain.com).
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
@ -98,8 +96,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :id
|
attr_accessor :id
|
||||||
|
|
||||||
# The ratio of user marked spam messages with the identifier vs the total
|
# The ratio of user marked spam messages with the identifier vs the total number
|
||||||
# number of inboxed messages with that identifier.
|
# of inboxed messages with that identifier.
|
||||||
# Corresponds to the JSON property `spamRatio`
|
# Corresponds to the JSON property `spamRatio`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :spam_ratio
|
attr_accessor :spam_ratio
|
||||||
|
|
@ -120,8 +118,8 @@ module Google
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Total number of unique IPs in this reputation category. This metric only
|
# Total number of unique IPs in this reputation category. This metric only
|
||||||
# pertains to traffic that passed [SPF](http://www.openspf.org/) or
|
# pertains to traffic that passed [SPF](http://www.openspf.org/) or [DKIM](http:/
|
||||||
# [DKIM](http://www.dkim.org/).
|
# /www.dkim.org/).
|
||||||
# Corresponds to the JSON property `numIps`
|
# Corresponds to the JSON property `numIps`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :num_ips
|
attr_accessor :num_ips
|
||||||
|
|
@ -157,8 +155,8 @@ module Google
|
||||||
# @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::Domain>]
|
# @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::Domain>]
|
||||||
attr_accessor :domains
|
attr_accessor :domains
|
||||||
|
|
||||||
# Token to retrieve the next page of results, or empty if there are no
|
# Token to retrieve the next page of results, or empty if there are no more
|
||||||
# more results in the list.
|
# results in the list.
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -178,8 +176,8 @@ module Google
|
||||||
class ListTrafficStatsResponse
|
class ListTrafficStatsResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Token to retrieve the next page of results, or empty if there are no
|
# Token to retrieve the next page of results, or empty if there are no more
|
||||||
# more results in the list.
|
# results in the list.
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -210,16 +208,16 @@ module Google
|
||||||
# @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::DeliveryError>]
|
# @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::DeliveryError>]
|
||||||
attr_accessor :delivery_errors
|
attr_accessor :delivery_errors
|
||||||
|
|
||||||
# The ratio of mail that successfully authenticated with DKIM vs. all mail
|
# The ratio of mail that successfully authenticated with DKIM vs. all mail that
|
||||||
# that attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed
|
# attempted to authenticate with [DKIM](http://www.dkim.org/). Spoofed mail is
|
||||||
# mail is excluded.
|
# excluded.
|
||||||
# Corresponds to the JSON property `dkimSuccessRatio`
|
# Corresponds to the JSON property `dkimSuccessRatio`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :dkim_success_ratio
|
attr_accessor :dkim_success_ratio
|
||||||
|
|
||||||
# The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks
|
# The ratio of mail that passed [DMARC](https://dmarc.org/) alignment checks vs
|
||||||
# vs all mail received from the domain that successfully authenticated with
|
# all mail received from the domain that successfully authenticated with either
|
||||||
# either of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
|
# of [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
|
||||||
# Corresponds to the JSON property `dmarcSuccessRatio`
|
# Corresponds to the JSON property `dmarcSuccessRatio`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :dmarc_success_ratio
|
attr_accessor :dmarc_success_ratio
|
||||||
|
|
@ -229,27 +227,26 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :domain_reputation
|
attr_accessor :domain_reputation
|
||||||
|
|
||||||
# The ratio of incoming mail (to Gmail), that passed secure transport (TLS)
|
# The ratio of incoming mail (to Gmail), that passed secure transport (TLS) vs
|
||||||
# vs all mail received from that domain. This metric only pertains to traffic
|
# all mail received from that domain. This metric only pertains to traffic that
|
||||||
# that passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
|
# passed [SPF](http://www.openspf.org/) or [DKIM](http://www.dkim.org/).
|
||||||
# Corresponds to the JSON property `inboundEncryptionRatio`
|
# Corresponds to the JSON property `inboundEncryptionRatio`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :inbound_encryption_ratio
|
attr_accessor :inbound_encryption_ratio
|
||||||
|
|
||||||
# Reputation information pertaining to the IP addresses of the email servers
|
# Reputation information pertaining to the IP addresses of the email servers for
|
||||||
# for the domain. There is exactly one entry for each reputation category
|
# the domain. There is exactly one entry for each reputation category except
|
||||||
# except
|
|
||||||
# REPUTATION_CATEGORY_UNSPECIFIED.
|
# REPUTATION_CATEGORY_UNSPECIFIED.
|
||||||
# Corresponds to the JSON property `ipReputations`
|
# Corresponds to the JSON property `ipReputations`
|
||||||
# @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::IpReputation>]
|
# @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::IpReputation>]
|
||||||
attr_accessor :ip_reputations
|
attr_accessor :ip_reputations
|
||||||
|
|
||||||
# The resource name of the traffic statistics. Traffic statistic names have
|
# The resource name of the traffic statistics. Traffic statistic names have the
|
||||||
# the form `domains/`domain`/trafficStats/`date``, where
|
# form `domains/`domain`/trafficStats/`date``, where domain_name is the fully
|
||||||
# domain_name is the fully qualified domain name (i.e., mymail.mydomain.com)
|
# qualified domain name (i.e., mymail.mydomain.com) of the domain this traffic
|
||||||
# of the domain this traffic statistics pertains to and date is the date in
|
# statistics pertains to and date is the date in yyyymmdd format that these
|
||||||
# yyyymmdd format that these statistics corresponds to.
|
# statistics corresponds to. For example: domains/mymail.mydomain.com/
|
||||||
# For example: domains/mymail.mydomain.com/trafficStats/20160807
|
# trafficStats/20160807
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
@ -260,24 +257,22 @@ module Google
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :outbound_encryption_ratio
|
attr_accessor :outbound_encryption_ratio
|
||||||
|
|
||||||
# Spammy [Feedback loop identifiers]
|
# Spammy [Feedback loop identifiers] (https://support.google.com/mail/answer/
|
||||||
# (https://support.google.com/mail/answer/6254652) with their individual spam
|
# 6254652) with their individual spam rates. This metric only pertains to
|
||||||
# rates. This metric only pertains to traffic that is authenticated by
|
# traffic that is authenticated by [DKIM](http://www.dkim.org/).
|
||||||
# [DKIM](http://www.dkim.org/).
|
|
||||||
# Corresponds to the JSON property `spammyFeedbackLoops`
|
# Corresponds to the JSON property `spammyFeedbackLoops`
|
||||||
# @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::FeedbackLoop>]
|
# @return [Array<Google::Apis::GmailpostmastertoolsV1beta1::FeedbackLoop>]
|
||||||
attr_accessor :spammy_feedback_loops
|
attr_accessor :spammy_feedback_loops
|
||||||
|
|
||||||
# The ratio of mail that successfully authenticated with SPF vs. all mail
|
# The ratio of mail that successfully authenticated with SPF vs. all mail that
|
||||||
# that attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed
|
# attempted to authenticate with [SPF](http://www.openspf.org/). Spoofed mail is
|
||||||
# mail is excluded.
|
# excluded.
|
||||||
# Corresponds to the JSON property `spfSuccessRatio`
|
# Corresponds to the JSON property `spfSuccessRatio`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :spf_success_ratio
|
attr_accessor :spf_success_ratio
|
||||||
|
|
||||||
# The ratio of user-report spam vs. email that was sent to the inbox. This
|
# The ratio of user-report spam vs. email that was sent to the inbox. This
|
||||||
# metric only pertains to emails authenticated by
|
# metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).
|
||||||
# [DKIM](http://www.dkim.org/).
|
|
||||||
# Corresponds to the JSON property `userReportedSpamRatio`
|
# Corresponds to the JSON property `userReportedSpamRatio`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :user_reported_spam_ratio
|
attr_accessor :user_reported_spam_ratio
|
||||||
|
|
|
||||||
|
|
@ -49,12 +49,11 @@ module Google
|
||||||
@batch_path = 'batch'
|
@batch_path = 'batch'
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets a specific domain registered by the client.
|
# Gets a specific domain registered by the client. Returns NOT_FOUND if the
|
||||||
# Returns NOT_FOUND if the domain does not exist.
|
# domain does not exist.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The resource name of the domain. It should have the form
|
# The resource name of the domain. It should have the form `domains/`domain_name`
|
||||||
# `domains/`domain_name``, where domain_name is the fully qualified
|
# `, where domain_name is the fully qualified domain name.
|
||||||
# domain name.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -86,13 +85,12 @@ module Google
|
||||||
# domains in the response is unspecified and non-deterministic. Newly created
|
# domains in the response is unspecified and non-deterministic. Newly created
|
||||||
# domains will not necessarily be added to the end of this list.
|
# domains will not necessarily be added to the end of this list.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# Requested page size. Server may return fewer domains than requested.
|
# Requested page size. Server may return fewer domains than requested. If
|
||||||
# If unspecified, server will pick an appropriate default.
|
# unspecified, server will pick an appropriate default.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The next_page_token value returned from a previous List request, if any.
|
# The next_page_token value returned from a previous List request, if any. This
|
||||||
# This is the value of
|
# is the value of ListDomainsResponse.next_page_token returned from the previous
|
||||||
# ListDomainsResponse.next_page_token
|
# call to `ListDomains` method.
|
||||||
# returned from the previous call to `ListDomains` method.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -121,12 +119,12 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Get traffic statistics for a domain on a specific date.
|
# Get traffic statistics for a domain on a specific date. Returns
|
||||||
# Returns PERMISSION_DENIED if user does not have permission to access
|
# PERMISSION_DENIED if user does not have permission to access TrafficStats for
|
||||||
# TrafficStats for the domain.
|
# the domain.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The resource name of the traffic statistics to get.
|
# The resource name of the traffic statistics to get. E.g., domains/mymail.
|
||||||
# E.g., domains/mymail.mydomain.com/trafficStats/20160807.
|
# mydomain.com/trafficStats/20160807.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -154,41 +152,37 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# List traffic statistics for all available days.
|
# List traffic statistics for all available days. Returns PERMISSION_DENIED if
|
||||||
# Returns PERMISSION_DENIED if user does not have permission to access
|
# user does not have permission to access TrafficStats for the domain.
|
||||||
# TrafficStats for the domain.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# The resource name of the domain whose traffic statistics we'd like to list.
|
# The resource name of the domain whose traffic statistics we'd like to list. It
|
||||||
# It should have the form `domains/`domain_name``, where domain_name is
|
# should have the form `domains/`domain_name``, where domain_name is the fully
|
||||||
# the fully qualified domain name.
|
# qualified domain name.
|
||||||
# @param [Fixnum] end_date_day
|
# @param [Fixnum] end_date_day
|
||||||
# Day of month. Must be from 1 to 31 and valid for the year and month, or 0
|
# Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if
|
||||||
# if specifying a year by itself or a year and month where the day is not
|
# specifying a year by itself or a year and month where the day is not
|
||||||
# significant.
|
# significant.
|
||||||
# @param [Fixnum] end_date_month
|
# @param [Fixnum] end_date_month
|
||||||
# Month of year. Must be from 1 to 12, or 0 if specifying a year without a
|
# Month of year. Must be from 1 to 12, or 0 if specifying a year without a month
|
||||||
# month and day.
|
# and day.
|
||||||
# @param [Fixnum] end_date_year
|
# @param [Fixnum] end_date_year
|
||||||
# Year of date. Must be from 1 to 9999, or 0 if specifying a date without
|
# Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
|
||||||
# a year.
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# Requested page size. Server may return fewer TrafficStats than
|
# Requested page size. Server may return fewer TrafficStats than requested. If
|
||||||
# requested. If unspecified, server will pick an appropriate default.
|
# unspecified, server will pick an appropriate default.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The next_page_token value returned from a previous List request, if any.
|
# The next_page_token value returned from a previous List request, if any. This
|
||||||
# This is the value of
|
# is the value of ListTrafficStatsResponse.next_page_token returned from the
|
||||||
# ListTrafficStatsResponse.next_page_token
|
# previous call to `ListTrafficStats` method.
|
||||||
# returned from the previous call to `ListTrafficStats` method.
|
|
||||||
# @param [Fixnum] start_date_day
|
# @param [Fixnum] start_date_day
|
||||||
# Day of month. Must be from 1 to 31 and valid for the year and month, or 0
|
# Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if
|
||||||
# if specifying a year by itself or a year and month where the day is not
|
# specifying a year by itself or a year and month where the day is not
|
||||||
# significant.
|
# significant.
|
||||||
# @param [Fixnum] start_date_month
|
# @param [Fixnum] start_date_month
|
||||||
# Month of year. Must be from 1 to 12, or 0 if specifying a year without a
|
# Month of year. Must be from 1 to 12, or 0 if specifying a year without a month
|
||||||
# month and day.
|
# and day.
|
||||||
# @param [Fixnum] start_date_year
|
# @param [Fixnum] start_date_year
|
||||||
# Year of date. Must be from 1 to 9999, or 0 if specifying a date without
|
# Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
|
||||||
# a year.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,7 @@ module Google
|
||||||
# @see https://cloud.google.com/natural-language/
|
# @see https://cloud.google.com/natural-language/
|
||||||
module LanguageV1
|
module LanguageV1
|
||||||
VERSION = 'V1'
|
VERSION = 'V1'
|
||||||
REVISION = '20200406'
|
REVISION = '20200801'
|
||||||
|
|
||||||
# Apply machine learning models to reveal the structure and meaning of text
|
# Apply machine learning models to reveal the structure and meaning of text
|
||||||
AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language'
|
AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language'
|
||||||
|
|
|
||||||
|
|
@ -26,8 +26,8 @@ module Google
|
||||||
class AnalyzeEntitiesRequest
|
class AnalyzeEntitiesRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1::Document]
|
# @return [Google::Apis::LanguageV1::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -57,9 +57,9 @@ module Google
|
||||||
# @return [Array<Google::Apis::LanguageV1::Entity>]
|
# @return [Array<Google::Apis::LanguageV1::Entity>]
|
||||||
attr_accessor :entities
|
attr_accessor :entities
|
||||||
|
|
||||||
# The language of the text, which will be the same as the language specified
|
# The language of the text, which will be the same as the language specified in
|
||||||
# in the request or, if not specified, the automatically-detected language.
|
# the request or, if not specified, the automatically-detected language. See
|
||||||
# See Document.language field for more details.
|
# Document.language field for more details.
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
@ -79,8 +79,8 @@ module Google
|
||||||
class AnalyzeEntitySentimentRequest
|
class AnalyzeEntitySentimentRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1::Document]
|
# @return [Google::Apis::LanguageV1::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -110,9 +110,9 @@ module Google
|
||||||
# @return [Array<Google::Apis::LanguageV1::Entity>]
|
# @return [Array<Google::Apis::LanguageV1::Entity>]
|
||||||
attr_accessor :entities
|
attr_accessor :entities
|
||||||
|
|
||||||
# The language of the text, which will be the same as the language specified
|
# The language of the text, which will be the same as the language specified in
|
||||||
# in the request or, if not specified, the automatically-detected language.
|
# the request or, if not specified, the automatically-detected language. See
|
||||||
# See Document.language field for more details.
|
# Document.language field for more details.
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
@ -132,8 +132,8 @@ module Google
|
||||||
class AnalyzeSentimentRequest
|
class AnalyzeSentimentRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1::Document]
|
# @return [Google::Apis::LanguageV1::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -158,15 +158,14 @@ module Google
|
||||||
class AnalyzeSentimentResponse
|
class AnalyzeSentimentResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
# Corresponds to the JSON property `documentSentiment`
|
# Corresponds to the JSON property `documentSentiment`
|
||||||
# @return [Google::Apis::LanguageV1::Sentiment]
|
# @return [Google::Apis::LanguageV1::Sentiment]
|
||||||
attr_accessor :document_sentiment
|
attr_accessor :document_sentiment
|
||||||
|
|
||||||
# The language of the text, which will be the same as the language specified
|
# The language of the text, which will be the same as the language specified in
|
||||||
# in the request or, if not specified, the automatically-detected language.
|
# the request or, if not specified, the automatically-detected language. See
|
||||||
# See Document.language field for more details.
|
# Document.language field for more details.
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
@ -192,8 +191,8 @@ module Google
|
||||||
class AnalyzeSyntaxRequest
|
class AnalyzeSyntaxRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1::Document]
|
# @return [Google::Apis::LanguageV1::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -218,9 +217,9 @@ module Google
|
||||||
class AnalyzeSyntaxResponse
|
class AnalyzeSyntaxResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The language of the text, which will be the same as the language specified
|
# The language of the text, which will be the same as the language specified in
|
||||||
# in the request or, if not specified, the automatically-detected language.
|
# the request or, if not specified, the automatically-detected language. See
|
||||||
# See Document.language field for more details.
|
# Document.language field for more details.
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
@ -252,8 +251,8 @@ module Google
|
||||||
class AnnotateTextRequest
|
class AnnotateTextRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1::Document]
|
# @return [Google::Apis::LanguageV1::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -263,8 +262,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :encoding_type
|
attr_accessor :encoding_type
|
||||||
|
|
||||||
# All available features for sentiment, syntax, and semantic analysis.
|
# All available features for sentiment, syntax, and semantic analysis. Setting
|
||||||
# Setting each one to true will enable that specific analysis for the input.
|
# each one to true will enable that specific analysis for the input.
|
||||||
# Corresponds to the JSON property `features`
|
# Corresponds to the JSON property `features`
|
||||||
# @return [Google::Apis::LanguageV1::Features]
|
# @return [Google::Apis::LanguageV1::Features]
|
||||||
attr_accessor :features
|
attr_accessor :features
|
||||||
|
|
@ -290,22 +289,20 @@ module Google
|
||||||
# @return [Array<Google::Apis::LanguageV1::ClassificationCategory>]
|
# @return [Array<Google::Apis::LanguageV1::ClassificationCategory>]
|
||||||
attr_accessor :categories
|
attr_accessor :categories
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
# Corresponds to the JSON property `documentSentiment`
|
# Corresponds to the JSON property `documentSentiment`
|
||||||
# @return [Google::Apis::LanguageV1::Sentiment]
|
# @return [Google::Apis::LanguageV1::Sentiment]
|
||||||
attr_accessor :document_sentiment
|
attr_accessor :document_sentiment
|
||||||
|
|
||||||
# Entities, along with their semantic information, in the input document.
|
# Entities, along with their semantic information, in the input document.
|
||||||
# Populated if the user enables
|
# Populated if the user enables AnnotateTextRequest.Features.extract_entities.
|
||||||
# AnnotateTextRequest.Features.extract_entities.
|
|
||||||
# Corresponds to the JSON property `entities`
|
# Corresponds to the JSON property `entities`
|
||||||
# @return [Array<Google::Apis::LanguageV1::Entity>]
|
# @return [Array<Google::Apis::LanguageV1::Entity>]
|
||||||
attr_accessor :entities
|
attr_accessor :entities
|
||||||
|
|
||||||
# The language of the text, which will be the same as the language specified
|
# The language of the text, which will be the same as the language specified in
|
||||||
# in the request or, if not specified, the automatically-detected language.
|
# the request or, if not specified, the automatically-detected language. See
|
||||||
# See Document.language field for more details.
|
# Document.language field for more details.
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
@ -317,8 +314,7 @@ module Google
|
||||||
attr_accessor :sentences
|
attr_accessor :sentences
|
||||||
|
|
||||||
# Tokens, along with their syntactic information, in the input document.
|
# Tokens, along with their syntactic information, in the input document.
|
||||||
# Populated if the user enables
|
# Populated if the user enables AnnotateTextRequest.Features.extract_syntax.
|
||||||
# AnnotateTextRequest.Features.extract_syntax.
|
|
||||||
# Corresponds to the JSON property `tokens`
|
# Corresponds to the JSON property `tokens`
|
||||||
# @return [Array<Google::Apis::LanguageV1::Token>]
|
# @return [Array<Google::Apis::LanguageV1::Token>]
|
||||||
attr_accessor :tokens
|
attr_accessor :tokens
|
||||||
|
|
@ -342,8 +338,8 @@ module Google
|
||||||
class ClassificationCategory
|
class ClassificationCategory
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The classifier's confidence of the category. Number represents how certain
|
# The classifier's confidence of the category. Number represents how certain the
|
||||||
# the classifier is that this category represents the given text.
|
# classifier is that this category represents the given text.
|
||||||
# Corresponds to the JSON property `confidence`
|
# Corresponds to the JSON property `confidence`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :confidence
|
attr_accessor :confidence
|
||||||
|
|
@ -369,8 +365,8 @@ module Google
|
||||||
class ClassifyTextRequest
|
class ClassifyTextRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1::Document]
|
# @return [Google::Apis::LanguageV1::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -405,16 +401,14 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Represents dependency parse tree information for a token. (For more
|
# Represents dependency parse tree information for a token. (For more
|
||||||
# information on dependency labels, see
|
# information on dependency labels, see http://www.aclweb.org/anthology/P13-2017
|
||||||
# http://www.aclweb.org/anthology/P13-2017
|
|
||||||
class DependencyEdge
|
class DependencyEdge
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Represents the head of this token in the dependency tree.
|
# Represents the head of this token in the dependency tree. This is the index of
|
||||||
# This is the index of the token which has an arc going to this token.
|
# the token which has an arc going to this token. The index is the position of
|
||||||
# The index is the position of the token in the array of tokens returned
|
# the token in the array of tokens returned by the API method. If this token is
|
||||||
# by the API method. If this token is a root token, then the
|
# a root token, then the `head_token_index` is its own index.
|
||||||
# `head_token_index` is its own index.
|
|
||||||
# Corresponds to the JSON property `headTokenIndex`
|
# Corresponds to the JSON property `headTokenIndex`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :head_token_index
|
attr_accessor :head_token_index
|
||||||
|
|
@ -435,39 +429,37 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
class Document
|
class Document
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The content of the input in string format.
|
# The content of the input in string format. Cloud audit logging exempt since it
|
||||||
# Cloud audit logging exempt since it is based on user data.
|
# is based on user data.
|
||||||
# Corresponds to the JSON property `content`
|
# Corresponds to the JSON property `content`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :content
|
attr_accessor :content
|
||||||
|
|
||||||
# The Google Cloud Storage URI where the file content is located.
|
# The Google Cloud Storage URI where the file content is located. This URI must
|
||||||
# This URI must be of the form: gs://bucket_name/object_name. For more
|
# be of the form: gs://bucket_name/object_name. For more details, see https://
|
||||||
# details, see https://cloud.google.com/storage/docs/reference-uris.
|
# cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object
|
||||||
# NOTE: Cloud Storage object versioning is not supported.
|
# versioning is not supported.
|
||||||
# Corresponds to the JSON property `gcsContentUri`
|
# Corresponds to the JSON property `gcsContentUri`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :gcs_content_uri
|
attr_accessor :gcs_content_uri
|
||||||
|
|
||||||
# The language of the document (if not specified, the language is
|
# The language of the document (if not specified, the language is automatically
|
||||||
# automatically detected). Both ISO and BCP-47 language codes are
|
# detected). Both ISO and BCP-47 language codes are accepted. [Language Support](
|
||||||
# accepted.<br>
|
# https://cloud.google.com/natural-language/docs/languages) lists currently
|
||||||
# [Language
|
# supported languages for each API method. If the language (either specified by
|
||||||
# Support](https://cloud.google.com/natural-language/docs/languages) lists
|
# the caller or automatically detected) is not supported by the called API
|
||||||
# currently supported languages for each API method. If the language (either
|
# method, an `INVALID_ARGUMENT` error is returned.
|
||||||
# specified by the caller or automatically detected) is not supported by the
|
|
||||||
# called API method, an `INVALID_ARGUMENT` error is returned.
|
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
||||||
# Required. If the type is not set or is `TYPE_UNSPECIFIED`,
|
# Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `
|
||||||
# returns an `INVALID_ARGUMENT` error.
|
# INVALID_ARGUMENT` error.
|
||||||
# Corresponds to the JSON property `type`
|
# Corresponds to the JSON property `type`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :type
|
attr_accessor :type
|
||||||
|
|
@ -485,22 +477,22 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Represents a phrase in the text that is a known entity, such as
|
# Represents a phrase in the text that is a known entity, such as a person, an
|
||||||
# a person, an organization, or location. The API associates information, such
|
# organization, or location. The API associates information, such as salience
|
||||||
# as salience and mentions, with entities.
|
# and mentions, with entities.
|
||||||
class Entity
|
class Entity
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The mentions of this entity in the input document. The API currently
|
# The mentions of this entity in the input document. The API currently supports
|
||||||
# supports proper noun mentions.
|
# proper noun mentions.
|
||||||
# Corresponds to the JSON property `mentions`
|
# Corresponds to the JSON property `mentions`
|
||||||
# @return [Array<Google::Apis::LanguageV1::EntityMention>]
|
# @return [Array<Google::Apis::LanguageV1::EntityMention>]
|
||||||
attr_accessor :mentions
|
attr_accessor :mentions
|
||||||
|
|
||||||
# Metadata associated with the entity.
|
# Metadata associated with the entity. For most entity types, the metadata is a
|
||||||
# For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
|
# Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are
|
||||||
# and Knowledge Graph MID (`mid`), if they are available. For the metadata
|
# available. For the metadata associated with other entity types, see the Type
|
||||||
# associated with other entity types, see the Type table below.
|
# table below.
|
||||||
# Corresponds to the JSON property `metadata`
|
# Corresponds to the JSON property `metadata`
|
||||||
# @return [Hash<String,String>]
|
# @return [Hash<String,String>]
|
||||||
attr_accessor :metadata
|
attr_accessor :metadata
|
||||||
|
|
@ -510,17 +502,15 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# The salience score associated with the entity in the [0, 1.0] range.
|
# The salience score associated with the entity in the [0, 1.0] range. The
|
||||||
# The salience score for an entity provides information about the
|
# salience score for an entity provides information about the importance or
|
||||||
# importance or centrality of that entity to the entire document text.
|
# centrality of that entity to the entire document text. Scores closer to 0 are
|
||||||
# Scores closer to 0 are less salient, while scores closer to 1.0 are highly
|
# less salient, while scores closer to 1.0 are highly salient.
|
||||||
# salient.
|
|
||||||
# Corresponds to the JSON property `salience`
|
# Corresponds to the JSON property `salience`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :salience
|
attr_accessor :salience
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
# Corresponds to the JSON property `sentiment`
|
# Corresponds to the JSON property `sentiment`
|
||||||
# @return [Google::Apis::LanguageV1::Sentiment]
|
# @return [Google::Apis::LanguageV1::Sentiment]
|
||||||
attr_accessor :sentiment
|
attr_accessor :sentiment
|
||||||
|
|
@ -550,8 +540,7 @@ module Google
|
||||||
class EntityMention
|
class EntityMention
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
# Corresponds to the JSON property `sentiment`
|
# Corresponds to the JSON property `sentiment`
|
||||||
# @return [Google::Apis::LanguageV1::Sentiment]
|
# @return [Google::Apis::LanguageV1::Sentiment]
|
||||||
attr_accessor :sentiment
|
attr_accessor :sentiment
|
||||||
|
|
@ -578,8 +567,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# All available features for sentiment, syntax, and semantic analysis.
|
# All available features for sentiment, syntax, and semantic analysis. Setting
|
||||||
# Setting each one to true will enable that specific analysis for the input.
|
# each one to true will enable that specific analysis for the input.
|
||||||
class Features
|
class Features
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -627,9 +616,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Represents part of speech information for a token. Parts of speech
|
# Represents part of speech information for a token. Parts of speech are as
|
||||||
# are as defined in
|
# defined in http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
|
||||||
# http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
|
|
||||||
class PartOfSpeech
|
class PartOfSpeech
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -718,8 +706,7 @@ module Google
|
||||||
class Sentence
|
class Sentence
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
# Corresponds to the JSON property `sentiment`
|
# Corresponds to the JSON property `sentiment`
|
||||||
# @return [Google::Apis::LanguageV1::Sentiment]
|
# @return [Google::Apis::LanguageV1::Sentiment]
|
||||||
attr_accessor :sentiment
|
attr_accessor :sentiment
|
||||||
|
|
@ -740,20 +727,17 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
class Sentiment
|
class Sentiment
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# A non-negative number in the [0, +inf) range, which represents
|
# A non-negative number in the [0, +inf) range, which represents the absolute
|
||||||
# the absolute magnitude of sentiment regardless of score (positive or
|
# magnitude of sentiment regardless of score (positive or negative).
|
||||||
# negative).
|
|
||||||
# Corresponds to the JSON property `magnitude`
|
# Corresponds to the JSON property `magnitude`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :magnitude
|
attr_accessor :magnitude
|
||||||
|
|
||||||
# Sentiment score between -1.0 (negative sentiment) and 1.0
|
# Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
|
||||||
# (positive sentiment).
|
|
||||||
# Corresponds to the JSON property `score`
|
# Corresponds to the JSON property `score`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :score
|
attr_accessor :score
|
||||||
|
|
@ -769,12 +753,12 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# The `Status` type defines a logical error model that is suitable for
|
# The `Status` type defines a logical error model that is suitable for different
|
||||||
# different programming environments, including REST APIs and RPC APIs. It is
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
||||||
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
||||||
# three pieces of data: error code, error message, and error details.
|
# data: error code, error message, and error details. You can find out more
|
||||||
# You can find out more about this error model and how to work with it in the
|
# about this error model and how to work with it in the [API Design Guide](https:
|
||||||
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
# //cloud.google.com/apis/design/errors).
|
||||||
class Status
|
class Status
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -783,15 +767,15 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :code
|
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.
|
# message types for APIs to use.
|
||||||
# Corresponds to the JSON property `details`
|
# Corresponds to the JSON property `details`
|
||||||
# @return [Array<Hash<String,Object>>]
|
# @return [Array<Hash<String,Object>>]
|
||||||
attr_accessor :details
|
attr_accessor :details
|
||||||
|
|
||||||
# A developer-facing error message, which should be in English. Any
|
# A developer-facing error message, which should be in English. Any user-facing
|
||||||
# user-facing error message should be localized and sent in the
|
# error message should be localized and sent in the google.rpc.Status.details
|
||||||
# google.rpc.Status.details field, or localized by the client.
|
# field, or localized by the client.
|
||||||
# Corresponds to the JSON property `message`
|
# Corresponds to the JSON property `message`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :message
|
attr_accessor :message
|
||||||
|
|
@ -839,8 +823,7 @@ module Google
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Represents dependency parse tree information for a token. (For more
|
# Represents dependency parse tree information for a token. (For more
|
||||||
# information on dependency labels, see
|
# information on dependency labels, see http://www.aclweb.org/anthology/P13-2017
|
||||||
# http://www.aclweb.org/anthology/P13-2017
|
|
||||||
# Corresponds to the JSON property `dependencyEdge`
|
# Corresponds to the JSON property `dependencyEdge`
|
||||||
# @return [Google::Apis::LanguageV1::DependencyEdge]
|
# @return [Google::Apis::LanguageV1::DependencyEdge]
|
||||||
attr_accessor :dependency_edge
|
attr_accessor :dependency_edge
|
||||||
|
|
@ -850,9 +833,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :lemma
|
attr_accessor :lemma
|
||||||
|
|
||||||
# Represents part of speech information for a token. Parts of speech
|
# Represents part of speech information for a token. Parts of speech are as
|
||||||
# are as defined in
|
# defined in http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
|
||||||
# http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf
|
|
||||||
# Corresponds to the JSON property `partOfSpeech`
|
# Corresponds to the JSON property `partOfSpeech`
|
||||||
# @return [Google::Apis::LanguageV1::PartOfSpeech]
|
# @return [Google::Apis::LanguageV1::PartOfSpeech]
|
||||||
attr_accessor :part_of_speech
|
attr_accessor :part_of_speech
|
||||||
|
|
|
||||||
|
|
@ -50,8 +50,8 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Finds named entities (currently proper names and common nouns) in the text
|
# Finds named entities (currently proper names and common nouns) in the text
|
||||||
# along with entity types, salience, mentions for each entity, and
|
# along with entity types, salience, mentions for each entity, and other
|
||||||
# other properties.
|
# properties.
|
||||||
# @param [Google::Apis::LanguageV1::AnalyzeEntitiesRequest] analyze_entities_request_object
|
# @param [Google::Apis::LanguageV1::AnalyzeEntitiesRequest] analyze_entities_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -81,8 +81,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Finds entities, similar to AnalyzeEntities in the text and analyzes
|
# Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment
|
||||||
# sentiment associated with each entity and its mentions.
|
# associated with each entity and its mentions.
|
||||||
# @param [Google::Apis::LanguageV1::AnalyzeEntitySentimentRequest] analyze_entity_sentiment_request_object
|
# @param [Google::Apis::LanguageV1::AnalyzeEntitySentimentRequest] analyze_entity_sentiment_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,7 @@ module Google
|
||||||
# @see https://cloud.google.com/natural-language/
|
# @see https://cloud.google.com/natural-language/
|
||||||
module LanguageV1beta1
|
module LanguageV1beta1
|
||||||
VERSION = 'V1beta1'
|
VERSION = 'V1beta1'
|
||||||
REVISION = '20200406'
|
REVISION = '20200801'
|
||||||
|
|
||||||
# Apply machine learning models to reveal the structure and meaning of text
|
# Apply machine learning models to reveal the structure and meaning of text
|
||||||
AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language'
|
AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language'
|
||||||
|
|
|
||||||
|
|
@ -26,8 +26,8 @@ module Google
|
||||||
class AnalyzeEntitiesRequest
|
class AnalyzeEntitiesRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1beta1::Document]
|
# @return [Google::Apis::LanguageV1beta1::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -57,9 +57,9 @@ module Google
|
||||||
# @return [Array<Google::Apis::LanguageV1beta1::Entity>]
|
# @return [Array<Google::Apis::LanguageV1beta1::Entity>]
|
||||||
attr_accessor :entities
|
attr_accessor :entities
|
||||||
|
|
||||||
# The language of the text, which will be the same as the language specified
|
# The language of the text, which will be the same as the language specified in
|
||||||
# in the request or, if not specified, the automatically-detected language.
|
# the request or, if not specified, the automatically-detected language. See
|
||||||
# See Document.language field for more details.
|
# Document.language field for more details.
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
@ -79,8 +79,8 @@ module Google
|
||||||
class AnalyzeSentimentRequest
|
class AnalyzeSentimentRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1beta1::Document]
|
# @return [Google::Apis::LanguageV1beta1::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -106,15 +106,14 @@ module Google
|
||||||
class AnalyzeSentimentResponse
|
class AnalyzeSentimentResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
# Corresponds to the JSON property `documentSentiment`
|
# Corresponds to the JSON property `documentSentiment`
|
||||||
# @return [Google::Apis::LanguageV1beta1::Sentiment]
|
# @return [Google::Apis::LanguageV1beta1::Sentiment]
|
||||||
attr_accessor :document_sentiment
|
attr_accessor :document_sentiment
|
||||||
|
|
||||||
# The language of the text, which will be the same as the language specified
|
# The language of the text, which will be the same as the language specified in
|
||||||
# in the request or, if not specified, the automatically-detected language.
|
# the request or, if not specified, the automatically-detected language. See
|
||||||
# See Document.language field for more details.
|
# Document.language field for more details.
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
@ -140,8 +139,8 @@ module Google
|
||||||
class AnalyzeSyntaxRequest
|
class AnalyzeSyntaxRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1beta1::Document]
|
# @return [Google::Apis::LanguageV1beta1::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -166,9 +165,9 @@ module Google
|
||||||
class AnalyzeSyntaxResponse
|
class AnalyzeSyntaxResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The language of the text, which will be the same as the language specified
|
# The language of the text, which will be the same as the language specified in
|
||||||
# in the request or, if not specified, the automatically-detected language.
|
# the request or, if not specified, the automatically-detected language. See
|
||||||
# See Document.language field for more details.
|
# Document.language field for more details.
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
@ -200,8 +199,8 @@ module Google
|
||||||
class AnnotateTextRequest
|
class AnnotateTextRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1beta1::Document]
|
# @return [Google::Apis::LanguageV1beta1::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -211,8 +210,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :encoding_type
|
attr_accessor :encoding_type
|
||||||
|
|
||||||
# All available features for sentiment, syntax, and semantic analysis.
|
# All available features for sentiment, syntax, and semantic analysis. Setting
|
||||||
# Setting each one to true will enable that specific analysis for the input.
|
# each one to true will enable that specific analysis for the input.
|
||||||
# Corresponds to the JSON property `features`
|
# Corresponds to the JSON property `features`
|
||||||
# @return [Google::Apis::LanguageV1beta1::Features]
|
# @return [Google::Apis::LanguageV1beta1::Features]
|
||||||
attr_accessor :features
|
attr_accessor :features
|
||||||
|
|
@ -233,22 +232,20 @@ module Google
|
||||||
class AnnotateTextResponse
|
class AnnotateTextResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
# Corresponds to the JSON property `documentSentiment`
|
# Corresponds to the JSON property `documentSentiment`
|
||||||
# @return [Google::Apis::LanguageV1beta1::Sentiment]
|
# @return [Google::Apis::LanguageV1beta1::Sentiment]
|
||||||
attr_accessor :document_sentiment
|
attr_accessor :document_sentiment
|
||||||
|
|
||||||
# Entities, along with their semantic information, in the input document.
|
# Entities, along with their semantic information, in the input document.
|
||||||
# Populated if the user enables
|
# Populated if the user enables AnnotateTextRequest.Features.extract_entities.
|
||||||
# AnnotateTextRequest.Features.extract_entities.
|
|
||||||
# Corresponds to the JSON property `entities`
|
# Corresponds to the JSON property `entities`
|
||||||
# @return [Array<Google::Apis::LanguageV1beta1::Entity>]
|
# @return [Array<Google::Apis::LanguageV1beta1::Entity>]
|
||||||
attr_accessor :entities
|
attr_accessor :entities
|
||||||
|
|
||||||
# The language of the text, which will be the same as the language specified
|
# The language of the text, which will be the same as the language specified in
|
||||||
# in the request or, if not specified, the automatically-detected language.
|
# the request or, if not specified, the automatically-detected language. See
|
||||||
# See Document.language field for more details.
|
# Document.language field for more details.
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
@ -260,8 +257,7 @@ module Google
|
||||||
attr_accessor :sentences
|
attr_accessor :sentences
|
||||||
|
|
||||||
# Tokens, along with their syntactic information, in the input document.
|
# Tokens, along with their syntactic information, in the input document.
|
||||||
# Populated if the user enables
|
# Populated if the user enables AnnotateTextRequest.Features.extract_syntax.
|
||||||
# AnnotateTextRequest.Features.extract_syntax.
|
|
||||||
# Corresponds to the JSON property `tokens`
|
# Corresponds to the JSON property `tokens`
|
||||||
# @return [Array<Google::Apis::LanguageV1beta1::Token>]
|
# @return [Array<Google::Apis::LanguageV1beta1::Token>]
|
||||||
attr_accessor :tokens
|
attr_accessor :tokens
|
||||||
|
|
@ -284,11 +280,10 @@ module Google
|
||||||
class DependencyEdge
|
class DependencyEdge
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Represents the head of this token in the dependency tree.
|
# Represents the head of this token in the dependency tree. This is the index of
|
||||||
# This is the index of the token which has an arc going to this token.
|
# the token which has an arc going to this token. The index is the position of
|
||||||
# The index is the position of the token in the array of tokens returned
|
# the token in the array of tokens returned by the API method. If this token is
|
||||||
# by the API method. If this token is a root token, then the
|
# a root token, then the `head_token_index` is its own index.
|
||||||
# `head_token_index` is its own index.
|
|
||||||
# Corresponds to the JSON property `headTokenIndex`
|
# Corresponds to the JSON property `headTokenIndex`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :head_token_index
|
attr_accessor :head_token_index
|
||||||
|
|
@ -309,39 +304,37 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
class Document
|
class Document
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The content of the input in string format.
|
# The content of the input in string format. Cloud audit logging exempt since it
|
||||||
# Cloud audit logging exempt since it is based on user data.
|
# is based on user data.
|
||||||
# Corresponds to the JSON property `content`
|
# Corresponds to the JSON property `content`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :content
|
attr_accessor :content
|
||||||
|
|
||||||
# The Google Cloud Storage URI where the file content is located.
|
# The Google Cloud Storage URI where the file content is located. This URI must
|
||||||
# This URI must be of the form: gs://bucket_name/object_name. For more
|
# be of the form: gs://bucket_name/object_name. For more details, see https://
|
||||||
# details, see https://cloud.google.com/storage/docs/reference-uris.
|
# cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object
|
||||||
# NOTE: Cloud Storage object versioning is not supported.
|
# versioning is not supported.
|
||||||
# Corresponds to the JSON property `gcsContentUri`
|
# Corresponds to the JSON property `gcsContentUri`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :gcs_content_uri
|
attr_accessor :gcs_content_uri
|
||||||
|
|
||||||
# The language of the document (if not specified, the language is
|
# The language of the document (if not specified, the language is automatically
|
||||||
# automatically detected). Both ISO and BCP-47 language codes are
|
# detected). Both ISO and BCP-47 language codes are accepted. [Language Support](
|
||||||
# accepted.<br>
|
# https://cloud.google.com/natural-language/docs/languages) lists currently
|
||||||
# [Language
|
# supported languages for each API method. If the language (either specified by
|
||||||
# Support](https://cloud.google.com/natural-language/docs/languages) lists
|
# the caller or automatically detected) is not supported by the called API
|
||||||
# currently supported languages for each API method. If the language (either
|
# method, an `INVALID_ARGUMENT` error is returned.
|
||||||
# specified by the caller or automatically detected) is not supported by the
|
|
||||||
# called API method, an `INVALID_ARGUMENT` error is returned.
|
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
||||||
# Required. If the type is not set or is `TYPE_UNSPECIFIED`,
|
# Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `
|
||||||
# returns an `INVALID_ARGUMENT` error.
|
# INVALID_ARGUMENT` error.
|
||||||
# Corresponds to the JSON property `type`
|
# Corresponds to the JSON property `type`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :type
|
attr_accessor :type
|
||||||
|
|
@ -359,21 +352,21 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Represents a phrase in the text that is a known entity, such as
|
# Represents a phrase in the text that is a known entity, such as a person, an
|
||||||
# a person, an organization, or location. The API associates information, such
|
# organization, or location. The API associates information, such as salience
|
||||||
# as salience and mentions, with entities.
|
# and mentions, with entities.
|
||||||
class Entity
|
class Entity
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The mentions of this entity in the input document. The API currently
|
# The mentions of this entity in the input document. The API currently supports
|
||||||
# supports proper noun mentions.
|
# proper noun mentions.
|
||||||
# Corresponds to the JSON property `mentions`
|
# Corresponds to the JSON property `mentions`
|
||||||
# @return [Array<Google::Apis::LanguageV1beta1::EntityMention>]
|
# @return [Array<Google::Apis::LanguageV1beta1::EntityMention>]
|
||||||
attr_accessor :mentions
|
attr_accessor :mentions
|
||||||
|
|
||||||
# Metadata associated with the entity.
|
# Metadata associated with the entity. Currently, Wikipedia URLs and Knowledge
|
||||||
# Currently, Wikipedia URLs and Knowledge Graph MIDs are provided, if
|
# Graph MIDs are provided, if available. The associated keys are "wikipedia_url"
|
||||||
# available. The associated keys are "wikipedia_url" and "mid", respectively.
|
# and "mid", respectively.
|
||||||
# Corresponds to the JSON property `metadata`
|
# Corresponds to the JSON property `metadata`
|
||||||
# @return [Hash<String,String>]
|
# @return [Hash<String,String>]
|
||||||
attr_accessor :metadata
|
attr_accessor :metadata
|
||||||
|
|
@ -383,11 +376,10 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# The salience score associated with the entity in the [0, 1.0] range.
|
# The salience score associated with the entity in the [0, 1.0] range. The
|
||||||
# The salience score for an entity provides information about the
|
# salience score for an entity provides information about the importance or
|
||||||
# importance or centrality of that entity to the entire document text.
|
# centrality of that entity to the entire document text. Scores closer to 0 are
|
||||||
# Scores closer to 0 are less salient, while scores closer to 1.0 are highly
|
# less salient, while scores closer to 1.0 are highly salient.
|
||||||
# salient.
|
|
||||||
# Corresponds to the JSON property `salience`
|
# Corresponds to the JSON property `salience`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :salience
|
attr_accessor :salience
|
||||||
|
|
@ -437,8 +429,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# All available features for sentiment, syntax, and semantic analysis.
|
# All available features for sentiment, syntax, and semantic analysis. Setting
|
||||||
# Setting each one to true will enable that specific analysis for the input.
|
# each one to true will enable that specific analysis for the input.
|
||||||
class Features
|
class Features
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -561,8 +553,7 @@ module Google
|
||||||
class Sentence
|
class Sentence
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
# Corresponds to the JSON property `sentiment`
|
# Corresponds to the JSON property `sentiment`
|
||||||
# @return [Google::Apis::LanguageV1beta1::Sentiment]
|
# @return [Google::Apis::LanguageV1beta1::Sentiment]
|
||||||
attr_accessor :sentiment
|
attr_accessor :sentiment
|
||||||
|
|
@ -583,27 +574,24 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
class Sentiment
|
class Sentiment
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# A non-negative number in the [0, +inf) range, which represents
|
# A non-negative number in the [0, +inf) range, which represents the absolute
|
||||||
# the absolute magnitude of sentiment regardless of score (positive or
|
# magnitude of sentiment regardless of score (positive or negative).
|
||||||
# negative).
|
|
||||||
# Corresponds to the JSON property `magnitude`
|
# Corresponds to the JSON property `magnitude`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :magnitude
|
attr_accessor :magnitude
|
||||||
|
|
||||||
# DEPRECATED FIELD - This field is being deprecated in
|
# DEPRECATED FIELD - This field is being deprecated in favor of score. Please
|
||||||
# favor of score. Please refer to our documentation at
|
# refer to our documentation at https://cloud.google.com/natural-language/docs
|
||||||
# https://cloud.google.com/natural-language/docs for more information.
|
# for more information.
|
||||||
# Corresponds to the JSON property `polarity`
|
# Corresponds to the JSON property `polarity`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :polarity
|
attr_accessor :polarity
|
||||||
|
|
||||||
# Sentiment score between -1.0 (negative sentiment) and 1.0
|
# Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
|
||||||
# (positive sentiment).
|
|
||||||
# Corresponds to the JSON property `score`
|
# Corresponds to the JSON property `score`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :score
|
attr_accessor :score
|
||||||
|
|
@ -620,12 +608,12 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# The `Status` type defines a logical error model that is suitable for
|
# The `Status` type defines a logical error model that is suitable for different
|
||||||
# different programming environments, including REST APIs and RPC APIs. It is
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
||||||
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
||||||
# three pieces of data: error code, error message, and error details.
|
# data: error code, error message, and error details. You can find out more
|
||||||
# You can find out more about this error model and how to work with it in the
|
# about this error model and how to work with it in the [API Design Guide](https:
|
||||||
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
# //cloud.google.com/apis/design/errors).
|
||||||
class Status
|
class Status
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -634,15 +622,15 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :code
|
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.
|
# message types for APIs to use.
|
||||||
# Corresponds to the JSON property `details`
|
# Corresponds to the JSON property `details`
|
||||||
# @return [Array<Hash<String,Object>>]
|
# @return [Array<Hash<String,Object>>]
|
||||||
attr_accessor :details
|
attr_accessor :details
|
||||||
|
|
||||||
# A developer-facing error message, which should be in English. Any
|
# A developer-facing error message, which should be in English. Any user-facing
|
||||||
# user-facing error message should be localized and sent in the
|
# error message should be localized and sent in the google.rpc.Status.details
|
||||||
# google.rpc.Status.details field, or localized by the client.
|
# field, or localized by the client.
|
||||||
# Corresponds to the JSON property `message`
|
# Corresponds to the JSON property `message`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :message
|
attr_accessor :message
|
||||||
|
|
|
||||||
|
|
@ -50,8 +50,8 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Finds named entities (currently proper names and common nouns) in the text
|
# Finds named entities (currently proper names and common nouns) in the text
|
||||||
# along with entity types, salience, mentions for each entity, and
|
# along with entity types, salience, mentions for each entity, and other
|
||||||
# other properties.
|
# properties.
|
||||||
# @param [Google::Apis::LanguageV1beta1::AnalyzeEntitiesRequest] analyze_entities_request_object
|
# @param [Google::Apis::LanguageV1beta1::AnalyzeEntitiesRequest] analyze_entities_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,7 @@ module Google
|
||||||
# @see https://cloud.google.com/natural-language/
|
# @see https://cloud.google.com/natural-language/
|
||||||
module LanguageV1beta2
|
module LanguageV1beta2
|
||||||
VERSION = 'V1beta2'
|
VERSION = 'V1beta2'
|
||||||
REVISION = '20200406'
|
REVISION = '20200801'
|
||||||
|
|
||||||
# Apply machine learning models to reveal the structure and meaning of text
|
# Apply machine learning models to reveal the structure and meaning of text
|
||||||
AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language'
|
AUTH_CLOUD_LANGUAGE = 'https://www.googleapis.com/auth/cloud-language'
|
||||||
|
|
|
||||||
|
|
@ -26,8 +26,8 @@ module Google
|
||||||
class AnalyzeEntitiesRequest
|
class AnalyzeEntitiesRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1beta2::Document]
|
# @return [Google::Apis::LanguageV1beta2::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -57,9 +57,9 @@ module Google
|
||||||
# @return [Array<Google::Apis::LanguageV1beta2::Entity>]
|
# @return [Array<Google::Apis::LanguageV1beta2::Entity>]
|
||||||
attr_accessor :entities
|
attr_accessor :entities
|
||||||
|
|
||||||
# The language of the text, which will be the same as the language specified
|
# The language of the text, which will be the same as the language specified in
|
||||||
# in the request or, if not specified, the automatically-detected language.
|
# the request or, if not specified, the automatically-detected language. See
|
||||||
# See Document.language field for more details.
|
# Document.language field for more details.
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
@ -79,8 +79,8 @@ module Google
|
||||||
class AnalyzeEntitySentimentRequest
|
class AnalyzeEntitySentimentRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1beta2::Document]
|
# @return [Google::Apis::LanguageV1beta2::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -110,9 +110,9 @@ module Google
|
||||||
# @return [Array<Google::Apis::LanguageV1beta2::Entity>]
|
# @return [Array<Google::Apis::LanguageV1beta2::Entity>]
|
||||||
attr_accessor :entities
|
attr_accessor :entities
|
||||||
|
|
||||||
# The language of the text, which will be the same as the language specified
|
# The language of the text, which will be the same as the language specified in
|
||||||
# in the request or, if not specified, the automatically-detected language.
|
# the request or, if not specified, the automatically-detected language. See
|
||||||
# See Document.language field for more details.
|
# Document.language field for more details.
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
@ -132,8 +132,8 @@ module Google
|
||||||
class AnalyzeSentimentRequest
|
class AnalyzeSentimentRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1beta2::Document]
|
# @return [Google::Apis::LanguageV1beta2::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -159,16 +159,15 @@ module Google
|
||||||
class AnalyzeSentimentResponse
|
class AnalyzeSentimentResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
# Next ID: 6
|
# Next ID: 6
|
||||||
# Corresponds to the JSON property `documentSentiment`
|
# Corresponds to the JSON property `documentSentiment`
|
||||||
# @return [Google::Apis::LanguageV1beta2::Sentiment]
|
# @return [Google::Apis::LanguageV1beta2::Sentiment]
|
||||||
attr_accessor :document_sentiment
|
attr_accessor :document_sentiment
|
||||||
|
|
||||||
# The language of the text, which will be the same as the language specified
|
# The language of the text, which will be the same as the language specified in
|
||||||
# in the request or, if not specified, the automatically-detected language.
|
# the request or, if not specified, the automatically-detected language. See
|
||||||
# See Document.language field for more details.
|
# Document.language field for more details.
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
@ -194,8 +193,8 @@ module Google
|
||||||
class AnalyzeSyntaxRequest
|
class AnalyzeSyntaxRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1beta2::Document]
|
# @return [Google::Apis::LanguageV1beta2::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -220,9 +219,9 @@ module Google
|
||||||
class AnalyzeSyntaxResponse
|
class AnalyzeSyntaxResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The language of the text, which will be the same as the language specified
|
# The language of the text, which will be the same as the language specified in
|
||||||
# in the request or, if not specified, the automatically-detected language.
|
# the request or, if not specified, the automatically-detected language. See
|
||||||
# See Document.language field for more details.
|
# Document.language field for more details.
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
@ -254,8 +253,8 @@ module Google
|
||||||
class AnnotateTextRequest
|
class AnnotateTextRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1beta2::Document]
|
# @return [Google::Apis::LanguageV1beta2::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -265,9 +264,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :encoding_type
|
attr_accessor :encoding_type
|
||||||
|
|
||||||
# All available features for sentiment, syntax, and semantic analysis.
|
# All available features for sentiment, syntax, and semantic analysis. Setting
|
||||||
# Setting each one to true will enable that specific analysis for the input.
|
# each one to true will enable that specific analysis for the input. Next ID: 10
|
||||||
# Next ID: 10
|
|
||||||
# Corresponds to the JSON property `features`
|
# Corresponds to the JSON property `features`
|
||||||
# @return [Google::Apis::LanguageV1beta2::Features]
|
# @return [Google::Apis::LanguageV1beta2::Features]
|
||||||
attr_accessor :features
|
attr_accessor :features
|
||||||
|
|
@ -293,23 +291,21 @@ module Google
|
||||||
# @return [Array<Google::Apis::LanguageV1beta2::ClassificationCategory>]
|
# @return [Array<Google::Apis::LanguageV1beta2::ClassificationCategory>]
|
||||||
attr_accessor :categories
|
attr_accessor :categories
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
# Next ID: 6
|
# Next ID: 6
|
||||||
# Corresponds to the JSON property `documentSentiment`
|
# Corresponds to the JSON property `documentSentiment`
|
||||||
# @return [Google::Apis::LanguageV1beta2::Sentiment]
|
# @return [Google::Apis::LanguageV1beta2::Sentiment]
|
||||||
attr_accessor :document_sentiment
|
attr_accessor :document_sentiment
|
||||||
|
|
||||||
# Entities, along with their semantic information, in the input document.
|
# Entities, along with their semantic information, in the input document.
|
||||||
# Populated if the user enables
|
# Populated if the user enables AnnotateTextRequest.Features.extract_entities.
|
||||||
# AnnotateTextRequest.Features.extract_entities.
|
|
||||||
# Corresponds to the JSON property `entities`
|
# Corresponds to the JSON property `entities`
|
||||||
# @return [Array<Google::Apis::LanguageV1beta2::Entity>]
|
# @return [Array<Google::Apis::LanguageV1beta2::Entity>]
|
||||||
attr_accessor :entities
|
attr_accessor :entities
|
||||||
|
|
||||||
# The language of the text, which will be the same as the language specified
|
# The language of the text, which will be the same as the language specified in
|
||||||
# in the request or, if not specified, the automatically-detected language.
|
# the request or, if not specified, the automatically-detected language. See
|
||||||
# See Document.language field for more details.
|
# Document.language field for more details.
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
@ -321,8 +317,7 @@ module Google
|
||||||
attr_accessor :sentences
|
attr_accessor :sentences
|
||||||
|
|
||||||
# Tokens, along with their syntactic information, in the input document.
|
# Tokens, along with their syntactic information, in the input document.
|
||||||
# Populated if the user enables
|
# Populated if the user enables AnnotateTextRequest.Features.extract_syntax.
|
||||||
# AnnotateTextRequest.Features.extract_syntax.
|
|
||||||
# Corresponds to the JSON property `tokens`
|
# Corresponds to the JSON property `tokens`
|
||||||
# @return [Array<Google::Apis::LanguageV1beta2::Token>]
|
# @return [Array<Google::Apis::LanguageV1beta2::Token>]
|
||||||
attr_accessor :tokens
|
attr_accessor :tokens
|
||||||
|
|
@ -346,8 +341,8 @@ module Google
|
||||||
class ClassificationCategory
|
class ClassificationCategory
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The classifier's confidence of the category. Number represents how certain
|
# The classifier's confidence of the category. Number represents how certain the
|
||||||
# the classifier is that this category represents the given text.
|
# classifier is that this category represents the given text.
|
||||||
# Corresponds to the JSON property `confidence`
|
# Corresponds to the JSON property `confidence`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :confidence
|
attr_accessor :confidence
|
||||||
|
|
@ -373,8 +368,8 @@ module Google
|
||||||
class ClassifyTextRequest
|
class ClassifyTextRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
# Corresponds to the JSON property `document`
|
# Corresponds to the JSON property `document`
|
||||||
# @return [Google::Apis::LanguageV1beta2::Document]
|
# @return [Google::Apis::LanguageV1beta2::Document]
|
||||||
attr_accessor :document
|
attr_accessor :document
|
||||||
|
|
@ -412,11 +407,10 @@ module Google
|
||||||
class DependencyEdge
|
class DependencyEdge
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Represents the head of this token in the dependency tree.
|
# Represents the head of this token in the dependency tree. This is the index of
|
||||||
# This is the index of the token which has an arc going to this token.
|
# the token which has an arc going to this token. The index is the position of
|
||||||
# The index is the position of the token in the array of tokens returned
|
# the token in the array of tokens returned by the API method. If this token is
|
||||||
# by the API method. If this token is a root token, then the
|
# a root token, then the `head_token_index` is its own index.
|
||||||
# `head_token_index` is its own index.
|
|
||||||
# Corresponds to the JSON property `headTokenIndex`
|
# Corresponds to the JSON property `headTokenIndex`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :head_token_index
|
attr_accessor :head_token_index
|
||||||
|
|
@ -437,52 +431,50 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# ################################################################ #
|
# ################################################################ # Represents
|
||||||
# Represents the input to API methods.
|
# the input to API methods.
|
||||||
class Document
|
class Document
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Indicates how detected boilerplate(e.g. advertisements, copyright
|
# Indicates how detected boilerplate(e.g. advertisements, copyright declarations,
|
||||||
# declarations, banners) should be handled for this document. If not
|
# banners) should be handled for this document. If not specified, boilerplate
|
||||||
# specified, boilerplate will be treated the same as content.
|
# will be treated the same as content.
|
||||||
# Corresponds to the JSON property `boilerplateHandling`
|
# Corresponds to the JSON property `boilerplateHandling`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :boilerplate_handling
|
attr_accessor :boilerplate_handling
|
||||||
|
|
||||||
# The content of the input in string format.
|
# The content of the input in string format. Cloud audit logging exempt since it
|
||||||
# Cloud audit logging exempt since it is based on user data.
|
# is based on user data.
|
||||||
# Corresponds to the JSON property `content`
|
# Corresponds to the JSON property `content`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :content
|
attr_accessor :content
|
||||||
|
|
||||||
# The Google Cloud Storage URI where the file content is located.
|
# The Google Cloud Storage URI where the file content is located. This URI must
|
||||||
# This URI must be of the form: gs://bucket_name/object_name. For more
|
# be of the form: gs://bucket_name/object_name. For more details, see https://
|
||||||
# details, see https://cloud.google.com/storage/docs/reference-uris.
|
# cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object
|
||||||
# NOTE: Cloud Storage object versioning is not supported.
|
# versioning is not supported.
|
||||||
# Corresponds to the JSON property `gcsContentUri`
|
# Corresponds to the JSON property `gcsContentUri`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :gcs_content_uri
|
attr_accessor :gcs_content_uri
|
||||||
|
|
||||||
# The language of the document (if not specified, the language is
|
# The language of the document (if not specified, the language is automatically
|
||||||
# automatically detected). Both ISO and BCP-47 language codes are
|
# detected). Both ISO and BCP-47 language codes are accepted. [Language Support](
|
||||||
# accepted.<br>
|
# https://cloud.google.com/natural-language/docs/languages) lists currently
|
||||||
# [Language
|
# supported languages for each API method. If the language (either specified by
|
||||||
# Support](https://cloud.google.com/natural-language/docs/languages) lists
|
# the caller or automatically detected) is not supported by the called API
|
||||||
# currently supported languages for each API method. If the language (either
|
# method, an `INVALID_ARGUMENT` error is returned.
|
||||||
# specified by the caller or automatically detected) is not supported by the
|
|
||||||
# called API method, an `INVALID_ARGUMENT` error is returned.
|
|
||||||
# Corresponds to the JSON property `language`
|
# Corresponds to the JSON property `language`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language
|
attr_accessor :language
|
||||||
|
|
||||||
# The web URI where the document comes from. This URI is not used for
|
# The web URI where the document comes from. This URI is not used for fetching
|
||||||
# fetching the content, but as a hint for analyzing the document.
|
# the content, but as a hint for analyzing the document.
|
||||||
# Corresponds to the JSON property `referenceWebUri`
|
# Corresponds to the JSON property `referenceWebUri`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :reference_web_uri
|
attr_accessor :reference_web_uri
|
||||||
|
|
||||||
# Required. If the type is not set or is `TYPE_UNSPECIFIED`,
|
# Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `
|
||||||
# returns an `INVALID_ARGUMENT` error.
|
# INVALID_ARGUMENT` error.
|
||||||
# Corresponds to the JSON property `type`
|
# Corresponds to the JSON property `type`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :type
|
attr_accessor :type
|
||||||
|
|
@ -502,22 +494,22 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Represents a phrase in the text that is a known entity, such as
|
# Represents a phrase in the text that is a known entity, such as a person, an
|
||||||
# a person, an organization, or location. The API associates information, such
|
# organization, or location. The API associates information, such as salience
|
||||||
# as salience and mentions, with entities.
|
# and mentions, with entities.
|
||||||
class Entity
|
class Entity
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The mentions of this entity in the input document. The API currently
|
# The mentions of this entity in the input document. The API currently supports
|
||||||
# supports proper noun mentions.
|
# proper noun mentions.
|
||||||
# Corresponds to the JSON property `mentions`
|
# Corresponds to the JSON property `mentions`
|
||||||
# @return [Array<Google::Apis::LanguageV1beta2::EntityMention>]
|
# @return [Array<Google::Apis::LanguageV1beta2::EntityMention>]
|
||||||
attr_accessor :mentions
|
attr_accessor :mentions
|
||||||
|
|
||||||
# Metadata associated with the entity.
|
# Metadata associated with the entity. For most entity types, the metadata is a
|
||||||
# For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)
|
# Wikipedia URL (`wikipedia_url`) and Knowledge Graph MID (`mid`), if they are
|
||||||
# and Knowledge Graph MID (`mid`), if they are available. For the metadata
|
# available. For the metadata associated with other entity types, see the Type
|
||||||
# associated with other entity types, see the Type table below.
|
# table below.
|
||||||
# Corresponds to the JSON property `metadata`
|
# Corresponds to the JSON property `metadata`
|
||||||
# @return [Hash<String,String>]
|
# @return [Hash<String,String>]
|
||||||
attr_accessor :metadata
|
attr_accessor :metadata
|
||||||
|
|
@ -527,17 +519,15 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# The salience score associated with the entity in the [0, 1.0] range.
|
# The salience score associated with the entity in the [0, 1.0] range. The
|
||||||
# The salience score for an entity provides information about the
|
# salience score for an entity provides information about the importance or
|
||||||
# importance or centrality of that entity to the entire document text.
|
# centrality of that entity to the entire document text. Scores closer to 0 are
|
||||||
# Scores closer to 0 are less salient, while scores closer to 1.0 are highly
|
# less salient, while scores closer to 1.0 are highly salient.
|
||||||
# salient.
|
|
||||||
# Corresponds to the JSON property `salience`
|
# Corresponds to the JSON property `salience`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :salience
|
attr_accessor :salience
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
# Next ID: 6
|
# Next ID: 6
|
||||||
# Corresponds to the JSON property `sentiment`
|
# Corresponds to the JSON property `sentiment`
|
||||||
# @return [Google::Apis::LanguageV1beta2::Sentiment]
|
# @return [Google::Apis::LanguageV1beta2::Sentiment]
|
||||||
|
|
@ -568,8 +558,7 @@ module Google
|
||||||
class EntityMention
|
class EntityMention
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
# Next ID: 6
|
# Next ID: 6
|
||||||
# Corresponds to the JSON property `sentiment`
|
# Corresponds to the JSON property `sentiment`
|
||||||
# @return [Google::Apis::LanguageV1beta2::Sentiment]
|
# @return [Google::Apis::LanguageV1beta2::Sentiment]
|
||||||
|
|
@ -597,16 +586,14 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# All available features for sentiment, syntax, and semantic analysis.
|
# All available features for sentiment, syntax, and semantic analysis. Setting
|
||||||
# Setting each one to true will enable that specific analysis for the input.
|
# each one to true will enable that specific analysis for the input. Next ID: 10
|
||||||
# Next ID: 10
|
|
||||||
class Features
|
class Features
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Classify the full document into categories. If this is true,
|
# Classify the full document into categories. If this is true, the API will use
|
||||||
# the API will use the default model which classifies into a
|
# the default model which classifies into a [predefined taxonomy](https://cloud.
|
||||||
# [predefined
|
# google.com/natural-language/docs/categories).
|
||||||
# taxonomy](https://cloud.google.com/natural-language/docs/categories).
|
|
||||||
# Corresponds to the JSON property `classifyText`
|
# Corresponds to the JSON property `classifyText`
|
||||||
# @return [Boolean]
|
# @return [Boolean]
|
||||||
attr_accessor :classify_text
|
attr_accessor :classify_text
|
||||||
|
|
@ -739,8 +726,7 @@ module Google
|
||||||
class Sentence
|
class Sentence
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
# Next ID: 6
|
# Next ID: 6
|
||||||
# Corresponds to the JSON property `sentiment`
|
# Corresponds to the JSON property `sentiment`
|
||||||
# @return [Google::Apis::LanguageV1beta2::Sentiment]
|
# @return [Google::Apis::LanguageV1beta2::Sentiment]
|
||||||
|
|
@ -762,21 +748,18 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Represents the feeling associated with the entire text or entities in
|
# Represents the feeling associated with the entire text or entities in the text.
|
||||||
# the text.
|
|
||||||
# Next ID: 6
|
# Next ID: 6
|
||||||
class Sentiment
|
class Sentiment
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# A non-negative number in the [0, +inf) range, which represents
|
# A non-negative number in the [0, +inf) range, which represents the absolute
|
||||||
# the absolute magnitude of sentiment regardless of score (positive or
|
# magnitude of sentiment regardless of score (positive or negative).
|
||||||
# negative).
|
|
||||||
# Corresponds to the JSON property `magnitude`
|
# Corresponds to the JSON property `magnitude`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :magnitude
|
attr_accessor :magnitude
|
||||||
|
|
||||||
# Sentiment score between -1.0 (negative sentiment) and 1.0
|
# Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment).
|
||||||
# (positive sentiment).
|
|
||||||
# Corresponds to the JSON property `score`
|
# Corresponds to the JSON property `score`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :score
|
attr_accessor :score
|
||||||
|
|
@ -792,12 +775,12 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# The `Status` type defines a logical error model that is suitable for
|
# The `Status` type defines a logical error model that is suitable for different
|
||||||
# different programming environments, including REST APIs and RPC APIs. It is
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
||||||
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
||||||
# three pieces of data: error code, error message, and error details.
|
# data: error code, error message, and error details. You can find out more
|
||||||
# You can find out more about this error model and how to work with it in the
|
# about this error model and how to work with it in the [API Design Guide](https:
|
||||||
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
# //cloud.google.com/apis/design/errors).
|
||||||
class Status
|
class Status
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -806,15 +789,15 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :code
|
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.
|
# message types for APIs to use.
|
||||||
# Corresponds to the JSON property `details`
|
# Corresponds to the JSON property `details`
|
||||||
# @return [Array<Hash<String,Object>>]
|
# @return [Array<Hash<String,Object>>]
|
||||||
attr_accessor :details
|
attr_accessor :details
|
||||||
|
|
||||||
# A developer-facing error message, which should be in English. Any
|
# A developer-facing error message, which should be in English. Any user-facing
|
||||||
# user-facing error message should be localized and sent in the
|
# error message should be localized and sent in the google.rpc.Status.details
|
||||||
# google.rpc.Status.details field, or localized by the client.
|
# field, or localized by the client.
|
||||||
# Corresponds to the JSON property `message`
|
# Corresponds to the JSON property `message`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :message
|
attr_accessor :message
|
||||||
|
|
|
||||||
|
|
@ -50,8 +50,8 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Finds named entities (currently proper names and common nouns) in the text
|
# Finds named entities (currently proper names and common nouns) in the text
|
||||||
# along with entity types, salience, mentions for each entity, and
|
# along with entity types, salience, mentions for each entity, and other
|
||||||
# other properties.
|
# properties.
|
||||||
# @param [Google::Apis::LanguageV1beta2::AnalyzeEntitiesRequest] analyze_entities_request_object
|
# @param [Google::Apis::LanguageV1beta2::AnalyzeEntitiesRequest] analyze_entities_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -81,8 +81,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Finds entities, similar to AnalyzeEntities in the text and analyzes
|
# Finds entities, similar to AnalyzeEntities in the text and analyzes sentiment
|
||||||
# sentiment associated with each entity and its mentions.
|
# associated with each entity and its mentions.
|
||||||
# @param [Google::Apis::LanguageV1beta2::AnalyzeEntitySentimentRequest] analyze_entity_sentiment_request_object
|
# @param [Google::Apis::LanguageV1beta2::AnalyzeEntitySentimentRequest] analyze_entity_sentiment_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ module Google
|
||||||
# @see https://cloud.google.com/docs/quota
|
# @see https://cloud.google.com/docs/quota
|
||||||
module LibraryagentV1
|
module LibraryagentV1
|
||||||
VERSION = 'V1'
|
VERSION = 'V1'
|
||||||
REVISION = '20200215'
|
REVISION = '20200801'
|
||||||
|
|
||||||
# View and manage your data across Google Cloud Platform services
|
# View and manage your data across Google Cloud Platform services
|
||||||
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||||
|
|
|
||||||
|
|
@ -31,9 +31,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :author
|
attr_accessor :author
|
||||||
|
|
||||||
# The resource name of the book.
|
# The resource name of the book. Book names have the form `shelves/`shelf_id`/
|
||||||
# Book names have the form `shelves/`shelf_id`/books/`book_id``.
|
# books/`book_id``. The name is ignored when creating a book.
|
||||||
# The name is ignored when creating a book.
|
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
@ -71,11 +70,9 @@ module Google
|
||||||
# @return [Array<Google::Apis::LibraryagentV1::GoogleExampleLibraryagentV1Book>]
|
# @return [Array<Google::Apis::LibraryagentV1::GoogleExampleLibraryagentV1Book>]
|
||||||
attr_accessor :books
|
attr_accessor :books
|
||||||
|
|
||||||
# A token to retrieve next page of results.
|
# A token to retrieve next page of results. Pass this value in the
|
||||||
# Pass this value in the
|
# ListBooksRequest.page_token field in the subsequent call to `ListBooks` method
|
||||||
# ListBooksRequest.page_token
|
# to retrieve the next page of results.
|
||||||
# field in the subsequent call to `ListBooks` method to retrieve the next
|
|
||||||
# page of results.
|
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -95,11 +92,9 @@ module Google
|
||||||
class GoogleExampleLibraryagentV1ListShelvesResponse
|
class GoogleExampleLibraryagentV1ListShelvesResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# A token to retrieve next page of results.
|
# A token to retrieve next page of results. Pass this value in the
|
||||||
# Pass this value in the
|
# ListShelvesRequest.page_token field in the subsequent call to `ListShelves`
|
||||||
# ListShelvesRequest.page_token
|
# method to retrieve the next page of results.
|
||||||
# field in the subsequent call to `ListShelves` method to retrieve the next
|
|
||||||
# page of results.
|
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -124,9 +119,8 @@ module Google
|
||||||
class GoogleExampleLibraryagentV1Shelf
|
class GoogleExampleLibraryagentV1Shelf
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Output only. The resource name of the shelf.
|
# Output only. The resource name of the shelf. Shelf names have the form `
|
||||||
# Shelf names have the form `shelves/`shelf_id``.
|
# shelves/`shelf_id``. The name is ignored when creating a shelf.
|
||||||
# The name is ignored when creating a shelf.
|
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
|
||||||
|
|
@ -80,13 +80,12 @@ module Google
|
||||||
# Lists shelves. The order is unspecified but deterministic. Newly created
|
# Lists shelves. The order is unspecified but deterministic. Newly created
|
||||||
# shelves will not necessarily be added to the end of this list.
|
# shelves will not necessarily be added to the end of this list.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# Requested page size. Server may return fewer shelves than requested.
|
# Requested page size. Server may return fewer shelves than requested. If
|
||||||
# If unspecified, server will pick an appropriate default.
|
# unspecified, server will pick an appropriate default.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A token identifying a page of results the server should return.
|
# A token identifying a page of results the server should return. Typically,
|
||||||
# Typically, this is the value of
|
# this is the value of ListShelvesResponse.next_page_token returned from the
|
||||||
# ListShelvesResponse.next_page_token
|
# previous call to `ListShelves` method.
|
||||||
# returned from the previous call to `ListShelves` method.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -179,18 +178,17 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists books in a shelf. The order is unspecified but deterministic. Newly
|
# Lists books in a shelf. The order is unspecified but deterministic. Newly
|
||||||
# created books will not necessarily be added to the end of this list.
|
# created books will not necessarily be added to the end of this list. Returns
|
||||||
# Returns NOT_FOUND if the shelf does not exist.
|
# NOT_FOUND if the shelf does not exist.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the shelf whose books we'd like to list.
|
# Required. The name of the shelf whose books we'd like to list.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# Requested page size. Server may return fewer books than requested.
|
# Requested page size. Server may return fewer books than requested. If
|
||||||
# If unspecified, server will pick an appropriate default.
|
# unspecified, server will pick an appropriate default.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A token identifying a page of results the server should return.
|
# A token identifying a page of results the server should return. Typically,
|
||||||
# Typically, this is the value of
|
# this is the value of ListBooksResponse.next_page_token. returned from the
|
||||||
# ListBooksResponse.next_page_token.
|
# previous call to `ListBooks` method.
|
||||||
# returned from the previous call to `ListBooks` method.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -221,8 +219,7 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Return a book to the library. Returns the book if it is returned to the
|
# Return a book to the library. Returns the book if it is returned to the
|
||||||
# library successfully.
|
# library successfully. Returns error if the book does not belong to the library
|
||||||
# Returns error if the book does not belong to the library
|
|
||||||
# or the users didn't borrow before.
|
# or the users didn't borrow before.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The name of the book to return.
|
# Required. The name of the book to return.
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ module Google
|
||||||
# @see https://cloud.google.com/managed-microsoft-ad/
|
# @see https://cloud.google.com/managed-microsoft-ad/
|
||||||
module ManagedidentitiesV1
|
module ManagedidentitiesV1
|
||||||
VERSION = 'V1'
|
VERSION = 'V1'
|
||||||
REVISION = '20200622'
|
REVISION = '20200727'
|
||||||
|
|
||||||
# View and manage your data across Google Cloud Platform services
|
# View and manage your data across Google Cloud Platform services
|
||||||
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -84,8 +84,7 @@ module Google
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# The standard list filter.
|
# The standard list filter.
|
||||||
# @param [Boolean] include_unrevealed_locations
|
# @param [Boolean] include_unrevealed_locations
|
||||||
# If true, the returned list will include locations which are not yet
|
# If true, the returned list will include locations which are not yet revealed.
|
||||||
# revealed.
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The standard list page size.
|
# The standard list page size.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
|
|
@ -123,8 +122,8 @@ module Google
|
||||||
|
|
||||||
# Adds an AD trust to a domain.
|
# Adds an AD trust to a domain.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The resource domain name, project name and location using the form:
|
# Required. The resource domain name, project name and location using the form: `
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# projects/`project_id`/locations/global/domains/`domain_name``
|
||||||
# @param [Google::Apis::ManagedidentitiesV1::AttachTrustRequest] attach_trust_request_object
|
# @param [Google::Apis::ManagedidentitiesV1::AttachTrustRequest] attach_trust_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -157,21 +156,17 @@ module Google
|
||||||
|
|
||||||
# Creates a Microsoft AD domain.
|
# Creates a Microsoft AD domain.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The resource project name and location using the form:
|
# Required. The resource project name and location using the form: `projects/`
|
||||||
# `projects/`project_id`/locations/global`
|
# project_id`/locations/global`
|
||||||
# @param [Google::Apis::ManagedidentitiesV1::Domain] domain_object
|
# @param [Google::Apis::ManagedidentitiesV1::Domain] domain_object
|
||||||
# @param [String] domain_name
|
# @param [String] domain_name
|
||||||
# Required. The fully qualified domain name.
|
# Required. The fully qualified domain name. e.g. mydomain.myorganization.com,
|
||||||
# e.g. mydomain.myorganization.com, with the following restrictions:
|
# with the following restrictions: * Must contain only lowercase letters,
|
||||||
# * Must contain only lowercase letters, numbers, periods and hyphens.
|
# numbers, periods and hyphens. * Must start with a letter. * Must contain
|
||||||
# * Must start with a letter.
|
# between 2-64 characters. * Must end with a number or a letter. * Must not
|
||||||
# * Must contain between 2-64 characters.
|
# start with period. * First segement length (mydomain form example above)
|
||||||
# * Must end with a number or a letter.
|
# shouldn't exceed 15 chars. * The last segment cannot be fully numeric. * Must
|
||||||
# * Must not start with period.
|
# be unique within the customer project.
|
||||||
# * First segement length (mydomain form example above) shouldn't exceed
|
|
||||||
# 15 chars.
|
|
||||||
# * The last segment cannot be fully numeric.
|
|
||||||
# * Must be unique within the customer project.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -204,8 +199,8 @@ module Google
|
||||||
|
|
||||||
# Deletes a domain.
|
# Deletes a domain.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The domain resource name using the form:
|
# Required. The domain resource name using the form: `projects/`project_id`/
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# locations/global/domains/`domain_name``
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -269,8 +264,8 @@ module Google
|
||||||
|
|
||||||
# Gets information about a domain.
|
# Gets information about a domain.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The domain resource name using the form:
|
# Required. The domain resource name using the form: `projects/`project_id`/
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# locations/global/domains/`domain_name``
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -298,22 +293,19 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the access control policy for a resource.
|
# Gets the access control policy for a resource. Returns an empty policy if the
|
||||||
# Returns an empty policy if the resource exists and does not have a policy
|
# resource exists and does not have a policy set.
|
||||||
# set.
|
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy is being requested.
|
# REQUIRED: The resource for which the policy is being requested. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Fixnum] options_requested_policy_version
|
# @param [Fixnum] options_requested_policy_version
|
||||||
# Optional. The policy format version to be returned.
|
# Optional. The policy format version to be returned. Valid values are 0, 1, and
|
||||||
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
|
# 3. Requests specifying an invalid value will be rejected. Requests for
|
||||||
# rejected.
|
# policies with any conditional bindings must specify version 3. Policies
|
||||||
# Requests for policies with any conditional bindings must specify version 3.
|
# without any conditional bindings may specify any valid value or leave the
|
||||||
# Policies without any conditional bindings may specify any valid value or
|
# field unset. To learn which resources support conditions in their IAM policies,
|
||||||
# leave the field unset.
|
# see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
|
||||||
# To learn which resources support conditions in their IAM policies, see the
|
# resource-policies).
|
||||||
# [IAM
|
|
||||||
# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -344,27 +336,22 @@ module Google
|
||||||
|
|
||||||
# Lists domains in a project.
|
# Lists domains in a project.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The resource name of the domain location using the form:
|
# Required. The resource name of the domain location using the form: `projects/`
|
||||||
# `projects/`project_id`/locations/global`
|
# project_id`/locations/global`
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# Optional. A filter specifying constraints of a list operation.
|
# Optional. A filter specifying constraints of a list operation. For example, `
|
||||||
# For example, `Domain.fqdn="mydomain.myorginization"`.
|
# Domain.fqdn="mydomain.myorginization"`.
|
||||||
# @param [String] order_by
|
# @param [String] order_by
|
||||||
# Optional. Specifies the ordering of results. See
|
# Optional. Specifies the ordering of results. See [Sorting order](https://cloud.
|
||||||
# [Sorting
|
# google.com/apis/design/design_patterns#sorting_order) for more information.
|
||||||
# order](https://cloud.google.com/apis/design/design_patterns#sorting_order)
|
|
||||||
# for more information.
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# Optional. The maximum number of items to return.
|
# Optional. The maximum number of items to return. If not specified, a default
|
||||||
# If not specified, a default value of 1000 will be used.
|
# value of 1000 will be used. Regardless of the page_size value, the response
|
||||||
# Regardless of the page_size value, the response may include a partial list.
|
# may include a partial list. Callers should rely on a response's
|
||||||
# Callers should rely on a response's
|
# next_page_token to determine if there are additional results to list.
|
||||||
# next_page_token
|
|
||||||
# to determine if there are additional results to list.
|
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# Optional. The `next_page_token` value returned from a previous
|
# Optional. The `next_page_token` value returned from a previous
|
||||||
# ListDomainsRequest
|
# ListDomainsRequest request, if any.
|
||||||
# request, if any.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -398,16 +385,13 @@ module Google
|
||||||
|
|
||||||
# Updates the metadata and configuration of a domain.
|
# Updates the metadata and configuration of a domain.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The unique name of the domain using the form:
|
# Required. The unique name of the domain using the form: `projects/`project_id`/
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``.
|
# locations/global/domains/`domain_name``.
|
||||||
# @param [Google::Apis::ManagedidentitiesV1::Domain] domain_object
|
# @param [Google::Apis::ManagedidentitiesV1::Domain] domain_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# Required. Mask of fields to update. At least one path must be supplied in this
|
# Required. Mask of fields to update. At least one path must be supplied in this
|
||||||
# field. The elements of the repeated paths field may only include
|
# field. The elements of the repeated paths field may only include fields from
|
||||||
# fields from Domain:
|
# Domain: * `labels` * `locations` * `authorized_networks`
|
||||||
# * `labels`
|
|
||||||
# * `locations`
|
|
||||||
# * `authorized_networks`
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -440,8 +424,8 @@ module Google
|
||||||
|
|
||||||
# Updates the DNS conditional forwarder.
|
# Updates the DNS conditional forwarder.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The resource domain name, project name and location using the form:
|
# Required. The resource domain name, project name and location using the form: `
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# projects/`project_id`/locations/global/domains/`domain_name``
|
||||||
# @param [Google::Apis::ManagedidentitiesV1::ReconfigureTrustRequest] reconfigure_trust_request_object
|
# @param [Google::Apis::ManagedidentitiesV1::ReconfigureTrustRequest] reconfigure_trust_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -474,8 +458,8 @@ module Google
|
||||||
|
|
||||||
# Resets a domain's administrator password.
|
# Resets a domain's administrator password.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The domain resource name using the form:
|
# Required. The domain resource name using the form: `projects/`project_id`/
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# locations/global/domains/`domain_name``
|
||||||
# @param [Google::Apis::ManagedidentitiesV1::ResetAdminPasswordRequest] reset_admin_password_request_object
|
# @param [Google::Apis::ManagedidentitiesV1::ResetAdminPasswordRequest] reset_admin_password_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -507,11 +491,11 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Sets the access control policy on the specified resource. Replaces any
|
# Sets the access control policy on the specified resource. Replaces any
|
||||||
# existing policy.
|
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
|
||||||
# Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
|
# PERMISSION_DENIED` errors.
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy is being specified.
|
# REQUIRED: The resource for which the policy is being specified. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Google::Apis::ManagedidentitiesV1::SetIamPolicyRequest] set_iam_policy_request_object
|
# @param [Google::Apis::ManagedidentitiesV1::SetIamPolicyRequest] set_iam_policy_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -542,15 +526,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Returns permissions that a caller has on the specified resource.
|
# Returns permissions that a caller has on the specified resource. If the
|
||||||
# If the resource does not exist, this will return an empty set of
|
# resource does not exist, this will return an empty set of permissions, not a `
|
||||||
# permissions, not a `NOT_FOUND` error.
|
# NOT_FOUND` error. Note: This operation is designed to be used for building
|
||||||
# Note: This operation is designed to be used for building permission-aware
|
# permission-aware UIs and command-line tools, not for authorization checking.
|
||||||
# UIs and command-line tools, not for authorization checking. This operation
|
# This operation may "fail open" without warning.
|
||||||
# may "fail open" without warning.
|
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy detail is being requested.
|
# REQUIRED: The resource for which the policy detail is being requested. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Google::Apis::ManagedidentitiesV1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
# @param [Google::Apis::ManagedidentitiesV1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -616,15 +599,13 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Starts asynchronous cancellation on a long-running operation. The server
|
# Starts asynchronous cancellation on a long-running operation. The server makes
|
||||||
# makes a best effort to cancel the operation, but success is not
|
# a best effort to cancel the operation, but success is not guaranteed. If the
|
||||||
# guaranteed. If the server doesn't support this method, it returns
|
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
# Clients can use Operations.GetOperation or other methods to check whether the
|
||||||
# Operations.GetOperation or
|
# cancellation succeeded or whether the operation completed despite cancellation.
|
||||||
# other methods to check whether the cancellation succeeded or whether the
|
# On successful cancellation, the operation is not deleted; instead, it becomes
|
||||||
# operation completed despite cancellation. On successful cancellation,
|
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
||||||
# 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`.
|
# corresponding to `Code.CANCELLED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be cancelled.
|
# The name of the operation resource to be cancelled.
|
||||||
|
|
@ -658,10 +639,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Deletes a long-running operation. This method indicates that the client is
|
# Deletes a long-running operation. This method indicates that the client is no
|
||||||
# no longer interested in the operation result. It does not cancel the
|
# longer interested in the operation result. It does not cancel the operation.
|
||||||
# operation. If the server doesn't support this method, it returns
|
# If the server doesn't support this method, it returns `google.rpc.Code.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`.
|
# UNIMPLEMENTED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be deleted.
|
# The name of the operation resource to be deleted.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -691,9 +672,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the latest state of a long-running operation. Clients can use this
|
# Gets the latest state of a long-running operation. Clients can use this method
|
||||||
# method to poll the operation result at intervals as recommended by the API
|
# to poll the operation result at intervals as recommended by the API service.
|
||||||
# service.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource.
|
# The name of the operation resource.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -723,15 +703,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists operations that match the specified filter in the request. If the
|
# Lists operations that match the specified filter in the request. If the server
|
||||||
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
||||||
# NOTE: the `name` binding allows API services to override the binding
|
# binding allows API services to override the binding to use different resource
|
||||||
# to use different resource name schemes, such as `users/*/operations`. To
|
# name schemes, such as `users/*/operations`. To override the binding, API
|
||||||
# override the binding, API services can add a binding such as
|
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
||||||
# `"/v1/`name=users/*`/operations"` to their service configuration.
|
# service configuration. For backwards compatibility, the default name includes
|
||||||
# For backwards compatibility, the default name includes the operations
|
# the operations collection id, however overriding users must ensure the name
|
||||||
# collection id, however overriding users must ensure the name binding
|
# binding is the parent resource, without the operations collection id.
|
||||||
# is the parent resource, without the operations collection id.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation's parent resource.
|
# The name of the operation's parent resource.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ module Google
|
||||||
# @see https://cloud.google.com/managed-microsoft-ad/
|
# @see https://cloud.google.com/managed-microsoft-ad/
|
||||||
module ManagedidentitiesV1alpha1
|
module ManagedidentitiesV1alpha1
|
||||||
VERSION = 'V1alpha1'
|
VERSION = 'V1alpha1'
|
||||||
REVISION = '20200622'
|
REVISION = '20200727'
|
||||||
|
|
||||||
# View and manage your data across Google Cloud Platform services
|
# View and manage your data across Google Cloud Platform services
|
||||||
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -84,8 +84,7 @@ module Google
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# The standard list filter.
|
# The standard list filter.
|
||||||
# @param [Boolean] include_unrevealed_locations
|
# @param [Boolean] include_unrevealed_locations
|
||||||
# If true, the returned list will include locations which are not yet
|
# If true, the returned list will include locations which are not yet revealed.
|
||||||
# revealed.
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The standard list page size.
|
# The standard list page size.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
|
|
@ -121,11 +120,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Adds AD trust in a given domain.
|
# Adds AD trust in a given domain. Operation
|
||||||
# Operation<response: google.protobuf.Empty>
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The resource domain name, project name and location using the form:
|
# The resource domain name, project name and location using the form: `projects/`
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# project_id`/locations/global/domains/`domain_name``
|
||||||
# @param [Google::Apis::ManagedidentitiesV1alpha1::AttachTrustRequest] attach_trust_request_object
|
# @param [Google::Apis::ManagedidentitiesV1alpha1::AttachTrustRequest] attach_trust_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -156,24 +154,19 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Creates a Microsoft AD Domain in a given project.
|
# Creates a Microsoft AD Domain in a given project. Operation
|
||||||
# Operation<response: google.protobuf.Empty>
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Resource project name and location using the form:
|
# Resource project name and location using the form: `projects/`project_id`/
|
||||||
# `projects/`project_id`/locations/global`
|
# locations/global`
|
||||||
# @param [Google::Apis::ManagedidentitiesV1alpha1::Domain] domain_object
|
# @param [Google::Apis::ManagedidentitiesV1alpha1::Domain] domain_object
|
||||||
# @param [String] domain_name
|
# @param [String] domain_name
|
||||||
# The fully qualified domain name.
|
# The fully qualified domain name. e.g. mydomain.myorganization.com, with the
|
||||||
# e.g. mydomain.myorganization.com, with the following restrictions:
|
# following restrictions: * Must contain only lowercase letters, numbers,
|
||||||
# * Must contain only lowercase letters, numbers, periods and hyphens.
|
# periods and hyphens. * Must start with a letter. * Must contain between 2-64
|
||||||
# * Must start with a letter.
|
# characters. * Must end with a number or a letter. * Must not start with period.
|
||||||
# * Must contain between 2-64 characters.
|
# * Must be unique within the project. * First segement length (mydomain form
|
||||||
# * Must end with a number or a letter.
|
# example above) shouldn't exceed 15 chars. * The last segment cannot be fully
|
||||||
# * Must not start with period.
|
# numeric.
|
||||||
# * Must be unique within the project.
|
|
||||||
# * First segement length (mydomain form example above) shouldn't exceed
|
|
||||||
# 15 chars.
|
|
||||||
# * The last segment cannot be fully numeric.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -204,11 +197,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Deletes identified domain.
|
# Deletes identified domain. Operation
|
||||||
# Operation<response: google.protobuf.Empty>
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Domain resource name using the form:
|
# Domain resource name using the form: `projects/`project_id`/locations/global/
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# domains/`domain_name``
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -236,11 +228,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Removes identified trust.
|
# Removes identified trust. Operation
|
||||||
# Operation<response: google.protobuf.Empty>
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The resource domain name, project name, and location using the form:
|
# The resource domain name, project name, and location using the form: `projects/
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# `project_id`/locations/global/domains/`domain_name``
|
||||||
# @param [Google::Apis::ManagedidentitiesV1alpha1::DetachTrustRequest] detach_trust_request_object
|
# @param [Google::Apis::ManagedidentitiesV1alpha1::DetachTrustRequest] detach_trust_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -273,8 +264,8 @@ module Google
|
||||||
|
|
||||||
# Gets details of a single Domain.
|
# Gets details of a single Domain.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Domain resource name using the form:
|
# Domain resource name using the form: `projects/`project_id`/locations/global/
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# domains/`domain_name``
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -302,22 +293,19 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the access control policy for a resource.
|
# Gets the access control policy for a resource. Returns an empty policy if the
|
||||||
# Returns an empty policy if the resource exists and does not have a policy
|
# resource exists and does not have a policy set.
|
||||||
# set.
|
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy is being requested.
|
# REQUIRED: The resource for which the policy is being requested. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Fixnum] options_requested_policy_version
|
# @param [Fixnum] options_requested_policy_version
|
||||||
# Optional. The policy format version to be returned.
|
# Optional. The policy format version to be returned. Valid values are 0, 1, and
|
||||||
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
|
# 3. Requests specifying an invalid value will be rejected. Requests for
|
||||||
# rejected.
|
# policies with any conditional bindings must specify version 3. Policies
|
||||||
# Requests for policies with any conditional bindings must specify version 3.
|
# without any conditional bindings may specify any valid value or leave the
|
||||||
# Policies without any conditional bindings may specify any valid value or
|
# field unset. To learn which resources support conditions in their IAM policies,
|
||||||
# leave the field unset.
|
# see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
|
||||||
# To learn which resources support conditions in their IAM policies, see the
|
# resource-policies).
|
||||||
# [IAM
|
|
||||||
# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -348,20 +336,19 @@ module Google
|
||||||
|
|
||||||
# Lists Domains in a given project.
|
# Lists Domains in a given project.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The resource name of the domain location using the form:
|
# Required. The resource name of the domain location using the form: `projects/`
|
||||||
# `projects/`project_id`/locations/global`
|
# project_id`/locations/global`
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# Optional. Filter specifying constraints of a list operation.
|
# Optional. Filter specifying constraints of a list operation. For example, `
|
||||||
# For example, `Domain.fqdn="mydomain.myorginization"`.
|
# Domain.fqdn="mydomain.myorginization"`.
|
||||||
# @param [String] order_by
|
# @param [String] order_by
|
||||||
# Optional. Specifies the ordering of results following syntax at
|
# Optional. Specifies the ordering of results following syntax at https://cloud.
|
||||||
# https://cloud.google.com/apis/design/design_patterns#sorting_order.
|
# google.com/apis/design/design_patterns#sorting_order.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# If not specified, a default value of 1000 will be used by the service.
|
# 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
|
# Regardless of the page_size value, the response may include a partial list and
|
||||||
# and a caller should only rely on response's
|
# a caller should only rely on response's next_page_token to determine if there
|
||||||
# next_page_token
|
# are more instances left to be queried.
|
||||||
# to determine if there are more instances left to be queried.
|
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The next_page_token value returned from a previous List request, if any.
|
# The next_page_token value returned from a previous List request, if any.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -395,20 +382,16 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Updates the metadata and configuration of a specified domain.
|
# Updates the metadata and configuration of a specified domain. Operation
|
||||||
# Operation<response: google.protobuf.Empty>
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Output only. Unique name of the domain in this scope including projects and
|
# Output only. Unique name of the domain in this scope including projects and
|
||||||
# location using the form:
|
# location using the form: `projects/`project_id`/locations/global/domains/`
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``.
|
# domain_name``.
|
||||||
# @param [Google::Apis::ManagedidentitiesV1alpha1::Domain] domain_object
|
# @param [Google::Apis::ManagedidentitiesV1alpha1::Domain] domain_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# Mask of fields to update. At least one path must be supplied in this
|
# Mask of fields to update. At least one path must be supplied in this field.
|
||||||
# field. The elements of the repeated paths field may only include these
|
# The elements of the repeated paths field may only include these fields from
|
||||||
# fields from Domain:
|
# Domain: * `labels` * `locations` * `authorized_networks`
|
||||||
# * `labels`
|
|
||||||
# * `locations`
|
|
||||||
# * `authorized_networks`
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -439,11 +422,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Updates the dns conditional forwarder.
|
# Updates the dns conditional forwarder. Operation
|
||||||
# Operation<response: google.protobuf.Empty>
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The resource domain name, project name and location using the form:
|
# The resource domain name, project name and location using the form: `projects/`
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# project_id`/locations/global/domains/`domain_name``
|
||||||
# @param [Google::Apis::ManagedidentitiesV1alpha1::ReconfigureTrustRequest] reconfigure_trust_request_object
|
# @param [Google::Apis::ManagedidentitiesV1alpha1::ReconfigureTrustRequest] reconfigure_trust_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -477,8 +459,8 @@ module Google
|
||||||
# Resets managed identities admin password identified by
|
# Resets managed identities admin password identified by
|
||||||
# managed_identities_admin_name
|
# managed_identities_admin_name
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The domain resource name using the form:
|
# The domain resource name using the form: `projects/`project_id`/locations/
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# global/domains/`domain_name``
|
||||||
# @param [Google::Apis::ManagedidentitiesV1alpha1::ResetAdminPasswordRequest] reset_admin_password_request_object
|
# @param [Google::Apis::ManagedidentitiesV1alpha1::ResetAdminPasswordRequest] reset_admin_password_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -510,11 +492,11 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Sets the access control policy on the specified resource. Replaces any
|
# Sets the access control policy on the specified resource. Replaces any
|
||||||
# existing policy.
|
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
|
||||||
# Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
|
# PERMISSION_DENIED` errors.
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy is being specified.
|
# REQUIRED: The resource for which the policy is being specified. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Google::Apis::ManagedidentitiesV1alpha1::SetIamPolicyRequest] set_iam_policy_request_object
|
# @param [Google::Apis::ManagedidentitiesV1alpha1::SetIamPolicyRequest] set_iam_policy_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -545,15 +527,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Returns permissions that a caller has on the specified resource.
|
# Returns permissions that a caller has on the specified resource. If the
|
||||||
# If the resource does not exist, this will return an empty set of
|
# resource does not exist, this will return an empty set of permissions, not a `
|
||||||
# permissions, not a `NOT_FOUND` error.
|
# NOT_FOUND` error. Note: This operation is designed to be used for building
|
||||||
# Note: This operation is designed to be used for building permission-aware
|
# permission-aware UIs and command-line tools, not for authorization checking.
|
||||||
# UIs and command-line tools, not for authorization checking. This operation
|
# This operation may "fail open" without warning.
|
||||||
# may "fail open" without warning.
|
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy detail is being requested.
|
# REQUIRED: The resource for which the policy detail is being requested. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Google::Apis::ManagedidentitiesV1alpha1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
# @param [Google::Apis::ManagedidentitiesV1alpha1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -584,11 +565,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Validate the trust state
|
# Validate the trust state Operation
|
||||||
# Operation<response: google.protobuf.Empty>
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The resource domain name, project name, and location using the form:
|
# The resource domain name, project name, and location using the form: `projects/
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# `project_id`/locations/global/domains/`domain_name``
|
||||||
# @param [Google::Apis::ManagedidentitiesV1alpha1::ValidateTrustRequest] validate_trust_request_object
|
# @param [Google::Apis::ManagedidentitiesV1alpha1::ValidateTrustRequest] validate_trust_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -619,15 +599,13 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Starts asynchronous cancellation on a long-running operation. The server
|
# Starts asynchronous cancellation on a long-running operation. The server makes
|
||||||
# makes a best effort to cancel the operation, but success is not
|
# a best effort to cancel the operation, but success is not guaranteed. If the
|
||||||
# guaranteed. If the server doesn't support this method, it returns
|
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
# Clients can use Operations.GetOperation or other methods to check whether the
|
||||||
# Operations.GetOperation or
|
# cancellation succeeded or whether the operation completed despite cancellation.
|
||||||
# other methods to check whether the cancellation succeeded or whether the
|
# On successful cancellation, the operation is not deleted; instead, it becomes
|
||||||
# operation completed despite cancellation. On successful cancellation,
|
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
||||||
# 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`.
|
# corresponding to `Code.CANCELLED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be cancelled.
|
# The name of the operation resource to be cancelled.
|
||||||
|
|
@ -661,10 +639,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Deletes a long-running operation. This method indicates that the client is
|
# Deletes a long-running operation. This method indicates that the client is no
|
||||||
# no longer interested in the operation result. It does not cancel the
|
# longer interested in the operation result. It does not cancel the operation.
|
||||||
# operation. If the server doesn't support this method, it returns
|
# If the server doesn't support this method, it returns `google.rpc.Code.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`.
|
# UNIMPLEMENTED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be deleted.
|
# The name of the operation resource to be deleted.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -694,9 +672,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the latest state of a long-running operation. Clients can use this
|
# Gets the latest state of a long-running operation. Clients can use this method
|
||||||
# method to poll the operation result at intervals as recommended by the API
|
# to poll the operation result at intervals as recommended by the API service.
|
||||||
# service.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource.
|
# The name of the operation resource.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -726,15 +703,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists operations that match the specified filter in the request. If the
|
# Lists operations that match the specified filter in the request. If the server
|
||||||
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
||||||
# NOTE: the `name` binding allows API services to override the binding
|
# binding allows API services to override the binding to use different resource
|
||||||
# to use different resource name schemes, such as `users/*/operations`. To
|
# name schemes, such as `users/*/operations`. To override the binding, API
|
||||||
# override the binding, API services can add a binding such as
|
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
||||||
# `"/v1/`name=users/*`/operations"` to their service configuration.
|
# service configuration. For backwards compatibility, the default name includes
|
||||||
# For backwards compatibility, the default name includes the operations
|
# the operations collection id, however overriding users must ensure the name
|
||||||
# collection id, however overriding users must ensure the name binding
|
# binding is the parent resource, without the operations collection id.
|
||||||
# is the parent resource, without the operations collection id.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation's parent resource.
|
# The name of the operation's parent resource.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ module Google
|
||||||
# @see https://cloud.google.com/managed-microsoft-ad/
|
# @see https://cloud.google.com/managed-microsoft-ad/
|
||||||
module ManagedidentitiesV1beta1
|
module ManagedidentitiesV1beta1
|
||||||
VERSION = 'V1beta1'
|
VERSION = 'V1beta1'
|
||||||
REVISION = '20200622'
|
REVISION = '20200727'
|
||||||
|
|
||||||
# View and manage your data across Google Cloud Platform services
|
# View and manage your data across Google Cloud Platform services
|
||||||
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -84,8 +84,7 @@ module Google
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# The standard list filter.
|
# The standard list filter.
|
||||||
# @param [Boolean] include_unrevealed_locations
|
# @param [Boolean] include_unrevealed_locations
|
||||||
# If true, the returned list will include locations which are not yet
|
# If true, the returned list will include locations which are not yet revealed.
|
||||||
# revealed.
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The standard list page size.
|
# The standard list page size.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
|
|
@ -123,8 +122,8 @@ module Google
|
||||||
|
|
||||||
# Adds an AD trust to a domain.
|
# Adds an AD trust to a domain.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The resource domain name, project name and location using the form:
|
# Required. The resource domain name, project name and location using the form: `
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# projects/`project_id`/locations/global/domains/`domain_name``
|
||||||
# @param [Google::Apis::ManagedidentitiesV1beta1::AttachTrustRequest] attach_trust_request_object
|
# @param [Google::Apis::ManagedidentitiesV1beta1::AttachTrustRequest] attach_trust_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -157,21 +156,17 @@ module Google
|
||||||
|
|
||||||
# Creates a Microsoft AD domain.
|
# Creates a Microsoft AD domain.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The resource project name and location using the form:
|
# Required. The resource project name and location using the form: `projects/`
|
||||||
# `projects/`project_id`/locations/global`
|
# project_id`/locations/global`
|
||||||
# @param [Google::Apis::ManagedidentitiesV1beta1::Domain] domain_object
|
# @param [Google::Apis::ManagedidentitiesV1beta1::Domain] domain_object
|
||||||
# @param [String] domain_name
|
# @param [String] domain_name
|
||||||
# Required. A domain name, e.g. mydomain.myorg.com, with the following
|
# Required. A domain name, e.g. mydomain.myorg.com, with the following
|
||||||
# restrictions:
|
# restrictions: * Must contain only lowercase letters, numbers, periods and
|
||||||
# * Must contain only lowercase letters, numbers, periods and hyphens.
|
# hyphens. * Must start with a letter. * Must contain between 2-64 characters. *
|
||||||
# * Must start with a letter.
|
# Must end with a number or a letter. * Must not start with period. * First
|
||||||
# * Must contain between 2-64 characters.
|
# segement length (mydomain form example above) shouldn't exceed 15 chars. * The
|
||||||
# * Must end with a number or a letter.
|
# last segment cannot be fully numeric. * Must be unique within the customer
|
||||||
# * Must not start with period.
|
# project.
|
||||||
# * First segement length (mydomain form example above) shouldn't exceed
|
|
||||||
# 15 chars.
|
|
||||||
# * The last segment cannot be fully numeric.
|
|
||||||
# * Must be unique within the customer project.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -204,8 +199,8 @@ module Google
|
||||||
|
|
||||||
# Deletes a domain.
|
# Deletes a domain.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The domain resource name using the form:
|
# Required. The domain resource name using the form: `projects/`project_id`/
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# locations/global/domains/`domain_name``
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -269,8 +264,8 @@ module Google
|
||||||
|
|
||||||
# Gets information about a domain.
|
# Gets information about a domain.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The domain resource name using the form:
|
# Required. The domain resource name using the form: `projects/`project_id`/
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# locations/global/domains/`domain_name``
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -298,22 +293,19 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the access control policy for a resource.
|
# Gets the access control policy for a resource. Returns an empty policy if the
|
||||||
# Returns an empty policy if the resource exists and does not have a policy
|
# resource exists and does not have a policy set.
|
||||||
# set.
|
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy is being requested.
|
# REQUIRED: The resource for which the policy is being requested. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Fixnum] options_requested_policy_version
|
# @param [Fixnum] options_requested_policy_version
|
||||||
# Optional. The policy format version to be returned.
|
# Optional. The policy format version to be returned. Valid values are 0, 1, and
|
||||||
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
|
# 3. Requests specifying an invalid value will be rejected. Requests for
|
||||||
# rejected.
|
# policies with any conditional bindings must specify version 3. Policies
|
||||||
# Requests for policies with any conditional bindings must specify version 3.
|
# without any conditional bindings may specify any valid value or leave the
|
||||||
# Policies without any conditional bindings may specify any valid value or
|
# field unset. To learn which resources support conditions in their IAM policies,
|
||||||
# leave the field unset.
|
# see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
|
||||||
# To learn which resources support conditions in their IAM policies, see the
|
# resource-policies).
|
||||||
# [IAM
|
|
||||||
# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -344,23 +336,19 @@ module Google
|
||||||
|
|
||||||
# Lists domains in a project.
|
# Lists domains in a project.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The resource name of the domain location using the form:
|
# Required. The resource name of the domain location using the form: `projects/`
|
||||||
# `projects/`project_id`/locations/global`
|
# project_id`/locations/global`
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# Optional. A filter specifying constraints of a list operation.
|
# Optional. A filter specifying constraints of a list operation. For example, `
|
||||||
# For example, `Domain.fqdn="mydomain.myorginization"`.
|
# Domain.fqdn="mydomain.myorginization"`.
|
||||||
# @param [String] order_by
|
# @param [String] order_by
|
||||||
# Optional. Specifies the ordering of results. See
|
# Optional. Specifies the ordering of results. See [Sorting order](https://cloud.
|
||||||
# [Sorting
|
# google.com/apis/design/design_patterns#sorting_order) for more information.
|
||||||
# order](https://cloud.google.com/apis/design/design_patterns#sorting_order)
|
|
||||||
# for more information.
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# Optional. The maximum number of items to return.
|
# Optional. The maximum number of items to return. If not specified, a default
|
||||||
# If not specified, a default value of 1000 will be used.
|
# value of 1000 will be used. Regardless of the page_size value, the response
|
||||||
# Regardless of the page_size value, the response may include a partial list.
|
# may include a partial list. Callers should rely on a response's
|
||||||
# Callers should rely on a response's
|
# next_page_token to determine if there are additional results to list.
|
||||||
# next_page_token
|
|
||||||
# to determine if there are additional results to list.
|
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The `next_page_token` value returned from a previous ListDomainsRequest
|
# The `next_page_token` value returned from a previous ListDomainsRequest
|
||||||
# request, if any.
|
# request, if any.
|
||||||
|
|
@ -397,16 +385,13 @@ module Google
|
||||||
|
|
||||||
# Updates the metadata and configuration of a domain.
|
# Updates the metadata and configuration of a domain.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Output only. The unique name of the domain using the form:
|
# Output only. The unique name of the domain using the form: `projects/`
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``.
|
# project_id`/locations/global/domains/`domain_name``.
|
||||||
# @param [Google::Apis::ManagedidentitiesV1beta1::Domain] domain_object
|
# @param [Google::Apis::ManagedidentitiesV1beta1::Domain] domain_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# Required. Mask of fields to update. At least one path must be supplied in this
|
# Required. Mask of fields to update. At least one path must be supplied in this
|
||||||
# field. The elements of the repeated paths field may only include
|
# field. The elements of the repeated paths field may only include fields from
|
||||||
# fields from Domain:
|
# Domain: * `labels` * `locations` * `authorized_networks`
|
||||||
# * `labels`
|
|
||||||
# * `locations`
|
|
||||||
# * `authorized_networks`
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -439,8 +424,8 @@ module Google
|
||||||
|
|
||||||
# Updates the DNS conditional forwarder.
|
# Updates the DNS conditional forwarder.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The resource domain name, project name and location using the form:
|
# Required. The resource domain name, project name and location using the form: `
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# projects/`project_id`/locations/global/domains/`domain_name``
|
||||||
# @param [Google::Apis::ManagedidentitiesV1beta1::ReconfigureTrustRequest] reconfigure_trust_request_object
|
# @param [Google::Apis::ManagedidentitiesV1beta1::ReconfigureTrustRequest] reconfigure_trust_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -473,8 +458,8 @@ module Google
|
||||||
|
|
||||||
# Resets a domain's administrator password.
|
# Resets a domain's administrator password.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The domain resource name using the form:
|
# Required. The domain resource name using the form: `projects/`project_id`/
|
||||||
# `projects/`project_id`/locations/global/domains/`domain_name``
|
# locations/global/domains/`domain_name``
|
||||||
# @param [Google::Apis::ManagedidentitiesV1beta1::ResetAdminPasswordRequest] reset_admin_password_request_object
|
# @param [Google::Apis::ManagedidentitiesV1beta1::ResetAdminPasswordRequest] reset_admin_password_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -506,11 +491,11 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Sets the access control policy on the specified resource. Replaces any
|
# Sets the access control policy on the specified resource. Replaces any
|
||||||
# existing policy.
|
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
|
||||||
# Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
|
# PERMISSION_DENIED` errors.
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy is being specified.
|
# REQUIRED: The resource for which the policy is being specified. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Google::Apis::ManagedidentitiesV1beta1::SetIamPolicyRequest] set_iam_policy_request_object
|
# @param [Google::Apis::ManagedidentitiesV1beta1::SetIamPolicyRequest] set_iam_policy_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -541,15 +526,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Returns permissions that a caller has on the specified resource.
|
# Returns permissions that a caller has on the specified resource. If the
|
||||||
# If the resource does not exist, this will return an empty set of
|
# resource does not exist, this will return an empty set of permissions, not a `
|
||||||
# permissions, not a `NOT_FOUND` error.
|
# NOT_FOUND` error. Note: This operation is designed to be used for building
|
||||||
# Note: This operation is designed to be used for building permission-aware
|
# permission-aware UIs and command-line tools, not for authorization checking.
|
||||||
# UIs and command-line tools, not for authorization checking. This operation
|
# This operation may "fail open" without warning.
|
||||||
# may "fail open" without warning.
|
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy detail is being requested.
|
# REQUIRED: The resource for which the policy detail is being requested. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Google::Apis::ManagedidentitiesV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
# @param [Google::Apis::ManagedidentitiesV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -615,15 +599,13 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Starts asynchronous cancellation on a long-running operation. The server
|
# Starts asynchronous cancellation on a long-running operation. The server makes
|
||||||
# makes a best effort to cancel the operation, but success is not
|
# a best effort to cancel the operation, but success is not guaranteed. If the
|
||||||
# guaranteed. If the server doesn't support this method, it returns
|
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
# Clients can use Operations.GetOperation or other methods to check whether the
|
||||||
# Operations.GetOperation or
|
# cancellation succeeded or whether the operation completed despite cancellation.
|
||||||
# other methods to check whether the cancellation succeeded or whether the
|
# On successful cancellation, the operation is not deleted; instead, it becomes
|
||||||
# operation completed despite cancellation. On successful cancellation,
|
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
||||||
# 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`.
|
# corresponding to `Code.CANCELLED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be cancelled.
|
# The name of the operation resource to be cancelled.
|
||||||
|
|
@ -657,10 +639,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Deletes a long-running operation. This method indicates that the client is
|
# Deletes a long-running operation. This method indicates that the client is no
|
||||||
# no longer interested in the operation result. It does not cancel the
|
# longer interested in the operation result. It does not cancel the operation.
|
||||||
# operation. If the server doesn't support this method, it returns
|
# If the server doesn't support this method, it returns `google.rpc.Code.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`.
|
# UNIMPLEMENTED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be deleted.
|
# The name of the operation resource to be deleted.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -690,9 +672,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the latest state of a long-running operation. Clients can use this
|
# Gets the latest state of a long-running operation. Clients can use this method
|
||||||
# method to poll the operation result at intervals as recommended by the API
|
# to poll the operation result at intervals as recommended by the API service.
|
||||||
# service.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource.
|
# The name of the operation resource.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -722,15 +703,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists operations that match the specified filter in the request. If the
|
# Lists operations that match the specified filter in the request. If the server
|
||||||
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
||||||
# NOTE: the `name` binding allows API services to override the binding
|
# binding allows API services to override the binding to use different resource
|
||||||
# to use different resource name schemes, such as `users/*/operations`. To
|
# name schemes, such as `users/*/operations`. To override the binding, API
|
||||||
# override the binding, API services can add a binding such as
|
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
||||||
# `"/v1/`name=users/*`/operations"` to their service configuration.
|
# service configuration. For backwards compatibility, the default name includes
|
||||||
# For backwards compatibility, the default name includes the operations
|
# the operations collection id, however overriding users must ensure the name
|
||||||
# collection id, however overriding users must ensure the name binding
|
# binding is the parent resource, without the operations collection id.
|
||||||
# is the parent resource, without the operations collection id.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation's parent resource.
|
# The name of the operation's parent resource.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ module Google
|
||||||
# @see https://developers.google.com/android/work/play/custom-app-api/
|
# @see https://developers.google.com/android/work/play/custom-app-api/
|
||||||
module PlaycustomappV1
|
module PlaycustomappV1
|
||||||
VERSION = 'V1'
|
VERSION = 'V1'
|
||||||
REVISION = '20200611'
|
REVISION = '20200801'
|
||||||
|
|
||||||
# View and manage your Google Play Developer account
|
# View and manage your Google Play Developer account
|
||||||
AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher'
|
AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher'
|
||||||
|
|
|
||||||
|
|
@ -31,8 +31,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :language_code
|
attr_accessor :language_code
|
||||||
|
|
||||||
# Output only. Package name of the created Android app.
|
# Output only. Package name of the created Android app. Only present in the API
|
||||||
# Only present in the API response.
|
# response.
|
||||||
# Corresponds to the JSON property `packageName`
|
# Corresponds to the JSON property `packageName`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :package_name
|
attr_accessor :package_name
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ module Google
|
||||||
# @see https://developers.google.com/spectrum-access-system/
|
# @see https://developers.google.com/spectrum-access-system/
|
||||||
module ProdTtSasportalV1alpha1
|
module ProdTtSasportalV1alpha1
|
||||||
VERSION = 'V1alpha1'
|
VERSION = 'V1alpha1'
|
||||||
REVISION = '20200722'
|
REVISION = '20200801'
|
||||||
|
|
||||||
# View your email address
|
# View your email address
|
||||||
AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email'
|
AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email'
|
||||||
|
|
|
||||||
|
|
@ -26,12 +26,10 @@ module Google
|
||||||
class SasPortalAssignment
|
class SasPortalAssignment
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The identities the role is assigned to. It can have the following
|
# The identities the role is assigned to. It can have the following values: * ``
|
||||||
# values:
|
# user_email``: An email address that represents a specific Google account. For
|
||||||
# * ``user_email``: An email address that represents a specific
|
# example: `alice@gmail.com`. * ``group_email``: An email address that
|
||||||
# Google account. For example: `alice@gmail.com`.
|
# represents a Google group. For example, `viewers@gmail.com`.
|
||||||
# * ``group_email``: An email address that represents a Google
|
|
||||||
# group. For example, `viewers@gmail.com`.
|
|
||||||
# Corresponds to the JSON property `members`
|
# Corresponds to the JSON property `members`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :members
|
attr_accessor :members
|
||||||
|
|
@ -56,8 +54,8 @@ module Google
|
||||||
class SasPortalBulkCreateDeviceRequest
|
class SasPortalBulkCreateDeviceRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Required. A csv with each row representing a [device]. Each row must
|
# Required. A csv with each row representing a [device]. Each row must conform
|
||||||
# conform to the regulations described on CreateDeviceRequest's device field.
|
# to the regulations described on CreateDeviceRequest's device field.
|
||||||
# Corresponds to the JSON property `csv`
|
# Corresponds to the JSON property `csv`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :csv
|
attr_accessor :csv
|
||||||
|
|
@ -95,8 +93,8 @@ module Google
|
||||||
class SasPortalCreateSignedDeviceRequest
|
class SasPortalCreateSignedDeviceRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Required. JSON Web Token signed using a CPI private key. Payload
|
# Required. JSON Web Token signed using a CPI private key. Payload must be the
|
||||||
# must be the JSON encoding of the [Device]. The user_id field must be set.
|
# JSON encoding of the [Device]. The user_id field must be set.
|
||||||
# Corresponds to the JSON property `encodedDevice`
|
# Corresponds to the JSON property `encodedDevice`
|
||||||
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
||||||
# @return [String]
|
# @return [String]
|
||||||
|
|
@ -189,8 +187,7 @@ module Google
|
||||||
# @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDeviceConfig]
|
# @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDeviceConfig]
|
||||||
attr_accessor :preloaded_config
|
attr_accessor :preloaded_config
|
||||||
|
|
||||||
# A serial number assigned to the device by the device
|
# A serial number assigned to the device by the device manufacturer.
|
||||||
# manufacturer.
|
|
||||||
# Corresponds to the JSON property `serialNumber`
|
# Corresponds to the JSON property `serialNumber`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :serial_number
|
attr_accessor :serial_number
|
||||||
|
|
@ -230,8 +227,7 @@ module Google
|
||||||
|
|
||||||
# This field is related to the radioTechnology field and provides the air
|
# This field is related to the radioTechnology field and provides the air
|
||||||
# interface specification that the CBSD is compliant with at the time of
|
# interface specification that the CBSD is compliant with at the time of
|
||||||
# registration.
|
# registration. Optional
|
||||||
# Optional
|
|
||||||
# Corresponds to the JSON property `supportedSpec`
|
# Corresponds to the JSON property `supportedSpec`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :supported_spec
|
attr_accessor :supported_spec
|
||||||
|
|
@ -321,9 +317,9 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Device grant. It is an authorization provided by the Spectrum
|
# Device grant. It is an authorization provided by the Spectrum Access System to
|
||||||
# Access System to a device to transmit using specified operating
|
# a device to transmit using specified operating parameters after a successful
|
||||||
# parameters after a successful heartbeat by the device.
|
# heartbeat by the device.
|
||||||
class SasPortalDeviceGrant
|
class SasPortalDeviceGrant
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -342,10 +338,10 @@ module Google
|
||||||
# @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalFrequencyRange]
|
# @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalFrequencyRange]
|
||||||
attr_accessor :frequency_range
|
attr_accessor :frequency_range
|
||||||
|
|
||||||
# Maximum Equivalent Isotropically Radiated Power (EIRP) permitted
|
# Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant.
|
||||||
# by the grant. The maximum EIRP is in units of dBm/MHz. The
|
# The maximum EIRP is in units of dBm/MHz. The value of maxEirp represents the
|
||||||
# value of maxEirp represents the average (RMS) EIRP that would be
|
# average (RMS) EIRP that would be measured by the procedure defined in FCC part
|
||||||
# measured by the procedure defined in FCC part 96.41(e)(3).
|
# 96.41(e)(3).
|
||||||
# Corresponds to the JSON property `maxEirp`
|
# Corresponds to the JSON property `maxEirp`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :max_eirp
|
attr_accessor :max_eirp
|
||||||
|
|
@ -462,13 +458,11 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A generic empty message that you can re-use to avoid defining duplicated
|
# A generic empty message that you can re-use to avoid defining duplicated empty
|
||||||
# empty messages in your APIs. A typical example is to use it as the request
|
# messages in your APIs. A typical example is to use it as the request or the
|
||||||
# or the response type of an API method. For instance:
|
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
||||||
# service Foo `
|
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
||||||
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
# `Empty` is empty JSON object ````.
|
||||||
# `
|
|
||||||
# The JSON representation for `Empty` is empty JSON object ````.
|
|
||||||
class SasPortalEmpty
|
class SasPortalEmpty
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -506,8 +500,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Request for GenerateSecret method]
|
# Request for GenerateSecret method] [spectrum.sas.portal.v1alpha1.DeviceManager.
|
||||||
# [spectrum.sas.portal.v1alpha1.DeviceManager.GenerateSecret].
|
# GenerateSecret].
|
||||||
class SasPortalGenerateSecretRequest
|
class SasPortalGenerateSecretRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -524,8 +518,7 @@ module Google
|
||||||
class SasPortalGenerateSecretResponse
|
class SasPortalGenerateSecretResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The secret generated by the string and used by
|
# The secret generated by the string and used by [ValidateInstaller] method.
|
||||||
# [ValidateInstaller] method.
|
|
||||||
# Corresponds to the JSON property `secret`
|
# Corresponds to the JSON property `secret`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :secret
|
attr_accessor :secret
|
||||||
|
|
@ -563,41 +556,39 @@ module Google
|
||||||
class SasPortalInstallationParams
|
class SasPortalInstallationParams
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Boresight direction of the horizontal plane of the antenna in
|
# Boresight direction of the horizontal plane of the antenna in degrees with
|
||||||
# degrees with respect to true north. The value of this parameter
|
# respect to true north. The value of this parameter is an integer with a value
|
||||||
# is an integer with a value between 0 and 359 inclusive. A value
|
# between 0 and 359 inclusive. A value of 0 degrees means true north; a value of
|
||||||
# of 0 degrees means true north; a value of 90 degrees means
|
# 90 degrees means east. This parameter is optional for Category A devices and
|
||||||
# east. This parameter is optional for Category A devices and
|
|
||||||
# conditional for Category B devices.
|
# conditional for Category B devices.
|
||||||
# Corresponds to the JSON property `antennaAzimuth`
|
# Corresponds to the JSON property `antennaAzimuth`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :antenna_azimuth
|
attr_accessor :antenna_azimuth
|
||||||
|
|
||||||
# 3-dB antenna beamwidth of the antenna in the horizontal-plane in
|
# 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This
|
||||||
# degrees. This parameter is an unsigned integer having a value
|
# parameter is an unsigned integer having a value between 0 and 360 (degrees)
|
||||||
# between 0 and 360 (degrees) inclusive; it is optional for
|
# inclusive; it is optional for Category A devices and conditional for Category
|
||||||
# Category A devices and conditional for Category B devices.
|
# B devices.
|
||||||
# Corresponds to the JSON property `antennaBeamwidth`
|
# Corresponds to the JSON property `antennaBeamwidth`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :antenna_beamwidth
|
attr_accessor :antenna_beamwidth
|
||||||
|
|
||||||
# Antenna downtilt in degrees and is an integer with a value
|
# Antenna downtilt in degrees and is an integer with a value between -90 and +90
|
||||||
# between -90 and +90 inclusive; a negative value means the antenna
|
# inclusive; a negative value means the antenna is tilted up (above horizontal).
|
||||||
# is tilted up (above horizontal). This parameter is optional for
|
# This parameter is optional for Category A devices and conditional for Category
|
||||||
# Category A devices and conditional for Category B devices.
|
# B devices.
|
||||||
# Corresponds to the JSON property `antennaDowntilt`
|
# Corresponds to the JSON property `antennaDowntilt`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :antenna_downtilt
|
attr_accessor :antenna_downtilt
|
||||||
|
|
||||||
# Peak antenna gain in dBi. This parameter is an integer with a
|
# Peak antenna gain in dBi. This parameter is an integer with a value between -
|
||||||
# value between -127 and +128 (dBi) inclusive.
|
# 127 and +128 (dBi) inclusive.
|
||||||
# Corresponds to the JSON property `antennaGain`
|
# Corresponds to the JSON property `antennaGain`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :antenna_gain
|
attr_accessor :antenna_gain
|
||||||
|
|
||||||
# If an external antenna is used, the antenna model is optionally
|
# If an external antenna is used, the antenna model is optionally provided in
|
||||||
# provided in this field. The string has a maximum length of 128
|
# this field. The string has a maximum length of 128 octets.
|
||||||
# octets.
|
|
||||||
# Corresponds to the JSON property `antennaModel`
|
# Corresponds to the JSON property `antennaModel`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :antenna_model
|
attr_accessor :antenna_model
|
||||||
|
|
@ -608,18 +599,17 @@ module Google
|
||||||
attr_accessor :cpe_cbsd_indication
|
attr_accessor :cpe_cbsd_indication
|
||||||
alias_method :cpe_cbsd_indication?, :cpe_cbsd_indication
|
alias_method :cpe_cbsd_indication?, :cpe_cbsd_indication
|
||||||
|
|
||||||
# This parameter is the maximum device EIRP in units of dBm/10MHz
|
# This parameter is the maximum device EIRP in units of dBm/10MHz and is an
|
||||||
# and is an integer with a value between -127 and +47 (dBm/10 MHz)
|
# integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not
|
||||||
# inclusive. If not included, SAS interprets it as maximum
|
# included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz
|
||||||
# allowable EIRP in units of dBm/10MHz for device category.
|
# for device category.
|
||||||
# Corresponds to the JSON property `eirpCapability`
|
# Corresponds to the JSON property `eirpCapability`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :eirp_capability
|
attr_accessor :eirp_capability
|
||||||
|
|
||||||
# Device antenna height in meters. When the heightType parameter
|
# Device antenna height in meters. When the heightType parameter value is "AGL",
|
||||||
# value is "AGL", the antenna height should be given relative to
|
# the antenna height should be given relative to ground level. When the
|
||||||
# ground level. When the heightType parameter value is "AMSL", it
|
# heightType parameter value is "AMSL", it is given with respect to WGS84 datum.
|
||||||
# is given with respect to WGS84 datum.
|
|
||||||
# Corresponds to the JSON property `height`
|
# Corresponds to the JSON property `height`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :height
|
attr_accessor :height
|
||||||
|
|
@ -629,42 +619,37 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :height_type
|
attr_accessor :height_type
|
||||||
|
|
||||||
# A positive number in meters to indicate accuracy of the device
|
# A positive number in meters to indicate accuracy of the device antenna
|
||||||
# antenna horizontal location. This optional parameter should only
|
# horizontal location. This optional parameter should only be present if its
|
||||||
# be present if its value is less than the FCC requirement of 50
|
# value is less than the FCC requirement of 50 meters.
|
||||||
# meters.
|
|
||||||
# Corresponds to the JSON property `horizontalAccuracy`
|
# Corresponds to the JSON property `horizontalAccuracy`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :horizontal_accuracy
|
attr_accessor :horizontal_accuracy
|
||||||
|
|
||||||
# Whether the device antenna is indoor or not. True: indoor. False:
|
# Whether the device antenna is indoor or not. True: indoor. False: outdoor.
|
||||||
# outdoor.
|
|
||||||
# Corresponds to the JSON property `indoorDeployment`
|
# Corresponds to the JSON property `indoorDeployment`
|
||||||
# @return [Boolean]
|
# @return [Boolean]
|
||||||
attr_accessor :indoor_deployment
|
attr_accessor :indoor_deployment
|
||||||
alias_method :indoor_deployment?, :indoor_deployment
|
alias_method :indoor_deployment?, :indoor_deployment
|
||||||
|
|
||||||
# Latitude of the device antenna location in degrees relative to
|
# Latitude of the device antenna location in degrees relative to the WGS 84
|
||||||
# the WGS 84 datum. The allowed range is from -90.000000 to
|
# datum. The allowed range is from -90.000000 to +90.000000. Positive values
|
||||||
# +90.000000. Positive values represent latitudes north of the
|
# represent latitudes north of the equator; negative values south of the equator.
|
||||||
# equator; negative values south of the equator.
|
|
||||||
# Corresponds to the JSON property `latitude`
|
# Corresponds to the JSON property `latitude`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :latitude
|
attr_accessor :latitude
|
||||||
|
|
||||||
# Longitude of the device antenna location. in degrees relative to
|
# Longitude of the device antenna location. in degrees relative to the WGS 84
|
||||||
# the WGS 84 datum. The allowed range is from -180.000000 to
|
# datum. The allowed range is from -180.000000 to +180.000000. Positive values
|
||||||
# +180.000000. Positive values represent longitudes east of the
|
# represent longitudes east of the prime meridian; negative values west of the
|
||||||
# prime meridian; negative values west of the prime
|
# prime meridian.
|
||||||
# meridian.
|
|
||||||
# Corresponds to the JSON property `longitude`
|
# Corresponds to the JSON property `longitude`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :longitude
|
attr_accessor :longitude
|
||||||
|
|
||||||
# A positive number in meters to indicate accuracy of the device
|
# A positive number in meters to indicate accuracy of the device antenna
|
||||||
# antenna vertical location. This optional parameter should only be
|
# vertical location. This optional parameter should only be present if its value
|
||||||
# present if its value is less than the FCC requirement of 3
|
# is less than the FCC requirement of 3 meters.
|
||||||
# meters.
|
|
||||||
# Corresponds to the JSON property `verticalAccuracy`
|
# Corresponds to the JSON property `verticalAccuracy`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :vertical_accuracy
|
attr_accessor :vertical_accuracy
|
||||||
|
|
@ -696,16 +681,14 @@ module Google
|
||||||
class SasPortalListCustomersResponse
|
class SasPortalListCustomersResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The list of customers that
|
# The list of customers that match the request.
|
||||||
# match the request.
|
|
||||||
# Corresponds to the JSON property `customers`
|
# Corresponds to the JSON property `customers`
|
||||||
# @return [Array<Google::Apis::ProdTtSasportalV1alpha1::SasPortalCustomer>]
|
# @return [Array<Google::Apis::ProdTtSasportalV1alpha1::SasPortalCustomer>]
|
||||||
attr_accessor :customers
|
attr_accessor :customers
|
||||||
|
|
||||||
# A pagination token returned from a previous call to ListCustomers method that
|
# A pagination token returned from a previous call to ListCustomers method that
|
||||||
# indicates from
|
# indicates from where listing should continue. If the field is missing or empty,
|
||||||
# where listing should continue. If the field is missing or empty, it means
|
# it means there are no more customers.
|
||||||
# there are no more customers.
|
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -730,9 +713,9 @@ module Google
|
||||||
# @return [Array<Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice>]
|
# @return [Array<Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice>]
|
||||||
attr_accessor :devices
|
attr_accessor :devices
|
||||||
|
|
||||||
# A pagination token returned from a previous call to ListDevices method
|
# A pagination token returned from a previous call to ListDevices method that
|
||||||
# that indicates from where listing should continue. If the field
|
# indicates from where listing should continue. If the field is missing or empty,
|
||||||
# is missing or empty, it means there is no more devices.
|
# it means there is no more devices.
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -752,10 +735,9 @@ module Google
|
||||||
class SasPortalListNodesResponse
|
class SasPortalListNodesResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# A pagination token returned from a previous call to
|
# A pagination token returned from a previous call to ListNodes method that
|
||||||
# ListNodes method
|
# indicates from where listing should continue. If the field is missing or empty,
|
||||||
# that indicates from where listing should continue. If the field is missing
|
# it means there is no more nodes.
|
||||||
# or empty, it means there is no more nodes.
|
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -780,8 +762,8 @@ module Google
|
||||||
class SasPortalMoveDeviceRequest
|
class SasPortalMoveDeviceRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Required. The name of the new parent resource (Node or Customer) to
|
# Required. The name of the new parent resource (Node or Customer) to reparent
|
||||||
# reparent the device under.
|
# the device under.
|
||||||
# Corresponds to the JSON property `destination`
|
# Corresponds to the JSON property `destination`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :destination
|
attr_accessor :destination
|
||||||
|
|
@ -852,47 +834,45 @@ module Google
|
||||||
class SasPortalOperation
|
class SasPortalOperation
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# If the value is `false`, it means the operation is still in progress.
|
# If the value is `false`, it means the operation is still in progress. If `true`
|
||||||
# If `true`, the operation is completed, and either `error` or `response` is
|
# , the operation is completed, and either `error` or `response` is available.
|
||||||
# available.
|
|
||||||
# Corresponds to the JSON property `done`
|
# Corresponds to the JSON property `done`
|
||||||
# @return [Boolean]
|
# @return [Boolean]
|
||||||
attr_accessor :done
|
attr_accessor :done
|
||||||
alias_method :done?, :done
|
alias_method :done?, :done
|
||||||
|
|
||||||
# The `Status` type defines a logical error model that is suitable for
|
# The `Status` type defines a logical error model that is suitable for different
|
||||||
# different programming environments, including REST APIs and RPC APIs. It is
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
||||||
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
||||||
# three pieces of data: error code, error message, and error details.
|
# data: error code, error message, and error details. You can find out more
|
||||||
# You can find out more about this error model and how to work with it in the
|
# about this error model and how to work with it in the [API Design Guide](https:
|
||||||
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
# //cloud.google.com/apis/design/errors).
|
||||||
# Corresponds to the JSON property `error`
|
# Corresponds to the JSON property `error`
|
||||||
# @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalStatus]
|
# @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalStatus]
|
||||||
attr_accessor :error
|
attr_accessor :error
|
||||||
|
|
||||||
# Service-specific metadata associated with the operation. It typically
|
# Service-specific metadata associated with the operation. It typically contains
|
||||||
# contains progress information and common metadata such as create time.
|
# progress information and common metadata such as create time. Some services
|
||||||
# Some services might not provide such metadata. Any method that returns a
|
# might not provide such metadata. Any method that returns a long-running
|
||||||
# long-running operation should document the metadata type, if any.
|
# operation should document the metadata type, if any.
|
||||||
# Corresponds to the JSON property `metadata`
|
# Corresponds to the JSON property `metadata`
|
||||||
# @return [Hash<String,Object>]
|
# @return [Hash<String,Object>]
|
||||||
attr_accessor :metadata
|
attr_accessor :metadata
|
||||||
|
|
||||||
# The server-assigned name, which is only unique within the same service that
|
# The server-assigned name, which is only unique within the same service that
|
||||||
# originally returns it. If you use the default HTTP mapping, the
|
# originally returns it. If you use the default HTTP mapping, the `name` should
|
||||||
# `name` should be a resource name ending with `operations/`unique_id``.
|
# be a resource name ending with `operations/`unique_id``.
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# The normal response of the operation in case of success. If the original
|
# 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
|
# method returns no data on success, such as `Delete`, the response is `google.
|
||||||
# `google.protobuf.Empty`. If the original method is standard
|
# protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
|
||||||
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
# the response should be the resource. For other methods, the response should
|
||||||
# methods, the response should have the type `XxxResponse`, where `Xxx`
|
# have the type `XxxResponse`, where `Xxx` is the original method name. For
|
||||||
# is the original method name. For example, if the original method name
|
# example, if the original method name is `TakeSnapshot()`, the inferred
|
||||||
# is `TakeSnapshot()`, the inferred response type is
|
# response type is `TakeSnapshotResponse`.
|
||||||
# `TakeSnapshotResponse`.
|
|
||||||
# Corresponds to the JSON property `response`
|
# Corresponds to the JSON property `response`
|
||||||
# @return [Hash<String,Object>]
|
# @return [Hash<String,Object>]
|
||||||
attr_accessor :response
|
attr_accessor :response
|
||||||
|
|
@ -920,16 +900,14 @@ module Google
|
||||||
# @return [Array<Google::Apis::ProdTtSasportalV1alpha1::SasPortalAssignment>]
|
# @return [Array<Google::Apis::ProdTtSasportalV1alpha1::SasPortalAssignment>]
|
||||||
attr_accessor :assignments
|
attr_accessor :assignments
|
||||||
|
|
||||||
# The [etag] is used for optimistic concurrency control as a way to
|
# The [etag] is used for optimistic concurrency control as a way to help prevent
|
||||||
# help prevent simultaneous updates of a policy from overwriting
|
# simultaneous updates of a policy from overwriting each other. It is strongly
|
||||||
# each other. It is strongly suggested that systems make use of
|
# suggested that systems make use of the [etag] in the read-modify-write cycle
|
||||||
# the [etag] in the read-modify-write cycle to perform policy
|
# to perform policy updates in order to avoid race conditions: An [etag] is
|
||||||
# updates in order to avoid race conditions: An [etag] is returned
|
# returned in the response to [GetPolicy], and systems are expected to put that
|
||||||
# in the response to [GetPolicy], and systems are expected to put
|
# etag in the request to [SetPolicy] to ensure that their change will be applied
|
||||||
# that etag in the request to [SetPolicy] to ensure that their
|
# to the same version of the policy. If no [etag] is provided in the call to [
|
||||||
# change will be applied to the same version of the policy.
|
# SetPolicy], then the existing policy is overwritten blindly.
|
||||||
# If no [etag] is provided in the call to [SetPolicy], then the
|
|
||||||
# existing policy is overwritten blindly.
|
|
||||||
# Corresponds to the JSON property `etag`
|
# Corresponds to the JSON property `etag`
|
||||||
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
||||||
# @return [String]
|
# @return [String]
|
||||||
|
|
@ -976,9 +954,8 @@ module Google
|
||||||
class SasPortalSignDeviceRequest
|
class SasPortalSignDeviceRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Required. The device to sign.
|
# Required. The device to sign. The device fields name, fcc_id and serial_number
|
||||||
# The device fields name, fcc_id and serial_number must be set.
|
# must be set. The user_id field must be set.
|
||||||
# The user_id field must be set.
|
|
||||||
# Corresponds to the JSON property `device`
|
# Corresponds to the JSON property `device`
|
||||||
# @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice]
|
# @return [Google::Apis::ProdTtSasportalV1alpha1::SasPortalDevice]
|
||||||
attr_accessor :device
|
attr_accessor :device
|
||||||
|
|
@ -993,12 +970,12 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# The `Status` type defines a logical error model that is suitable for
|
# The `Status` type defines a logical error model that is suitable for different
|
||||||
# different programming environments, including REST APIs and RPC APIs. It is
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
||||||
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
||||||
# three pieces of data: error code, error message, and error details.
|
# data: error code, error message, and error details. You can find out more
|
||||||
# You can find out more about this error model and how to work with it in the
|
# about this error model and how to work with it in the [API Design Guide](https:
|
||||||
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
# //cloud.google.com/apis/design/errors).
|
||||||
class SasPortalStatus
|
class SasPortalStatus
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -1007,15 +984,15 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :code
|
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.
|
# message types for APIs to use.
|
||||||
# Corresponds to the JSON property `details`
|
# Corresponds to the JSON property `details`
|
||||||
# @return [Array<Hash<String,Object>>]
|
# @return [Array<Hash<String,Object>>]
|
||||||
attr_accessor :details
|
attr_accessor :details
|
||||||
|
|
||||||
# A developer-facing error message, which should be in English. Any
|
# A developer-facing error message, which should be in English. Any user-facing
|
||||||
# user-facing error message should be localized and sent in the
|
# error message should be localized and sent in the google.rpc.Status.details
|
||||||
# google.rpc.Status.details field, or localized by the client.
|
# field, or localized by the client.
|
||||||
# Corresponds to the JSON property `message`
|
# Corresponds to the JSON property `message`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :message
|
attr_accessor :message
|
||||||
|
|
@ -1080,9 +1057,8 @@ module Google
|
||||||
class SasPortalUpdateSignedDeviceRequest
|
class SasPortalUpdateSignedDeviceRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Required. The JSON Web Token signed using a CPI private key. Payload
|
# Required. The JSON Web Token signed using a CPI private key. Payload must be
|
||||||
# must be the JSON encoding
|
# the JSON encoding of the device. The user_id field must be set.
|
||||||
# of the device. The user_id field must be set.
|
|
||||||
# Corresponds to the JSON property `encodedDevice`
|
# Corresponds to the JSON property `encodedDevice`
|
||||||
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
||||||
# @return [String]
|
# @return [String]
|
||||||
|
|
@ -1109,14 +1085,14 @@ module Google
|
||||||
class SasPortalValidateInstallerRequest
|
class SasPortalValidateInstallerRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Required. JSON Web Token signed using a CPI private key. Payload
|
# Required. JSON Web Token signed using a CPI private key. Payload must include
|
||||||
# must include a "secret" claim whose value is the secret.
|
# a "secret" claim whose value is the secret.
|
||||||
# Corresponds to the JSON property `encodedSecret`
|
# Corresponds to the JSON property `encodedSecret`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :encoded_secret
|
attr_accessor :encoded_secret
|
||||||
|
|
||||||
# Required. Unique installer id (cpiId) from the Certified
|
# Required. Unique installer id (cpiId) from the Certified Professional
|
||||||
# Professional Installers database.
|
# Installers database.
|
||||||
# Corresponds to the JSON property `installerId`
|
# Corresponds to the JSON property `installerId`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :installer_id
|
attr_accessor :installer_id
|
||||||
|
|
@ -1138,8 +1114,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Response for ValidateInstaller method]
|
# Response for ValidateInstaller method] [spectrum.sas.portal.v1alpha1.
|
||||||
# [spectrum.sas.portal.v1alpha1.DeviceManager.ValidateInstaller].
|
# DeviceManager.ValidateInstaller].
|
||||||
class SasPortalValidateInstallerResponse
|
class SasPortalValidateInstallerResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -79,12 +79,10 @@ module Google
|
||||||
|
|
||||||
# Returns a list of requested customers.
|
# Returns a list of requested customers.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of customers
|
# The maximum number of customers to return in the response.
|
||||||
# to return in the response.
|
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListCustomers method that
|
# A pagination token returned from a previous call to ListCustomers method that
|
||||||
# indicates where
|
# indicates where this listing should continue from.
|
||||||
# this listing should continue from.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -215,8 +213,7 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Creates a signed device under a
|
# Creates a signed device under a node or customer.
|
||||||
# node or customer.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the parent resource.
|
# Required. The name of the parent resource.
|
||||||
# @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object
|
# @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object
|
||||||
|
|
@ -313,16 +310,15 @@ module Google
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the parent resource.
|
# Required. The name of the parent resource.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# The filter expression. The filter should have one of the following
|
# The filter expression. The filter should have one of the following formats: "
|
||||||
# formats: "sn=123454" or "display_name=MyDevice". sn
|
# sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the
|
||||||
# corresponds to serial_number of the device. The filter is case insensitive.
|
# device. The filter is case insensitive.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of devices to return in the response.
|
# The maximum number of devices to return in the response. If empty or zero, all
|
||||||
# If empty or zero, all devices will be listed.
|
# devices will be listed. Must be in the range [0, 1000].
|
||||||
# Must be in the range [0, 1000].
|
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListDevices
|
# A pagination token returned from a previous call to ListDevices that indicates
|
||||||
# that indicates where this listing should continue from.
|
# where this listing should continue from.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -587,8 +583,8 @@ module Google
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of nodes to return in the response.
|
# The maximum number of nodes to return in the response.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListNodes method
|
# A pagination token returned from a previous call to ListNodes method that
|
||||||
# that indicates where this listing should continue from.
|
# indicates where this listing should continue from.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -620,8 +616,7 @@ module Google
|
||||||
|
|
||||||
# Moves a node under another node or customer.
|
# Moves a node under another node or customer.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The name of the node to
|
# Required. The name of the node to move.
|
||||||
# move.
|
|
||||||
# @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalMoveNodeRequest] sas_portal_move_node_request_object
|
# @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalMoveNodeRequest] sas_portal_move_node_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -727,8 +722,8 @@ module Google
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of nodes to return in the response.
|
# The maximum number of nodes to return in the response.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListNodes method
|
# A pagination token returned from a previous call to ListNodes method that
|
||||||
# that indicates where this listing should continue from.
|
# indicates where this listing should continue from.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -914,8 +909,7 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Creates a signed device under a
|
# Creates a signed device under a node or customer.
|
||||||
# node or customer.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the parent resource.
|
# Required. The name of the parent resource.
|
||||||
# @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object
|
# @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object
|
||||||
|
|
@ -1012,16 +1006,15 @@ module Google
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the parent resource.
|
# Required. The name of the parent resource.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# The filter expression. The filter should have one of the following
|
# The filter expression. The filter should have one of the following formats: "
|
||||||
# formats: "sn=123454" or "display_name=MyDevice". sn
|
# sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the
|
||||||
# corresponds to serial_number of the device. The filter is case insensitive.
|
# device. The filter is case insensitive.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of devices to return in the response.
|
# The maximum number of devices to return in the response. If empty or zero, all
|
||||||
# If empty or zero, all devices will be listed.
|
# devices will be listed. Must be in the range [0, 1000].
|
||||||
# Must be in the range [0, 1000].
|
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListDevices
|
# A pagination token returned from a previous call to ListDevices that indicates
|
||||||
# that indicates where this listing should continue from.
|
# where this listing should continue from.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1286,8 +1279,8 @@ module Google
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of nodes to return in the response.
|
# The maximum number of nodes to return in the response.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListNodes method
|
# A pagination token returned from a previous call to ListNodes method that
|
||||||
# that indicates where this listing should continue from.
|
# indicates where this listing should continue from.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1319,8 +1312,7 @@ module Google
|
||||||
|
|
||||||
# Moves a node under another node or customer.
|
# Moves a node under another node or customer.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The name of the node to
|
# Required. The name of the node to move.
|
||||||
# move.
|
|
||||||
# @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalMoveNodeRequest] sas_portal_move_node_request_object
|
# @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalMoveNodeRequest] sas_portal_move_node_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -1453,8 +1445,7 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Creates a signed device under a
|
# Creates a signed device under a node or customer.
|
||||||
# node or customer.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the parent resource.
|
# Required. The name of the parent resource.
|
||||||
# @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object
|
# @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object
|
||||||
|
|
@ -1491,16 +1482,15 @@ module Google
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the parent resource.
|
# Required. The name of the parent resource.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# The filter expression. The filter should have one of the following
|
# The filter expression. The filter should have one of the following formats: "
|
||||||
# formats: "sn=123454" or "display_name=MyDevice". sn
|
# sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the
|
||||||
# corresponds to serial_number of the device. The filter is case insensitive.
|
# device. The filter is case insensitive.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of devices to return in the response.
|
# The maximum number of devices to return in the response. If empty or zero, all
|
||||||
# If empty or zero, all devices will be listed.
|
# devices will be listed. Must be in the range [0, 1000].
|
||||||
# Must be in the range [0, 1000].
|
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListDevices
|
# A pagination token returned from a previous call to ListDevices that indicates
|
||||||
# that indicates where this listing should continue from.
|
# where this listing should continue from.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1570,8 +1560,8 @@ module Google
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of nodes to return in the response.
|
# The maximum number of nodes to return in the response.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListNodes method
|
# A pagination token returned from a previous call to ListNodes method that
|
||||||
# that indicates where this listing should continue from.
|
# indicates where this listing should continue from.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1601,9 +1591,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the access control policy for a resource.
|
# Gets the access control policy for a resource. Returns an empty policy if the
|
||||||
# Returns an empty policy if the resource exists and does not have a policy
|
# resource exists and does not have a policy set.
|
||||||
# set.
|
|
||||||
# @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalGetPolicyRequest] sas_portal_get_policy_request_object
|
# @param [Google::Apis::ProdTtSasportalV1alpha1::SasPortalGetPolicyRequest] sas_portal_get_policy_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
|
||||||
|
|
@ -28,7 +28,7 @@ module Google
|
||||||
# @see https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/
|
# @see https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/
|
||||||
module RealtimebiddingV1
|
module RealtimebiddingV1
|
||||||
VERSION = 'V1'
|
VERSION = 'V1'
|
||||||
REVISION = '20200730'
|
REVISION = '20200803'
|
||||||
|
|
||||||
# See, create, edit, and delete your Authorized Buyers and Open Bidding account entities
|
# See, create, edit, and delete your Authorized Buyers and Open Bidding account entities
|
||||||
AUTH_REALTIME_BIDDING = 'https://www.googleapis.com/auth/realtime-bidding'
|
AUTH_REALTIME_BIDDING = 'https://www.googleapis.com/auth/realtime-bidding'
|
||||||
|
|
|
||||||
|
|
@ -26,31 +26,25 @@ module Google
|
||||||
class AdTechnologyProviders
|
class AdTechnologyProviders
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The detected ad technology provider IDs for this creative.
|
# The detected ad technology provider IDs for this creative. See https://storage.
|
||||||
# See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for
|
# googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID
|
||||||
# mapping of provider ID to provided name, a privacy policy URL, and a list
|
# to provided name, a privacy policy URL, and a list of domains which can be
|
||||||
# of domains which can be attributed to the provider.
|
# attributed to the provider. If the creative contains provider IDs that are
|
||||||
# If the creative contains provider IDs that are outside of those listed in
|
# outside of those listed in the `BidRequest.adslot.consented_providers_settings.
|
||||||
# the `BidRequest.adslot.consented_providers_settings.consented_providers`
|
# consented_providers` field on the [Google bid protocol](https://developers.
|
||||||
# field on the [Google bid
|
# google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) and the `
|
||||||
# protocol](https://developers.google.com/authorized-buyers/rtb/downloads/
|
# BidRequest.user.ext.consented_providers_settings.consented_providers` field on
|
||||||
# realtime-bidding-proto)
|
# the [OpenRTB protocol](https://developers.google.com/authorized-buyers/rtb/
|
||||||
# and the
|
# downloads/openrtb-adx-proto), and a bid is submitted with that creative for an
|
||||||
# `BidRequest.user.ext.consented_providers_settings.consented_providers`
|
# impression that will serve to an EEA user, the bid will be filtered before the
|
||||||
# field on the [OpenRTB
|
|
||||||
# protocol](https://developers.google.com/authorized-buyers/rtb/downloads/
|
|
||||||
# openrtb-adx-proto),
|
|
||||||
# and a bid is submitted with that creative for an impression
|
|
||||||
# that will serve to an EEA user, the bid will be filtered before the
|
|
||||||
# auction.
|
# auction.
|
||||||
# Corresponds to the JSON property `detectedProviderIds`
|
# Corresponds to the JSON property `detectedProviderIds`
|
||||||
# @return [Array<Fixnum>]
|
# @return [Array<Fixnum>]
|
||||||
attr_accessor :detected_provider_ids
|
attr_accessor :detected_provider_ids
|
||||||
|
|
||||||
# Whether the creative contains an unidentified ad technology provider.
|
# Whether the creative contains an unidentified ad technology provider. If true
|
||||||
# If true for a given creative, any bid submitted with that creative for an
|
# for a given creative, any bid submitted with that creative for an impression
|
||||||
# impression that will serve to an EEA user will be filtered before the
|
# that will serve to an EEA user will be filtered before the auction.
|
||||||
# auction.
|
|
||||||
# Corresponds to the JSON property `hasUnidentifiedProvider`
|
# Corresponds to the JSON property `hasUnidentifiedProvider`
|
||||||
# @return [Boolean]
|
# @return [Boolean]
|
||||||
attr_accessor :has_unidentified_provider
|
attr_accessor :has_unidentified_provider
|
||||||
|
|
@ -71,37 +65,27 @@ module Google
|
||||||
class AdvertiserAndBrand
|
class AdvertiserAndBrand
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# See https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt
|
# See https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt for
|
||||||
# for the list of possible values.
|
# the list of possible values. Can be used to filter the response of the
|
||||||
# Can be used to filter the response of the
|
# creatives.list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `advertiserId`
|
# Corresponds to the JSON property `advertiserId`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :advertiser_id
|
attr_accessor :advertiser_id
|
||||||
|
|
||||||
# Advertiser name.
|
# Advertiser name. Can be used to filter the response of the creatives.list
|
||||||
# Can be used to filter the response of the
|
|
||||||
# creatives.list
|
|
||||||
# method.
|
# method.
|
||||||
# Corresponds to the JSON property `advertiserName`
|
# Corresponds to the JSON property `advertiserName`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :advertiser_name
|
attr_accessor :advertiser_name
|
||||||
|
|
||||||
# Detected brand ID or zero if no brand has been detected.
|
# Detected brand ID or zero if no brand has been detected. See https://storage.
|
||||||
# See https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt for
|
# googleapis.com/adx-rtb-dictionaries/brands.txt for the list of possible values.
|
||||||
# the list of possible values.
|
# Can be used to filter the response of the creatives.list method.
|
||||||
# Can be used to filter the response of the
|
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `brandId`
|
# Corresponds to the JSON property `brandId`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :brand_id
|
attr_accessor :brand_id
|
||||||
|
|
||||||
# Brand name.
|
# Brand name. Can be used to filter the response of the creatives.list method.
|
||||||
# Can be used to filter the response of the
|
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `brandName`
|
# Corresponds to the JSON property `brandName`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :brand_name
|
attr_accessor :brand_name
|
||||||
|
|
@ -136,24 +120,20 @@ module Google
|
||||||
class Creative
|
class Creative
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Output only. ID of the buyer account that this creative is owned by.
|
# Output only. ID of the buyer account that this creative is owned by. Can be
|
||||||
# Can be used to filter the response of the
|
# used to filter the response of the creatives.list method with equality and
|
||||||
# creatives.list
|
# inequality check.
|
||||||
# method with equality and inequality check.
|
|
||||||
# Corresponds to the JSON property `accountId`
|
# Corresponds to the JSON property `accountId`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :account_id
|
attr_accessor :account_id
|
||||||
|
|
||||||
# The link to AdChoices destination page. This is only supported for native
|
# The link to AdChoices destination page. This is only supported for native ads.
|
||||||
# ads.
|
|
||||||
# Corresponds to the JSON property `adChoicesDestinationUrl`
|
# Corresponds to the JSON property `adChoicesDestinationUrl`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :ad_choices_destination_url
|
attr_accessor :ad_choices_destination_url
|
||||||
|
|
||||||
# The name of the company being advertised in the creative.
|
# The name of the company being advertised in the creative. Can be used to
|
||||||
# Can be used to filter the response of the
|
# filter the response of the creatives.list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `advertiserName`
|
# Corresponds to the JSON property `advertiserName`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :advertiser_name
|
attr_accessor :advertiser_name
|
||||||
|
|
@ -168,20 +148,16 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :api_update_time
|
attr_accessor :api_update_time
|
||||||
|
|
||||||
# Output only. The format of this creative.
|
# Output only. The format of this creative. Can be used to filter the response
|
||||||
# Can be used to filter the response of the
|
# of the creatives.list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `creativeFormat`
|
# Corresponds to the JSON property `creativeFormat`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :creative_format
|
attr_accessor :creative_format
|
||||||
|
|
||||||
# Buyer-specific creative ID that references this creative in bid responses.
|
# Buyer-specific creative ID that references this creative in bid responses.
|
||||||
# This field is Ignored in update operations. Can be used to filter the
|
# This field is Ignored in update operations. Can be used to filter the response
|
||||||
# response of the
|
# of the creatives.list method. The maximum length of the creative ID is 128
|
||||||
# creatives.list
|
# bytes.
|
||||||
# method.
|
|
||||||
# The maximum length of the creative ID is 128 bytes.
|
|
||||||
# Corresponds to the JSON property `creativeId`
|
# Corresponds to the JSON property `creativeId`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :creative_id
|
attr_accessor :creative_id
|
||||||
|
|
@ -191,51 +167,37 @@ module Google
|
||||||
# @return [Google::Apis::RealtimebiddingV1::CreativeServingDecision]
|
# @return [Google::Apis::RealtimebiddingV1::CreativeServingDecision]
|
||||||
attr_accessor :creative_serving_decision
|
attr_accessor :creative_serving_decision
|
||||||
|
|
||||||
# Output only. IDs of all of the deals with which this creative has been used
|
# Output only. IDs of all of the deals with which this creative has been used in
|
||||||
# in bidding.
|
# bidding. Can be used to filter the response of the creatives.list method.
|
||||||
# Can be used to filter the response of the
|
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `dealIds`
|
# Corresponds to the JSON property `dealIds`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :deal_ids
|
attr_accessor :deal_ids
|
||||||
|
|
||||||
# All declared attributes for the ads that may be shown from this creative.
|
# All declared attributes for the ads that may be shown from this creative. Can
|
||||||
# Can be used to filter the response of the
|
# be used to filter the response of the creatives.list method. If the `
|
||||||
# creatives.list
|
# excluded_attribute` field of a [bid request](https://developers.google.com/
|
||||||
# method.
|
# authorized-buyers/rtb/downloads/realtime-bidding-proto") contains one of the
|
||||||
# If the `excluded_attribute` field of a [bid
|
# attributes that were declared or detected for a given creative, and a bid is
|
||||||
# request](https://developers.google.com/authorized-buyers/rtb/downloads/
|
# submitted with that creative, the bid will be filtered before the auction.
|
||||||
# realtime-bidding-proto")
|
|
||||||
# contains one of the attributes that were declared or detected for a given
|
|
||||||
# creative, and a bid is submitted with that creative, the bid will be
|
|
||||||
# filtered before the auction.
|
|
||||||
# Corresponds to the JSON property `declaredAttributes`
|
# Corresponds to the JSON property `declaredAttributes`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :declared_attributes
|
attr_accessor :declared_attributes
|
||||||
|
|
||||||
# The set of declared destination URLs for the creative.
|
# The set of declared destination URLs for the creative. Can be used to filter
|
||||||
# Can be used to filter the response of the
|
# the response of the creatives.list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `declaredClickThroughUrls`
|
# Corresponds to the JSON property `declaredClickThroughUrls`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :declared_click_through_urls
|
attr_accessor :declared_click_through_urls
|
||||||
|
|
||||||
# All declared restricted categories for the ads that may be shown from this
|
# All declared restricted categories for the ads that may be shown from this
|
||||||
# creative. Can be used to filter the response of the
|
# creative. Can be used to filter the response of the creatives.list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `declaredRestrictedCategories`
|
# Corresponds to the JSON property `declaredRestrictedCategories`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :declared_restricted_categories
|
attr_accessor :declared_restricted_categories
|
||||||
|
|
||||||
# IDs for the declared ad technology vendors that may be used by this
|
# IDs for the declared ad technology vendors that may be used by this creative.
|
||||||
# creative. See
|
# See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for
|
||||||
# https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for
|
# possible values. Can be used to filter the response of the creatives.list
|
||||||
# possible values.
|
|
||||||
# Can be used to filter the response of the
|
|
||||||
# creatives.list
|
|
||||||
# method.
|
# method.
|
||||||
# Corresponds to the JSON property `declaredVendorIds`
|
# Corresponds to the JSON property `declaredVendorIds`
|
||||||
# @return [Array<Fixnum>]
|
# @return [Array<Fixnum>]
|
||||||
|
|
@ -251,11 +213,10 @@ module Google
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :impression_tracking_urls
|
attr_accessor :impression_tracking_urls
|
||||||
|
|
||||||
# Output only. Name of the creative.
|
# Output only. Name of the creative. Follows the pattern `buyers/`buyer`/
|
||||||
# Follows the pattern `buyers/`buyer`/creatives/`creative``, where
|
# creatives/`creative``, where ``buyer`` represents the account ID of the buyer
|
||||||
# ``buyer`` represents the account ID of the buyer who owns the creative,
|
# who owns the creative, and ``creative`` is the buyer-specific creative ID that
|
||||||
# and ``creative`` is the buyer-specific creative ID that references this
|
# references this creative in the bid response.
|
||||||
# creative in the bid response.
|
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
@ -270,9 +231,8 @@ module Google
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :restricted_categories
|
attr_accessor :restricted_categories
|
||||||
|
|
||||||
# Output only. The version of this creative.
|
# Output only. The version of this creative. Version for a new creative is 1 and
|
||||||
# Version for a new creative is 1 and it increments during subsequent
|
# it increments during subsequent creative updates.
|
||||||
# creative updates.
|
|
||||||
# Corresponds to the JSON property `version`
|
# Corresponds to the JSON property `version`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :version
|
attr_accessor :version
|
||||||
|
|
@ -335,24 +295,18 @@ module Google
|
||||||
# @return [Array<Google::Apis::RealtimebiddingV1::AdvertiserAndBrand>]
|
# @return [Array<Google::Apis::RealtimebiddingV1::AdvertiserAndBrand>]
|
||||||
attr_accessor :detected_advertisers
|
attr_accessor :detected_advertisers
|
||||||
|
|
||||||
# Publisher-excludable attributes that were detected for this creative.
|
# Publisher-excludable attributes that were detected for this creative. Can be
|
||||||
# Can be used to filter the response of the
|
# used to filter the response of the creatives.list method. If the `
|
||||||
# creatives.list
|
# excluded_attribute` field of a [bid request](https://developers.google.com/
|
||||||
# method.
|
# authorized-buyers/rtb/downloads/realtime-bidding-proto) contains one of the
|
||||||
# If the `excluded_attribute` field of a [bid
|
# attributes that were declared or detected for a given creative, and a bid is
|
||||||
# request](https://developers.google.com/authorized-buyers/rtb/downloads/
|
# submitted with that creative, the bid will be filtered before the auction.
|
||||||
# realtime-bidding-proto)
|
|
||||||
# contains one of the attributes that were declared or detected for a given
|
|
||||||
# creative, and a bid is submitted with that creative, the bid will be
|
|
||||||
# filtered before the auction.
|
|
||||||
# Corresponds to the JSON property `detectedAttributes`
|
# Corresponds to the JSON property `detectedAttributes`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :detected_attributes
|
attr_accessor :detected_attributes
|
||||||
|
|
||||||
# The set of detected destination URLs for the creative.
|
# The set of detected destination URLs for the creative. Can be used to filter
|
||||||
# Can be used to filter the response of the
|
# the response of the creatives.list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `detectedClickThroughUrls`
|
# Corresponds to the JSON property `detectedClickThroughUrls`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :detected_click_through_urls
|
attr_accessor :detected_click_through_urls
|
||||||
|
|
@ -362,58 +316,43 @@ module Google
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :detected_domains
|
attr_accessor :detected_domains
|
||||||
|
|
||||||
# The detected languages for this creative. The order is
|
# The detected languages for this creative. The order is arbitrary. The codes
|
||||||
# arbitrary. The codes are 2 or 5 characters and are documented at
|
# are 2 or 5 characters and are documented at https://developers.google.com/
|
||||||
# https://developers.google.com/adwords/api/docs/appendix/languagecodes.
|
# adwords/api/docs/appendix/languagecodes. Can be used to filter the response of
|
||||||
# Can be used to filter the response of the
|
# the creatives.list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `detectedLanguages`
|
# Corresponds to the JSON property `detectedLanguages`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :detected_languages
|
attr_accessor :detected_languages
|
||||||
|
|
||||||
# Detected product categories, if any.
|
# Detected product categories, if any. See the ad-product-categories.txt file in
|
||||||
# See the ad-product-categories.txt file in the technical documentation
|
# the technical documentation for a list of IDs. Can be used to filter the
|
||||||
# for a list of IDs.
|
# response of the creatives.list method.
|
||||||
# Can be used to filter the response of the
|
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `detectedProductCategories`
|
# Corresponds to the JSON property `detectedProductCategories`
|
||||||
# @return [Array<Fixnum>]
|
# @return [Array<Fixnum>]
|
||||||
attr_accessor :detected_product_categories
|
attr_accessor :detected_product_categories
|
||||||
|
|
||||||
# Detected sensitive categories, if any.
|
# Detected sensitive categories, if any. Can be used to filter the response of
|
||||||
# Can be used to filter the response of the
|
# the creatives.list method. See the ad-sensitive-categories.txt file in the
|
||||||
# creatives.list
|
# technical documentation for a list of IDs. You should use these IDs along with
|
||||||
# method.
|
# the excluded-sensitive-category field in the bid request to filter your bids.
|
||||||
# See the ad-sensitive-categories.txt file in the technical documentation
|
|
||||||
# for a list of IDs. You should use these IDs along with the
|
|
||||||
# excluded-sensitive-category field in the bid request to filter your bids.
|
|
||||||
# Corresponds to the JSON property `detectedSensitiveCategories`
|
# Corresponds to the JSON property `detectedSensitiveCategories`
|
||||||
# @return [Array<Fixnum>]
|
# @return [Array<Fixnum>]
|
||||||
attr_accessor :detected_sensitive_categories
|
attr_accessor :detected_sensitive_categories
|
||||||
|
|
||||||
# IDs of the ad technology vendors that were detected to be
|
# IDs of the ad technology vendors that were detected to be used by this
|
||||||
# used by this creative. See
|
# creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
|
||||||
# https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for
|
# for possible values. Can be used to filter the response of the creatives.list
|
||||||
# possible values.
|
# method. If the `allowed_vendor_type` field of a [bid request](https://
|
||||||
# Can be used to filter the response of the
|
# developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto)
|
||||||
# creatives.list
|
# does not contain one of the vendor type IDs that were declared or detected for
|
||||||
# method.
|
# a given creative, and a bid is submitted with that creative, the bid will be
|
||||||
# If the `allowed_vendor_type` field of a [bid
|
# filtered before the auction.
|
||||||
# request](https://developers.google.com/authorized-buyers/rtb/downloads/
|
|
||||||
# realtime-bidding-proto)
|
|
||||||
# does not contain one of the vendor type IDs that were declared or
|
|
||||||
# detected for a given creative, and a bid is submitted with that creative,
|
|
||||||
# the bid will be filtered before the auction.
|
|
||||||
# Corresponds to the JSON property `detectedVendorIds`
|
# Corresponds to the JSON property `detectedVendorIds`
|
||||||
# @return [Array<Fixnum>]
|
# @return [Array<Fixnum>]
|
||||||
attr_accessor :detected_vendor_ids
|
attr_accessor :detected_vendor_ids
|
||||||
|
|
||||||
# The last time the creative status was updated.
|
# The last time the creative status was updated. Can be used to filter the
|
||||||
# Can be used to filter the response of the
|
# response of the creatives.list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `lastStatusUpdate`
|
# Corresponds to the JSON property `lastStatusUpdate`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :last_status_update
|
attr_accessor :last_status_update
|
||||||
|
|
@ -453,30 +392,29 @@ module Google
|
||||||
|
|
||||||
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
|
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
|
||||||
# and time zone are either specified elsewhere or are not significant. The date
|
# and time zone are either specified elsewhere or are not significant. The date
|
||||||
# is relative to the Proleptic Gregorian Calendar. This can represent:
|
# is relative to the Proleptic Gregorian Calendar. This can represent: * A full
|
||||||
# * A full date, with non-zero year, month and day values
|
# date, with non-zero year, month and day values * A month and day value, with a
|
||||||
# * A month and day value, with a zero year, e.g. an anniversary
|
# zero year, e.g. an anniversary * A year on its own, with zero month and day
|
||||||
# * A year on its own, with zero month and day values
|
# values * A year and month value, with a zero day, e.g. a credit card
|
||||||
# * A year and month value, with a zero day, e.g. a credit card expiration date
|
# expiration date Related types are google.type.TimeOfDay and `google.protobuf.
|
||||||
# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
|
# Timestamp`.
|
||||||
class Date
|
class Date
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Day of month. Must be from 1 to 31 and valid for the year and month, or 0
|
# Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if
|
||||||
# if specifying a year by itself or a year and month where the day is not
|
# specifying a year by itself or a year and month where the day is not
|
||||||
# significant.
|
# significant.
|
||||||
# Corresponds to the JSON property `day`
|
# Corresponds to the JSON property `day`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :day
|
attr_accessor :day
|
||||||
|
|
||||||
# Month of year. Must be from 1 to 12, or 0 if specifying a year without a
|
# Month of year. Must be from 1 to 12, or 0 if specifying a year without a month
|
||||||
# month and day.
|
# and day.
|
||||||
# Corresponds to the JSON property `month`
|
# Corresponds to the JSON property `month`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :month
|
attr_accessor :month
|
||||||
|
|
||||||
# Year of date. Must be from 1 to 9999, or 0 if specifying a date without
|
# Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
|
||||||
# a year.
|
|
||||||
# Corresponds to the JSON property `year`
|
# Corresponds to the JSON property `year`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :year
|
attr_accessor :year
|
||||||
|
|
@ -524,8 +462,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Evidence of the creative's destination URL not functioning properly or
|
# Evidence of the creative's destination URL not functioning properly or having
|
||||||
# having been incorrectly set up.
|
# been incorrectly set up.
|
||||||
class DestinationNotWorkingEvidence
|
class DestinationNotWorkingEvidence
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -544,8 +482,8 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :http_error
|
attr_accessor :http_error
|
||||||
|
|
||||||
# Page was crawled successfully, but was detected as either a page with
|
# Page was crawled successfully, but was detected as either a page with no
|
||||||
# no content or an error page.
|
# content or an error page.
|
||||||
# Corresponds to the JSON property `invalidPage`
|
# Corresponds to the JSON property `invalidPage`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :invalid_page
|
attr_accessor :invalid_page
|
||||||
|
|
@ -615,8 +553,8 @@ module Google
|
||||||
# @return [Array<Google::Apis::RealtimebiddingV1::DomainCalls>]
|
# @return [Array<Google::Apis::RealtimebiddingV1::DomainCalls>]
|
||||||
attr_accessor :top_http_call_domains
|
attr_accessor :top_http_call_domains
|
||||||
|
|
||||||
# The total number of HTTP calls made by the creative, including but not
|
# The total number of HTTP calls made by the creative, including but not limited
|
||||||
# limited to the number of calls in the top_http_call_domains.
|
# to the number of calls in the top_http_call_domains.
|
||||||
# Corresponds to the JSON property `totalHttpCallCount`
|
# Corresponds to the JSON property `totalHttpCallCount`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :total_http_call_count
|
attr_accessor :total_http_call_count
|
||||||
|
|
@ -657,8 +595,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Total download size and URL-level download size breakdown for resources in
|
# Total download size and URL-level download size breakdown for resources in a
|
||||||
# a creative.
|
# creative.
|
||||||
class DownloadSizeEvidence
|
class DownloadSizeEvidence
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -687,10 +625,10 @@ module Google
|
||||||
class GetRemarketingTagResponse
|
class GetRemarketingTagResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# A HTML tag that can be placed on the advertiser's page to add users to a
|
# A HTML tag that can be placed on the advertiser's page to add users to a user
|
||||||
# user list. For more information and code samples on using snippet on your
|
# list. For more information and code samples on using snippet on your website
|
||||||
# website refer to [Tag your site for remarketing](
|
# refer to [Tag your site for remarketing]( https://support.google.com/google-
|
||||||
# https://support.google.com/google-ads/answer/2476688).
|
# ads/answer/2476688).
|
||||||
# Corresponds to the JSON property `snippet`
|
# Corresponds to the JSON property `snippet`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :snippet
|
attr_accessor :snippet
|
||||||
|
|
@ -709,10 +647,8 @@ module Google
|
||||||
class HtmlContent
|
class HtmlContent
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The height of the HTML snippet in pixels.
|
# The height of the HTML snippet in pixels. Can be used to filter the response
|
||||||
# Can be used to filter the response of the
|
# of the creatives.list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `height`
|
# Corresponds to the JSON property `height`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :height
|
attr_accessor :height
|
||||||
|
|
@ -722,10 +658,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :snippet
|
attr_accessor :snippet
|
||||||
|
|
||||||
# The width of the HTML snippet in pixels.
|
# The width of the HTML snippet in pixels. Can be used to filter the response of
|
||||||
# Can be used to filter the response of the
|
# the creatives.list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `width`
|
# Corresponds to the JSON property `width`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :width
|
attr_accessor :width
|
||||||
|
|
@ -765,18 +699,18 @@ module Google
|
||||||
class HttpCookieEvidence
|
class HttpCookieEvidence
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Names of cookies that violate Google policies.
|
# Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy,
|
||||||
# For TOO_MANY_COOKIES policy, this will be the cookie names of top domains
|
# this will be the cookie names of top domains with the largest number of
|
||||||
# with the largest number of cookies. For other policies, this will be all
|
# cookies. For other policies, this will be all the cookie names that violate
|
||||||
# the cookie names that violate the policy.
|
# the policy.
|
||||||
# Corresponds to the JSON property `cookieNames`
|
# Corresponds to the JSON property `cookieNames`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :cookie_names
|
attr_accessor :cookie_names
|
||||||
|
|
||||||
# The largest number of cookies set by a creative. If this field is set,
|
# The largest number of cookies set by a creative. If this field is set,
|
||||||
# cookie_names above will be set to the cookie names of top domains with
|
# cookie_names above will be set to the cookie names of top domains with the
|
||||||
# the largest number of cookies.
|
# largest number of cookies. This field will only be set for TOO_MANY_COOKIES
|
||||||
# This field will only be set for TOO_MANY_COOKIES policy.
|
# policy.
|
||||||
# Corresponds to the JSON property `maxCookieCount`
|
# Corresponds to the JSON property `maxCookieCount`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :max_cookie_count
|
attr_accessor :max_cookie_count
|
||||||
|
|
@ -792,8 +726,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# An image resource. You may provide a larger image than was requested,
|
# An image resource. You may provide a larger image than was requested, so long
|
||||||
# so long as the aspect ratio is preserved.
|
# as the aspect ratio is preserved.
|
||||||
class Image
|
class Image
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -833,11 +767,9 @@ module Google
|
||||||
# @return [Array<Google::Apis::RealtimebiddingV1::Creative>]
|
# @return [Array<Google::Apis::RealtimebiddingV1::Creative>]
|
||||||
attr_accessor :creatives
|
attr_accessor :creatives
|
||||||
|
|
||||||
# A token to retrieve the next page of results.
|
# A token to retrieve the next page of results. Pass this value in the
|
||||||
# Pass this value in the
|
# ListCreativesRequest.pageToken field in the subsequent call to the `
|
||||||
# ListCreativesRequest.pageToken
|
# ListCreatives` method to retrieve the next page of results.
|
||||||
# field in the subsequent call to the `ListCreatives` method to retrieve the
|
|
||||||
# next page of results.
|
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -857,11 +789,10 @@ module Google
|
||||||
class ListUserListsResponse
|
class ListUserListsResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The continuation page token to send back to the server in a subsequent
|
# The continuation page token to send back to the server in a subsequent request.
|
||||||
# request.
|
|
||||||
# Due to a currently known issue, it is recommended that the caller keep
|
# Due to a currently known issue, it is recommended that the caller keep
|
||||||
# invoking the list method till the time a next page token is not returned
|
# invoking the list method till the time a next page token is not returned (even
|
||||||
# (even if the result set is empty).
|
# if the result set is empty).
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -886,18 +817,14 @@ module Google
|
||||||
class MediaFile
|
class MediaFile
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Bitrate of the video file, in Kbps.
|
# Bitrate of the video file, in Kbps. Can be used to filter the response of the
|
||||||
# Can be used to filter the response of the
|
# creatives.list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `bitrate`
|
# Corresponds to the JSON property `bitrate`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :bitrate
|
attr_accessor :bitrate
|
||||||
|
|
||||||
# The MIME type of this media file.
|
# The MIME type of this media file. Can be used to filter the response of the
|
||||||
# Can be used to filter the response of the
|
# creatives.list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `mimeType`
|
# Corresponds to the JSON property `mimeType`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :mime_type
|
attr_accessor :mime_type
|
||||||
|
|
@ -922,8 +849,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :advertiser_name
|
attr_accessor :advertiser_name
|
||||||
|
|
||||||
# An image resource. You may provide a larger image than was requested,
|
# An image resource. You may provide a larger image than was requested, so long
|
||||||
# so long as the aspect ratio is preserved.
|
# as the aspect ratio is preserved.
|
||||||
# Corresponds to the JSON property `appIcon`
|
# Corresponds to the JSON property `appIcon`
|
||||||
# @return [Google::Apis::RealtimebiddingV1::Image]
|
# @return [Google::Apis::RealtimebiddingV1::Image]
|
||||||
attr_accessor :app_icon
|
attr_accessor :app_icon
|
||||||
|
|
@ -953,14 +880,14 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :headline
|
attr_accessor :headline
|
||||||
|
|
||||||
# An image resource. You may provide a larger image than was requested,
|
# An image resource. You may provide a larger image than was requested, so long
|
||||||
# so long as the aspect ratio is preserved.
|
# as the aspect ratio is preserved.
|
||||||
# Corresponds to the JSON property `image`
|
# Corresponds to the JSON property `image`
|
||||||
# @return [Google::Apis::RealtimebiddingV1::Image]
|
# @return [Google::Apis::RealtimebiddingV1::Image]
|
||||||
attr_accessor :image
|
attr_accessor :image
|
||||||
|
|
||||||
# An image resource. You may provide a larger image than was requested,
|
# An image resource. You may provide a larger image than was requested, so long
|
||||||
# so long as the aspect ratio is preserved.
|
# as the aspect ratio is preserved.
|
||||||
# Corresponds to the JSON property `logo`
|
# Corresponds to the JSON property `logo`
|
||||||
# @return [Google::Apis::RealtimebiddingV1::Image]
|
# @return [Google::Apis::RealtimebiddingV1::Image]
|
||||||
attr_accessor :logo
|
attr_accessor :logo
|
||||||
|
|
@ -1030,13 +957,10 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :help_center_url
|
attr_accessor :help_center_url
|
||||||
|
|
||||||
# Policy topic this entry refers to. For example, "ALCOHOL",
|
# Policy topic this entry refers to. For example, "ALCOHOL", "
|
||||||
# "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible
|
# TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible
|
||||||
# policy topics is not fixed for a particular API version and may change at
|
# policy topics is not fixed for a particular API version and may change at any
|
||||||
# any time.
|
# time. Can be used to filter the response of the creatives.list method
|
||||||
# Can be used to filter the response of the
|
|
||||||
# creatives.list
|
|
||||||
# method
|
|
||||||
# Corresponds to the JSON property `policyTopic`
|
# Corresponds to the JSON property `policyTopic`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :policy_topic
|
attr_accessor :policy_topic
|
||||||
|
|
@ -1062,8 +986,8 @@ module Google
|
||||||
# @return [Google::Apis::RealtimebiddingV1::DestinationNotCrawlableEvidence]
|
# @return [Google::Apis::RealtimebiddingV1::DestinationNotCrawlableEvidence]
|
||||||
attr_accessor :destination_not_crawlable
|
attr_accessor :destination_not_crawlable
|
||||||
|
|
||||||
# Evidence of the creative's destination URL not functioning properly or
|
# Evidence of the creative's destination URL not functioning properly or having
|
||||||
# having been incorrectly set up.
|
# been incorrectly set up.
|
||||||
# Corresponds to the JSON property `destinationNotWorking`
|
# Corresponds to the JSON property `destinationNotWorking`
|
||||||
# @return [Google::Apis::RealtimebiddingV1::DestinationNotWorkingEvidence]
|
# @return [Google::Apis::RealtimebiddingV1::DestinationNotWorkingEvidence]
|
||||||
attr_accessor :destination_not_working
|
attr_accessor :destination_not_working
|
||||||
|
|
@ -1078,8 +1002,8 @@ module Google
|
||||||
# @return [Google::Apis::RealtimebiddingV1::DomainCallEvidence]
|
# @return [Google::Apis::RealtimebiddingV1::DomainCallEvidence]
|
||||||
attr_accessor :domain_call
|
attr_accessor :domain_call
|
||||||
|
|
||||||
# Total download size and URL-level download size breakdown for resources in
|
# Total download size and URL-level download size breakdown for resources in a
|
||||||
# a creative.
|
# creative.
|
||||||
# Corresponds to the JSON property `downloadSize`
|
# Corresponds to the JSON property `downloadSize`
|
||||||
# @return [Google::Apis::RealtimebiddingV1::DownloadSizeEvidence]
|
# @return [Google::Apis::RealtimebiddingV1::DownloadSizeEvidence]
|
||||||
attr_accessor :download_size
|
attr_accessor :download_size
|
||||||
|
|
@ -1114,18 +1038,16 @@ module Google
|
||||||
class ServingStatus
|
class ServingStatus
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Serving status for the given transaction type (e.g., open auction,
|
# Serving status for the given transaction type (e.g., open auction, deals) or
|
||||||
# deals) or region (e.g., China, Russia).
|
# region (e.g., China, Russia). Can be used to filter the response of the
|
||||||
# Can be used to filter the response of the
|
# creatives.list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `status`
|
# Corresponds to the JSON property `status`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :status
|
attr_accessor :status
|
||||||
|
|
||||||
# Policy topics related to the serving decision for this transaction type
|
# Policy topics related to the serving decision for this transaction type (e.g.,
|
||||||
# (e.g., open auction, deals) or region (e.g., China, Russia).
|
# open auction, deals) or region (e.g., China, Russia). Topics may be present
|
||||||
# Topics may be present only if status is DISAPPROVED.
|
# only if status is DISAPPROVED.
|
||||||
# Corresponds to the JSON property `topics`
|
# Corresponds to the JSON property `topics`
|
||||||
# @return [Array<Google::Apis::RealtimebiddingV1::PolicyTopicEntry>]
|
# @return [Array<Google::Apis::RealtimebiddingV1::PolicyTopicEntry>]
|
||||||
attr_accessor :topics
|
attr_accessor :topics
|
||||||
|
|
@ -1173,12 +1095,12 @@ module Google
|
||||||
|
|
||||||
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
|
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
|
||||||
# and time zone are either specified elsewhere or are not significant. The date
|
# and time zone are either specified elsewhere or are not significant. The date
|
||||||
# is relative to the Proleptic Gregorian Calendar. This can represent:
|
# is relative to the Proleptic Gregorian Calendar. This can represent: * A full
|
||||||
# * A full date, with non-zero year, month and day values
|
# date, with non-zero year, month and day values * A month and day value, with a
|
||||||
# * A month and day value, with a zero year, e.g. an anniversary
|
# zero year, e.g. an anniversary * A year on its own, with zero month and day
|
||||||
# * A year on its own, with zero month and day values
|
# values * A year and month value, with a zero day, e.g. a credit card
|
||||||
# * A year and month value, with a zero day, e.g. a credit card expiration date
|
# expiration date Related types are google.type.TimeOfDay and `google.protobuf.
|
||||||
# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
|
# Timestamp`.
|
||||||
# Corresponds to the JSON property `endDate`
|
# Corresponds to the JSON property `endDate`
|
||||||
# @return [Google::Apis::RealtimebiddingV1::Date]
|
# @return [Google::Apis::RealtimebiddingV1::Date]
|
||||||
attr_accessor :end_date
|
attr_accessor :end_date
|
||||||
|
|
@ -1190,12 +1112,12 @@ module Google
|
||||||
|
|
||||||
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
|
# Represents a whole or partial calendar date, e.g. a birthday. The time of day
|
||||||
# and time zone are either specified elsewhere or are not significant. The date
|
# and time zone are either specified elsewhere or are not significant. The date
|
||||||
# is relative to the Proleptic Gregorian Calendar. This can represent:
|
# is relative to the Proleptic Gregorian Calendar. This can represent: * A full
|
||||||
# * A full date, with non-zero year, month and day values
|
# date, with non-zero year, month and day values * A month and day value, with a
|
||||||
# * A month and day value, with a zero year, e.g. an anniversary
|
# zero year, e.g. an anniversary * A year on its own, with zero month and day
|
||||||
# * A year on its own, with zero month and day values
|
# values * A year and month value, with a zero day, e.g. a credit card
|
||||||
# * A year and month value, with a zero day, e.g. a credit card expiration date
|
# expiration date Related types are google.type.TimeOfDay and `google.protobuf.
|
||||||
# Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
|
# Timestamp`.
|
||||||
# Corresponds to the JSON property `startDate`
|
# Corresponds to the JSON property `startDate`
|
||||||
# @return [Google::Apis::RealtimebiddingV1::Date]
|
# @return [Google::Apis::RealtimebiddingV1::Date]
|
||||||
attr_accessor :start_date
|
attr_accessor :start_date
|
||||||
|
|
@ -1218,11 +1140,10 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Represents an Authorized Buyers user list. Authorized Buyers can
|
# Represents an Authorized Buyers user list. Authorized Buyers can create/update/
|
||||||
# create/update/list user lists. Once a user list is created
|
# list user lists. Once a user list is created in the system, Authorized Buyers
|
||||||
# in the system, Authorized Buyers can add users to the user list using
|
# can add users to the user list using the bulk uploader API. Alternatively,
|
||||||
# the bulk uploader API. Alternatively, users can be added by hosting a
|
# users can be added by hosting a tag on the advertiser's page.
|
||||||
# tag on the advertiser's page.
|
|
||||||
class UserList
|
class UserList
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -1232,24 +1153,23 @@ module Google
|
||||||
attr_accessor :description
|
attr_accessor :description
|
||||||
|
|
||||||
# Required. Display name of the user list. This must be unique across all user
|
# Required. Display name of the user list. This must be unique across all user
|
||||||
# lists
|
# lists for a given account.
|
||||||
# for a given account.
|
|
||||||
# Corresponds to the JSON property `displayName`
|
# Corresponds to the JSON property `displayName`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :display_name
|
attr_accessor :display_name
|
||||||
|
|
||||||
# Required. The number of days a user's cookie stays on the user list.
|
# Required. The number of days a user's cookie stays on the user list. The field
|
||||||
# The field must be between 0 and 540 inclusive.
|
# must be between 0 and 540 inclusive.
|
||||||
# Corresponds to the JSON property `membershipDurationDays`
|
# Corresponds to the JSON property `membershipDurationDays`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :membership_duration_days
|
attr_accessor :membership_duration_days
|
||||||
|
|
||||||
# Output only. Name of the user list that must follow the pattern
|
# Output only. Name of the user list that must follow the pattern `buyers/`buyer`
|
||||||
# `buyers/`buyer`/userLists/`user_list``, where ``buyer`` represents
|
# /userLists/`user_list``, where ``buyer`` represents the account ID of the
|
||||||
# the account ID of the buyer who owns the user list. For a bidder accessing
|
# buyer who owns the user list. For a bidder accessing user lists on behalf of a
|
||||||
# user lists on behalf of a child seat buyer, ``buyer`` represents
|
# child seat buyer, ``buyer`` represents the account ID of the child seat buyer.
|
||||||
# the account ID of the child seat buyer. ``user_list`` is an int64
|
# ``user_list`` is an int64 identifier assigned by Google to uniquely identify a
|
||||||
# identifier assigned by Google to uniquely identify a user list.
|
# user list.
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
@ -1294,8 +1214,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :video_url
|
attr_accessor :video_url
|
||||||
|
|
||||||
# The contents of a VAST document for a video ad.
|
# The contents of a VAST document for a video ad. This document should conform
|
||||||
# This document should conform to the VAST 2.0 or 3.0 standard.
|
# to the VAST 2.0 or 3.0 standard.
|
||||||
# Corresponds to the JSON property `videoVastXml`
|
# Corresponds to the JSON property `videoVastXml`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :video_vast_xml
|
attr_accessor :video_vast_xml
|
||||||
|
|
@ -1316,53 +1236,43 @@ module Google
|
||||||
class VideoMetadata
|
class VideoMetadata
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The duration of the ad.
|
# The duration of the ad. Can be used to filter the response of the creatives.
|
||||||
# Can be used to filter the response of the
|
# list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `duration`
|
# Corresponds to the JSON property `duration`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :duration
|
attr_accessor :duration
|
||||||
|
|
||||||
# Is this a valid VAST ad?
|
# Is this a valid VAST ad? Can be used to filter the response of the creatives.
|
||||||
# Can be used to filter the response of the
|
# list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `isValidVast`
|
# Corresponds to the JSON property `isValidVast`
|
||||||
# @return [Boolean]
|
# @return [Boolean]
|
||||||
attr_accessor :is_valid_vast
|
attr_accessor :is_valid_vast
|
||||||
alias_method :is_valid_vast?, :is_valid_vast
|
alias_method :is_valid_vast?, :is_valid_vast
|
||||||
|
|
||||||
# Is this a VPAID ad?
|
# Is this a VPAID ad? Can be used to filter the response of the creatives.list
|
||||||
# Can be used to filter the response of the
|
|
||||||
# creatives.list
|
|
||||||
# method.
|
# method.
|
||||||
# Corresponds to the JSON property `isVpaid`
|
# Corresponds to the JSON property `isVpaid`
|
||||||
# @return [Boolean]
|
# @return [Boolean]
|
||||||
attr_accessor :is_vpaid
|
attr_accessor :is_vpaid
|
||||||
alias_method :is_vpaid?, :is_vpaid
|
alias_method :is_vpaid?, :is_vpaid
|
||||||
|
|
||||||
# The list of all media files declared in the VAST. If there are multiple
|
# The list of all media files declared in the VAST. If there are multiple VASTs
|
||||||
# VASTs in a wrapper chain, this includes the media files from the deepest
|
# in a wrapper chain, this includes the media files from the deepest one in the
|
||||||
# one in the chain.
|
# chain.
|
||||||
# Corresponds to the JSON property `mediaFiles`
|
# Corresponds to the JSON property `mediaFiles`
|
||||||
# @return [Array<Google::Apis::RealtimebiddingV1::MediaFile>]
|
# @return [Array<Google::Apis::RealtimebiddingV1::MediaFile>]
|
||||||
attr_accessor :media_files
|
attr_accessor :media_files
|
||||||
|
|
||||||
# The minimum duration that the user has to watch before being able to
|
# The minimum duration that the user has to watch before being able to skip this
|
||||||
# skip this ad. If the field is not set, the ad is not skippable. If
|
# ad. If the field is not set, the ad is not skippable. If the field is set, the
|
||||||
# the field is set, the ad is skippable.
|
# ad is skippable. Can be used to filter the response of the creatives.list
|
||||||
# Can be used to filter the response of the
|
|
||||||
# creatives.list
|
|
||||||
# method.
|
# method.
|
||||||
# Corresponds to the JSON property `skipOffset`
|
# Corresponds to the JSON property `skipOffset`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :skip_offset
|
attr_accessor :skip_offset
|
||||||
|
|
||||||
# The maximum VAST version across all wrapped VAST documents.
|
# The maximum VAST version across all wrapped VAST documents. Can be used to
|
||||||
# Can be used to filter the response of the
|
# filter the response of the creatives.list method.
|
||||||
# creatives.list
|
|
||||||
# method.
|
|
||||||
# Corresponds to the JSON property `vastVersion`
|
# Corresponds to the JSON property `vastVersion`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :vast_version
|
attr_accessor :vast_version
|
||||||
|
|
@ -1382,8 +1292,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A request to receive push notifications when any of the creatives belonging
|
# A request to receive push notifications when any of the creatives belonging to
|
||||||
# to the bidder changes status.
|
# the bidder changes status.
|
||||||
class WatchCreativesRequest
|
class WatchCreativesRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -1402,21 +1312,18 @@ module Google
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The Pub/Sub subscription that can be used to pull creative status
|
# The Pub/Sub subscription that can be used to pull creative status
|
||||||
# notifications. This would be of the format
|
# notifications. This would be of the format `projects/`project_id`/
|
||||||
# `projects/`project_id`/subscriptions/`subscription_id``.
|
# subscriptions/`subscription_id``. Subscription is created with pull delivery.
|
||||||
# Subscription is created with pull delivery. All service accounts belonging
|
# All service accounts belonging to the bidder will have read access to this
|
||||||
# to the bidder will have read access to this subscription.
|
# subscription. Subscriptions that are inactive for more than 90 days will be
|
||||||
# Subscriptions that are inactive for more than 90 days will be disabled.
|
# disabled. Please use watchCreatives to re-enable the subscription.
|
||||||
# Please use
|
|
||||||
# watchCreatives to
|
|
||||||
# re-enable the subscription.
|
|
||||||
# Corresponds to the JSON property `subscription`
|
# Corresponds to the JSON property `subscription`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :subscription
|
attr_accessor :subscription
|
||||||
|
|
||||||
# The Pub/Sub topic that will be used to publish creative serving
|
# The Pub/Sub topic that will be used to publish creative serving status
|
||||||
# status notifications. This would be of the format
|
# notifications. This would be of the format `projects/`project_id`/topics/`
|
||||||
# `projects/`project_id`/topics/`topic_id``.
|
# topic_id``.
|
||||||
# Corresponds to the JSON property `topic`
|
# Corresponds to the JSON property `topic`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :topic
|
attr_accessor :topic
|
||||||
|
|
|
||||||
|
|
@ -52,44 +52,36 @@ module Google
|
||||||
|
|
||||||
# Lists creatives.
|
# Lists creatives.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the parent buyer that owns the creatives.
|
# Required. Name of the parent buyer that owns the creatives. The pattern for
|
||||||
# The pattern for this resource is either `buyers/`buyerAccountId`` or
|
# this resource is either `buyers/`buyerAccountId`` or `bidders/`bidderAccountId`
|
||||||
# `bidders/`bidderAccountId``.
|
# `. For `buyers/`buyerAccountId``, the `buyerAccountId` can be one of the
|
||||||
# For `buyers/`buyerAccountId``, the `buyerAccountId` can be one of the
|
# following: 1. The ID of the buyer that is accessing their own creatives. 2.
|
||||||
# following:
|
# The ID of the child seat buyer under a bidder account. So for listing
|
||||||
# 1. The ID of the buyer that is accessing their own creatives.
|
# creatives pertaining to the child seat buyer (`456`) under bidder account (`
|
||||||
# 2. The ID of the child seat buyer under a bidder account.
|
# 123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself.
|
||||||
# So for listing creatives pertaining to the child seat buyer (`456`)
|
# So for listing creatives pertaining to bidder (`123`), you would use `buyers/
|
||||||
# under bidder account (`123`), you would use the pattern: `buyers/456`.
|
# 123`. If you want to access all creatives pertaining to both the bidder and
|
||||||
# 3. The ID of the bidder itself.
|
# all of its child seat accounts, you would use `bidders/`bidderAccountId``, e.g.
|
||||||
# So for listing creatives pertaining to bidder (`123`),
|
# , for all creatives pertaining to bidder (`123`), use `bidders/123`.
|
||||||
# you would use `buyers/123`.
|
|
||||||
# If you want to access all creatives pertaining to both the bidder and all
|
|
||||||
# of its child seat accounts, you would use `bidders/`bidderAccountId``,
|
|
||||||
# e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`.
|
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# Query string to filter creatives. If no filter is specified,
|
# Query string to filter creatives. If no filter is specified, all active
|
||||||
# all active creatives will be returned.
|
# creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:
|
||||||
# Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND
|
# DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:
|
||||||
# disapprovalReason:UNACCEPTABLE_CONTENT) OR
|
# IS_COOKIE_TARGETED'
|
||||||
# declaredAttributes:IS_COOKIE_TARGETED'
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# Requested page size. The server may return fewer creatives than requested
|
# Requested page size. The server may return fewer creatives than requested (due
|
||||||
# (due to timeout constraint) even if more are available via another call.
|
# to timeout constraint) even if more are available via another call. If
|
||||||
# If unspecified, server will pick an appropriate default.
|
# unspecified, server will pick an appropriate default. Acceptable values are 1
|
||||||
# Acceptable values are 1 to 1000, inclusive.
|
# to 1000, inclusive.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A token identifying a page of results the server should return.
|
# A token identifying a page of results the server should return. Typically,
|
||||||
# Typically, this is the value of
|
# this is the value of ListCreativesResponse.nextPageToken returned from the
|
||||||
# ListCreativesResponse.nextPageToken
|
# previous call to the 'ListCreatives' method.
|
||||||
# returned from the previous call to the 'ListCreatives' method.
|
|
||||||
# @param [String] view
|
# @param [String] view
|
||||||
# Controls the amount of information included in the response.
|
# Controls the amount of information included in the response. By default only
|
||||||
# By default only
|
# creativeServingDecision is included. To retrieve the entire creative resource (
|
||||||
# creativeServingDecision
|
# including the declared fields and the creative content) specify the view as "
|
||||||
# is included. To retrieve the entire creative
|
# FULL".
|
||||||
# resource (including the declared
|
|
||||||
# fields and the creative content) specify the view as "FULL".
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -121,17 +113,15 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Watches all creatives pertaining to a bidder. It is sufficient to invoke
|
# Watches all creatives pertaining to a bidder. It is sufficient to invoke this
|
||||||
# this endpoint once per bidder. A Pub/Sub topic will be created and
|
# endpoint once per bidder. A Pub/Sub topic will be created and notifications
|
||||||
# notifications will be pushed to the topic when any of the bidder's
|
# will be pushed to the topic when any of the bidder's creatives change status.
|
||||||
# creatives change status. All of the bidder's service accounts will have
|
# All of the bidder's service accounts will have access to read from the topic.
|
||||||
# access to read from the topic.
|
# Subsequent invocations of this method will return the existing Pub/Sub
|
||||||
# Subsequent invocations of this method will return the existing
|
# configuration.
|
||||||
# Pub/Sub configuration.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. To watch all creatives pertaining to the bidder and all its child
|
# Required. To watch all creatives pertaining to the bidder and all its child
|
||||||
# seat
|
# seat accounts, the bidder must follow the pattern `bidders/`bidderAccountId``.
|
||||||
# accounts, the bidder must follow the pattern `bidders/`bidderAccountId``.
|
|
||||||
# @param [Google::Apis::RealtimebiddingV1::WatchCreativesRequest] watch_creatives_request_object
|
# @param [Google::Apis::RealtimebiddingV1::WatchCreativesRequest] watch_creatives_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -162,21 +152,16 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets remarketing tag for a buyer. A remarketing tag is a piece of
|
# Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript
|
||||||
# JavaScript code that can be placed on a web page. When a user
|
# code that can be placed on a web page. When a user visits a page containing a
|
||||||
# visits a page containing a remarketing tag, Google adds the user to a user
|
# remarketing tag, Google adds the user to a user list.
|
||||||
# list.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. To fetch remarketing tag for an account, name must follow the
|
# Required. To fetch remarketing tag for an account, name must follow the
|
||||||
# pattern
|
# pattern `buyers/`accountId`` where ``accountId`` represents ID of a buyer that
|
||||||
# `buyers/`accountId`` where ``accountId``
|
# owns the remarketing tag. For a bidder accessing remarketing tag on behalf of
|
||||||
# represents ID of a buyer that owns the remarketing tag. For a
|
# a child seat buyer, ``accountId`` should represent the ID of the child seat
|
||||||
# bidder accessing remarketing tag on behalf of a child seat buyer,
|
# buyer. To fetch remarketing tag for a specific user list, name must follow the
|
||||||
# ``accountId`` should represent the ID of the child seat buyer.
|
# pattern `buyers/`accountId`/userLists/`userListId``. See UserList.name.
|
||||||
# To fetch remarketing tag for a specific user list, name
|
|
||||||
# must follow the pattern
|
|
||||||
# `buyers/`accountId`/userLists/`userListId``. See
|
|
||||||
# UserList.name.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -207,11 +192,10 @@ module Google
|
||||||
# Creates a creative.
|
# Creates a creative.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the parent buyer that the new creative belongs to that
|
# Required. The name of the parent buyer that the new creative belongs to that
|
||||||
# must
|
# must follow the pattern `buyers/`buyerAccountId``, where ``buyerAccountId``
|
||||||
# follow the pattern `buyers/`buyerAccountId``, where ``buyerAccountId``
|
|
||||||
# represents the account ID of the buyer who owns a creative. For a bidder
|
# represents the account ID of the buyer who owns a creative. For a bidder
|
||||||
# accessing creatives on behalf of a child seat buyer, ``buyerAccountId``
|
# accessing creatives on behalf of a child seat buyer, ``buyerAccountId`` should
|
||||||
# should represent the account ID of the child seat buyer.
|
# represent the account ID of the child seat buyer.
|
||||||
# @param [Google::Apis::RealtimebiddingV1::Creative] creative_object
|
# @param [Google::Apis::RealtimebiddingV1::Creative] creative_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -244,15 +228,12 @@ module Google
|
||||||
|
|
||||||
# Gets a creative.
|
# Gets a creative.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. Name of the creative to retrieve. See
|
# Required. Name of the creative to retrieve. See creative.name.
|
||||||
# creative.name.
|
|
||||||
# @param [String] view
|
# @param [String] view
|
||||||
# Controls the amount of information included in the response.
|
# Controls the amount of information included in the response. By default only
|
||||||
# By default only
|
# creativeServingDecision is included. To retrieve the entire creative resource (
|
||||||
# creativeServingDecision
|
# including the declared fields and the creative content) specify the view as "
|
||||||
# is included. To retrieve the entire creative
|
# FULL".
|
||||||
# resource (including the declared
|
|
||||||
# fields and the creative content) specify the view as "FULL".
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -283,44 +264,36 @@ module Google
|
||||||
|
|
||||||
# Lists creatives.
|
# Lists creatives.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the parent buyer that owns the creatives.
|
# Required. Name of the parent buyer that owns the creatives. The pattern for
|
||||||
# The pattern for this resource is either `buyers/`buyerAccountId`` or
|
# this resource is either `buyers/`buyerAccountId`` or `bidders/`bidderAccountId`
|
||||||
# `bidders/`bidderAccountId``.
|
# `. For `buyers/`buyerAccountId``, the `buyerAccountId` can be one of the
|
||||||
# For `buyers/`buyerAccountId``, the `buyerAccountId` can be one of the
|
# following: 1. The ID of the buyer that is accessing their own creatives. 2.
|
||||||
# following:
|
# The ID of the child seat buyer under a bidder account. So for listing
|
||||||
# 1. The ID of the buyer that is accessing their own creatives.
|
# creatives pertaining to the child seat buyer (`456`) under bidder account (`
|
||||||
# 2. The ID of the child seat buyer under a bidder account.
|
# 123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself.
|
||||||
# So for listing creatives pertaining to the child seat buyer (`456`)
|
# So for listing creatives pertaining to bidder (`123`), you would use `buyers/
|
||||||
# under bidder account (`123`), you would use the pattern: `buyers/456`.
|
# 123`. If you want to access all creatives pertaining to both the bidder and
|
||||||
# 3. The ID of the bidder itself.
|
# all of its child seat accounts, you would use `bidders/`bidderAccountId``, e.g.
|
||||||
# So for listing creatives pertaining to bidder (`123`),
|
# , for all creatives pertaining to bidder (`123`), use `bidders/123`.
|
||||||
# you would use `buyers/123`.
|
|
||||||
# If you want to access all creatives pertaining to both the bidder and all
|
|
||||||
# of its child seat accounts, you would use `bidders/`bidderAccountId``,
|
|
||||||
# e.g., for all creatives pertaining to bidder (`123`), use `bidders/123`.
|
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# Query string to filter creatives. If no filter is specified,
|
# Query string to filter creatives. If no filter is specified, all active
|
||||||
# all active creatives will be returned.
|
# creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:
|
||||||
# Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND
|
# DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:
|
||||||
# disapprovalReason:UNACCEPTABLE_CONTENT) OR
|
# IS_COOKIE_TARGETED'
|
||||||
# declaredAttributes:IS_COOKIE_TARGETED'
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# Requested page size. The server may return fewer creatives than requested
|
# Requested page size. The server may return fewer creatives than requested (due
|
||||||
# (due to timeout constraint) even if more are available via another call.
|
# to timeout constraint) even if more are available via another call. If
|
||||||
# If unspecified, server will pick an appropriate default.
|
# unspecified, server will pick an appropriate default. Acceptable values are 1
|
||||||
# Acceptable values are 1 to 1000, inclusive.
|
# to 1000, inclusive.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A token identifying a page of results the server should return.
|
# A token identifying a page of results the server should return. Typically,
|
||||||
# Typically, this is the value of
|
# this is the value of ListCreativesResponse.nextPageToken returned from the
|
||||||
# ListCreativesResponse.nextPageToken
|
# previous call to the 'ListCreatives' method.
|
||||||
# returned from the previous call to the 'ListCreatives' method.
|
|
||||||
# @param [String] view
|
# @param [String] view
|
||||||
# Controls the amount of information included in the response.
|
# Controls the amount of information included in the response. By default only
|
||||||
# By default only
|
# creativeServingDecision is included. To retrieve the entire creative resource (
|
||||||
# creativeServingDecision
|
# including the declared fields and the creative content) specify the view as "
|
||||||
# is included. To retrieve the entire creative
|
# FULL".
|
||||||
# resource (including the declared
|
|
||||||
# fields and the creative content) specify the view as "FULL".
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -354,8 +327,7 @@ module Google
|
||||||
|
|
||||||
# Updates a creative.
|
# Updates a creative.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Name of the creative to update. See
|
# Name of the creative to update. See creative.name.
|
||||||
# creative.name.
|
|
||||||
# @param [Google::Apis::RealtimebiddingV1::Creative] creative_object
|
# @param [Google::Apis::RealtimebiddingV1::Creative] creative_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# Field mask to use for partial in-place updates.
|
# Field mask to use for partial in-place updates.
|
||||||
|
|
@ -389,11 +361,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Change the status of a user list to CLOSED. This prevents new users from
|
# Change the status of a user list to CLOSED. This prevents new users from being
|
||||||
# being added to the user list.
|
# added to the user list.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The name of the user list to close.
|
# Required. The name of the user list to close. See UserList.name
|
||||||
# See UserList.name
|
|
||||||
# @param [Google::Apis::RealtimebiddingV1::CloseUserListRequest] close_user_list_request_object
|
# @param [Google::Apis::RealtimebiddingV1::CloseUserListRequest] close_user_list_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -463,8 +434,7 @@ module Google
|
||||||
|
|
||||||
# Gets a user list by its name.
|
# Gets a user list by its name.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The name of the user list to be retrieved. See
|
# Required. The name of the user list to be retrieved. See UserList.name.
|
||||||
# UserList.name.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -492,21 +462,16 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets remarketing tag for a buyer. A remarketing tag is a piece of
|
# Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript
|
||||||
# JavaScript code that can be placed on a web page. When a user
|
# code that can be placed on a web page. When a user visits a page containing a
|
||||||
# visits a page containing a remarketing tag, Google adds the user to a user
|
# remarketing tag, Google adds the user to a user list.
|
||||||
# list.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. To fetch remarketing tag for an account, name must follow the
|
# Required. To fetch remarketing tag for an account, name must follow the
|
||||||
# pattern
|
# pattern `buyers/`accountId`` where ``accountId`` represents ID of a buyer that
|
||||||
# `buyers/`accountId`` where ``accountId``
|
# owns the remarketing tag. For a bidder accessing remarketing tag on behalf of
|
||||||
# represents ID of a buyer that owns the remarketing tag. For a
|
# a child seat buyer, ``accountId`` should represent the ID of the child seat
|
||||||
# bidder accessing remarketing tag on behalf of a child seat buyer,
|
# buyer. To fetch remarketing tag for a specific user list, name must follow the
|
||||||
# ``accountId`` should represent the ID of the child seat buyer.
|
# pattern `buyers/`accountId`/userLists/`userListId``. See UserList.name.
|
||||||
# To fetch remarketing tag for a specific user list, name
|
|
||||||
# must follow the pattern
|
|
||||||
# `buyers/`accountId`/userLists/`userListId``. See
|
|
||||||
# UserList.name.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -537,8 +502,7 @@ module Google
|
||||||
# Lists the user lists visible to the current user.
|
# Lists the user lists visible to the current user.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the parent buyer for the user lists to be returned that
|
# Required. The name of the parent buyer for the user lists to be returned that
|
||||||
# must
|
# must follow the pattern `buyers/`buyerAccountId``, where ``buyerAccountId``
|
||||||
# follow the pattern `buyers/`buyerAccountId``, where ``buyerAccountId``
|
|
||||||
# represents the account ID of the buyer who owns user lists. For a bidder
|
# represents the account ID of the buyer who owns user lists. For a bidder
|
||||||
# accessing user lists on behalf of a child seat buyer , ``buyerAccountId``
|
# accessing user lists on behalf of a child seat buyer , ``buyerAccountId``
|
||||||
# should represent the account ID of the child seat buyer.
|
# should represent the account ID of the child seat buyer.
|
||||||
|
|
@ -575,11 +539,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Change the status of a user list to OPEN. This allows new users to be added
|
# Change the status of a user list to OPEN. This allows new users to be added to
|
||||||
# to the user list.
|
# the user list.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The name of the user list to open.
|
# Required. The name of the user list to open. See UserList.name
|
||||||
# See UserList.name
|
|
||||||
# @param [Google::Apis::RealtimebiddingV1::OpenUserListRequest] open_user_list_request_object
|
# @param [Google::Apis::RealtimebiddingV1::OpenUserListRequest] open_user_list_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -613,12 +576,12 @@ module Google
|
||||||
# Update the given user list. Only user lists with URLRestrictions can be
|
# Update the given user list. Only user lists with URLRestrictions can be
|
||||||
# updated.
|
# updated.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Output only. Name of the user list that must follow the pattern
|
# Output only. Name of the user list that must follow the pattern `buyers/`buyer`
|
||||||
# `buyers/`buyer`/userLists/`user_list``, where ``buyer`` represents
|
# /userLists/`user_list``, where ``buyer`` represents the account ID of the
|
||||||
# the account ID of the buyer who owns the user list. For a bidder accessing
|
# buyer who owns the user list. For a bidder accessing user lists on behalf of a
|
||||||
# user lists on behalf of a child seat buyer, ``buyer`` represents
|
# child seat buyer, ``buyer`` represents the account ID of the child seat buyer.
|
||||||
# the account ID of the child seat buyer. ``user_list`` is an int64
|
# ``user_list`` is an int64 identifier assigned by Google to uniquely identify a
|
||||||
# identifier assigned by Google to uniquely identify a user list.
|
# user list.
|
||||||
# @param [Google::Apis::RealtimebiddingV1::UserList] user_list_object
|
# @param [Google::Apis::RealtimebiddingV1::UserList] user_list_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ module Google
|
||||||
# @see https://developers.google.com/spectrum-access-system/
|
# @see https://developers.google.com/spectrum-access-system/
|
||||||
module SasportalV1alpha1
|
module SasportalV1alpha1
|
||||||
VERSION = 'V1alpha1'
|
VERSION = 'V1alpha1'
|
||||||
REVISION = '20200722'
|
REVISION = '20200801'
|
||||||
|
|
||||||
# View your email address
|
# View your email address
|
||||||
AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email'
|
AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email'
|
||||||
|
|
|
||||||
|
|
@ -26,12 +26,10 @@ module Google
|
||||||
class SasPortalAssignment
|
class SasPortalAssignment
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The identities the role is assigned to. It can have the following
|
# The identities the role is assigned to. It can have the following values: * ``
|
||||||
# values:
|
# user_email``: An email address that represents a specific Google account. For
|
||||||
# * ``user_email``: An email address that represents a specific
|
# example: `alice@gmail.com`. * ``group_email``: An email address that
|
||||||
# Google account. For example: `alice@gmail.com`.
|
# represents a Google group. For example, `viewers@gmail.com`.
|
||||||
# * ``group_email``: An email address that represents a Google
|
|
||||||
# group. For example, `viewers@gmail.com`.
|
|
||||||
# Corresponds to the JSON property `members`
|
# Corresponds to the JSON property `members`
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :members
|
attr_accessor :members
|
||||||
|
|
@ -56,8 +54,8 @@ module Google
|
||||||
class SasPortalBulkCreateDeviceRequest
|
class SasPortalBulkCreateDeviceRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Required. A csv with each row representing a [device]. Each row must
|
# Required. A csv with each row representing a [device]. Each row must conform
|
||||||
# conform to the regulations described on CreateDeviceRequest's device field.
|
# to the regulations described on CreateDeviceRequest's device field.
|
||||||
# Corresponds to the JSON property `csv`
|
# Corresponds to the JSON property `csv`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :csv
|
attr_accessor :csv
|
||||||
|
|
@ -95,8 +93,8 @@ module Google
|
||||||
class SasPortalCreateSignedDeviceRequest
|
class SasPortalCreateSignedDeviceRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Required. JSON Web Token signed using a CPI private key. Payload
|
# Required. JSON Web Token signed using a CPI private key. Payload must be the
|
||||||
# must be the JSON encoding of the [Device]. The user_id field must be set.
|
# JSON encoding of the [Device]. The user_id field must be set.
|
||||||
# Corresponds to the JSON property `encodedDevice`
|
# Corresponds to the JSON property `encodedDevice`
|
||||||
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
||||||
# @return [String]
|
# @return [String]
|
||||||
|
|
@ -189,8 +187,7 @@ module Google
|
||||||
# @return [Google::Apis::SasportalV1alpha1::SasPortalDeviceConfig]
|
# @return [Google::Apis::SasportalV1alpha1::SasPortalDeviceConfig]
|
||||||
attr_accessor :preloaded_config
|
attr_accessor :preloaded_config
|
||||||
|
|
||||||
# A serial number assigned to the device by the device
|
# A serial number assigned to the device by the device manufacturer.
|
||||||
# manufacturer.
|
|
||||||
# Corresponds to the JSON property `serialNumber`
|
# Corresponds to the JSON property `serialNumber`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :serial_number
|
attr_accessor :serial_number
|
||||||
|
|
@ -230,8 +227,7 @@ module Google
|
||||||
|
|
||||||
# This field is related to the radioTechnology field and provides the air
|
# This field is related to the radioTechnology field and provides the air
|
||||||
# interface specification that the CBSD is compliant with at the time of
|
# interface specification that the CBSD is compliant with at the time of
|
||||||
# registration.
|
# registration. Optional
|
||||||
# Optional
|
|
||||||
# Corresponds to the JSON property `supportedSpec`
|
# Corresponds to the JSON property `supportedSpec`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :supported_spec
|
attr_accessor :supported_spec
|
||||||
|
|
@ -321,9 +317,9 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Device grant. It is an authorization provided by the Spectrum
|
# Device grant. It is an authorization provided by the Spectrum Access System to
|
||||||
# Access System to a device to transmit using specified operating
|
# a device to transmit using specified operating parameters after a successful
|
||||||
# parameters after a successful heartbeat by the device.
|
# heartbeat by the device.
|
||||||
class SasPortalDeviceGrant
|
class SasPortalDeviceGrant
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -342,10 +338,10 @@ module Google
|
||||||
# @return [Google::Apis::SasportalV1alpha1::SasPortalFrequencyRange]
|
# @return [Google::Apis::SasportalV1alpha1::SasPortalFrequencyRange]
|
||||||
attr_accessor :frequency_range
|
attr_accessor :frequency_range
|
||||||
|
|
||||||
# Maximum Equivalent Isotropically Radiated Power (EIRP) permitted
|
# Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant.
|
||||||
# by the grant. The maximum EIRP is in units of dBm/MHz. The
|
# The maximum EIRP is in units of dBm/MHz. The value of maxEirp represents the
|
||||||
# value of maxEirp represents the average (RMS) EIRP that would be
|
# average (RMS) EIRP that would be measured by the procedure defined in FCC part
|
||||||
# measured by the procedure defined in FCC part 96.41(e)(3).
|
# 96.41(e)(3).
|
||||||
# Corresponds to the JSON property `maxEirp`
|
# Corresponds to the JSON property `maxEirp`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :max_eirp
|
attr_accessor :max_eirp
|
||||||
|
|
@ -462,13 +458,11 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# A generic empty message that you can re-use to avoid defining duplicated
|
# A generic empty message that you can re-use to avoid defining duplicated empty
|
||||||
# empty messages in your APIs. A typical example is to use it as the request
|
# messages in your APIs. A typical example is to use it as the request or the
|
||||||
# or the response type of an API method. For instance:
|
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
||||||
# service Foo `
|
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
||||||
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
# `Empty` is empty JSON object ````.
|
||||||
# `
|
|
||||||
# The JSON representation for `Empty` is empty JSON object ````.
|
|
||||||
class SasPortalEmpty
|
class SasPortalEmpty
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -506,8 +500,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Request for GenerateSecret method]
|
# Request for GenerateSecret method] [spectrum.sas.portal.v1alpha1.DeviceManager.
|
||||||
# [spectrum.sas.portal.v1alpha1.DeviceManager.GenerateSecret].
|
# GenerateSecret].
|
||||||
class SasPortalGenerateSecretRequest
|
class SasPortalGenerateSecretRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -524,8 +518,7 @@ module Google
|
||||||
class SasPortalGenerateSecretResponse
|
class SasPortalGenerateSecretResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The secret generated by the string and used by
|
# The secret generated by the string and used by [ValidateInstaller] method.
|
||||||
# [ValidateInstaller] method.
|
|
||||||
# Corresponds to the JSON property `secret`
|
# Corresponds to the JSON property `secret`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :secret
|
attr_accessor :secret
|
||||||
|
|
@ -563,41 +556,39 @@ module Google
|
||||||
class SasPortalInstallationParams
|
class SasPortalInstallationParams
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Boresight direction of the horizontal plane of the antenna in
|
# Boresight direction of the horizontal plane of the antenna in degrees with
|
||||||
# degrees with respect to true north. The value of this parameter
|
# respect to true north. The value of this parameter is an integer with a value
|
||||||
# is an integer with a value between 0 and 359 inclusive. A value
|
# between 0 and 359 inclusive. A value of 0 degrees means true north; a value of
|
||||||
# of 0 degrees means true north; a value of 90 degrees means
|
# 90 degrees means east. This parameter is optional for Category A devices and
|
||||||
# east. This parameter is optional for Category A devices and
|
|
||||||
# conditional for Category B devices.
|
# conditional for Category B devices.
|
||||||
# Corresponds to the JSON property `antennaAzimuth`
|
# Corresponds to the JSON property `antennaAzimuth`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :antenna_azimuth
|
attr_accessor :antenna_azimuth
|
||||||
|
|
||||||
# 3-dB antenna beamwidth of the antenna in the horizontal-plane in
|
# 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This
|
||||||
# degrees. This parameter is an unsigned integer having a value
|
# parameter is an unsigned integer having a value between 0 and 360 (degrees)
|
||||||
# between 0 and 360 (degrees) inclusive; it is optional for
|
# inclusive; it is optional for Category A devices and conditional for Category
|
||||||
# Category A devices and conditional for Category B devices.
|
# B devices.
|
||||||
# Corresponds to the JSON property `antennaBeamwidth`
|
# Corresponds to the JSON property `antennaBeamwidth`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :antenna_beamwidth
|
attr_accessor :antenna_beamwidth
|
||||||
|
|
||||||
# Antenna downtilt in degrees and is an integer with a value
|
# Antenna downtilt in degrees and is an integer with a value between -90 and +90
|
||||||
# between -90 and +90 inclusive; a negative value means the antenna
|
# inclusive; a negative value means the antenna is tilted up (above horizontal).
|
||||||
# is tilted up (above horizontal). This parameter is optional for
|
# This parameter is optional for Category A devices and conditional for Category
|
||||||
# Category A devices and conditional for Category B devices.
|
# B devices.
|
||||||
# Corresponds to the JSON property `antennaDowntilt`
|
# Corresponds to the JSON property `antennaDowntilt`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :antenna_downtilt
|
attr_accessor :antenna_downtilt
|
||||||
|
|
||||||
# Peak antenna gain in dBi. This parameter is an integer with a
|
# Peak antenna gain in dBi. This parameter is an integer with a value between -
|
||||||
# value between -127 and +128 (dBi) inclusive.
|
# 127 and +128 (dBi) inclusive.
|
||||||
# Corresponds to the JSON property `antennaGain`
|
# Corresponds to the JSON property `antennaGain`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :antenna_gain
|
attr_accessor :antenna_gain
|
||||||
|
|
||||||
# If an external antenna is used, the antenna model is optionally
|
# If an external antenna is used, the antenna model is optionally provided in
|
||||||
# provided in this field. The string has a maximum length of 128
|
# this field. The string has a maximum length of 128 octets.
|
||||||
# octets.
|
|
||||||
# Corresponds to the JSON property `antennaModel`
|
# Corresponds to the JSON property `antennaModel`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :antenna_model
|
attr_accessor :antenna_model
|
||||||
|
|
@ -608,18 +599,17 @@ module Google
|
||||||
attr_accessor :cpe_cbsd_indication
|
attr_accessor :cpe_cbsd_indication
|
||||||
alias_method :cpe_cbsd_indication?, :cpe_cbsd_indication
|
alias_method :cpe_cbsd_indication?, :cpe_cbsd_indication
|
||||||
|
|
||||||
# This parameter is the maximum device EIRP in units of dBm/10MHz
|
# This parameter is the maximum device EIRP in units of dBm/10MHz and is an
|
||||||
# and is an integer with a value between -127 and +47 (dBm/10 MHz)
|
# integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not
|
||||||
# inclusive. If not included, SAS interprets it as maximum
|
# included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz
|
||||||
# allowable EIRP in units of dBm/10MHz for device category.
|
# for device category.
|
||||||
# Corresponds to the JSON property `eirpCapability`
|
# Corresponds to the JSON property `eirpCapability`
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :eirp_capability
|
attr_accessor :eirp_capability
|
||||||
|
|
||||||
# Device antenna height in meters. When the heightType parameter
|
# Device antenna height in meters. When the heightType parameter value is "AGL",
|
||||||
# value is "AGL", the antenna height should be given relative to
|
# the antenna height should be given relative to ground level. When the
|
||||||
# ground level. When the heightType parameter value is "AMSL", it
|
# heightType parameter value is "AMSL", it is given with respect to WGS84 datum.
|
||||||
# is given with respect to WGS84 datum.
|
|
||||||
# Corresponds to the JSON property `height`
|
# Corresponds to the JSON property `height`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :height
|
attr_accessor :height
|
||||||
|
|
@ -629,42 +619,37 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :height_type
|
attr_accessor :height_type
|
||||||
|
|
||||||
# A positive number in meters to indicate accuracy of the device
|
# A positive number in meters to indicate accuracy of the device antenna
|
||||||
# antenna horizontal location. This optional parameter should only
|
# horizontal location. This optional parameter should only be present if its
|
||||||
# be present if its value is less than the FCC requirement of 50
|
# value is less than the FCC requirement of 50 meters.
|
||||||
# meters.
|
|
||||||
# Corresponds to the JSON property `horizontalAccuracy`
|
# Corresponds to the JSON property `horizontalAccuracy`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :horizontal_accuracy
|
attr_accessor :horizontal_accuracy
|
||||||
|
|
||||||
# Whether the device antenna is indoor or not. True: indoor. False:
|
# Whether the device antenna is indoor or not. True: indoor. False: outdoor.
|
||||||
# outdoor.
|
|
||||||
# Corresponds to the JSON property `indoorDeployment`
|
# Corresponds to the JSON property `indoorDeployment`
|
||||||
# @return [Boolean]
|
# @return [Boolean]
|
||||||
attr_accessor :indoor_deployment
|
attr_accessor :indoor_deployment
|
||||||
alias_method :indoor_deployment?, :indoor_deployment
|
alias_method :indoor_deployment?, :indoor_deployment
|
||||||
|
|
||||||
# Latitude of the device antenna location in degrees relative to
|
# Latitude of the device antenna location in degrees relative to the WGS 84
|
||||||
# the WGS 84 datum. The allowed range is from -90.000000 to
|
# datum. The allowed range is from -90.000000 to +90.000000. Positive values
|
||||||
# +90.000000. Positive values represent latitudes north of the
|
# represent latitudes north of the equator; negative values south of the equator.
|
||||||
# equator; negative values south of the equator.
|
|
||||||
# Corresponds to the JSON property `latitude`
|
# Corresponds to the JSON property `latitude`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :latitude
|
attr_accessor :latitude
|
||||||
|
|
||||||
# Longitude of the device antenna location. in degrees relative to
|
# Longitude of the device antenna location. in degrees relative to the WGS 84
|
||||||
# the WGS 84 datum. The allowed range is from -180.000000 to
|
# datum. The allowed range is from -180.000000 to +180.000000. Positive values
|
||||||
# +180.000000. Positive values represent longitudes east of the
|
# represent longitudes east of the prime meridian; negative values west of the
|
||||||
# prime meridian; negative values west of the prime
|
# prime meridian.
|
||||||
# meridian.
|
|
||||||
# Corresponds to the JSON property `longitude`
|
# Corresponds to the JSON property `longitude`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :longitude
|
attr_accessor :longitude
|
||||||
|
|
||||||
# A positive number in meters to indicate accuracy of the device
|
# A positive number in meters to indicate accuracy of the device antenna
|
||||||
# antenna vertical location. This optional parameter should only be
|
# vertical location. This optional parameter should only be present if its value
|
||||||
# present if its value is less than the FCC requirement of 3
|
# is less than the FCC requirement of 3 meters.
|
||||||
# meters.
|
|
||||||
# Corresponds to the JSON property `verticalAccuracy`
|
# Corresponds to the JSON property `verticalAccuracy`
|
||||||
# @return [Float]
|
# @return [Float]
|
||||||
attr_accessor :vertical_accuracy
|
attr_accessor :vertical_accuracy
|
||||||
|
|
@ -696,16 +681,14 @@ module Google
|
||||||
class SasPortalListCustomersResponse
|
class SasPortalListCustomersResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The list of customers that
|
# The list of customers that match the request.
|
||||||
# match the request.
|
|
||||||
# Corresponds to the JSON property `customers`
|
# Corresponds to the JSON property `customers`
|
||||||
# @return [Array<Google::Apis::SasportalV1alpha1::SasPortalCustomer>]
|
# @return [Array<Google::Apis::SasportalV1alpha1::SasPortalCustomer>]
|
||||||
attr_accessor :customers
|
attr_accessor :customers
|
||||||
|
|
||||||
# A pagination token returned from a previous call to ListCustomers method that
|
# A pagination token returned from a previous call to ListCustomers method that
|
||||||
# indicates from
|
# indicates from where listing should continue. If the field is missing or empty,
|
||||||
# where listing should continue. If the field is missing or empty, it means
|
# it means there are no more customers.
|
||||||
# there are no more customers.
|
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -730,9 +713,9 @@ module Google
|
||||||
# @return [Array<Google::Apis::SasportalV1alpha1::SasPortalDevice>]
|
# @return [Array<Google::Apis::SasportalV1alpha1::SasPortalDevice>]
|
||||||
attr_accessor :devices
|
attr_accessor :devices
|
||||||
|
|
||||||
# A pagination token returned from a previous call to ListDevices method
|
# A pagination token returned from a previous call to ListDevices method that
|
||||||
# that indicates from where listing should continue. If the field
|
# indicates from where listing should continue. If the field is missing or empty,
|
||||||
# is missing or empty, it means there is no more devices.
|
# it means there is no more devices.
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -752,10 +735,9 @@ module Google
|
||||||
class SasPortalListNodesResponse
|
class SasPortalListNodesResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# A pagination token returned from a previous call to
|
# A pagination token returned from a previous call to ListNodes method that
|
||||||
# ListNodes method
|
# indicates from where listing should continue. If the field is missing or empty,
|
||||||
# that indicates from where listing should continue. If the field is missing
|
# it means there is no more nodes.
|
||||||
# or empty, it means there is no more nodes.
|
|
||||||
# Corresponds to the JSON property `nextPageToken`
|
# Corresponds to the JSON property `nextPageToken`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :next_page_token
|
attr_accessor :next_page_token
|
||||||
|
|
@ -780,8 +762,8 @@ module Google
|
||||||
class SasPortalMoveDeviceRequest
|
class SasPortalMoveDeviceRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Required. The name of the new parent resource (Node or Customer) to
|
# Required. The name of the new parent resource (Node or Customer) to reparent
|
||||||
# reparent the device under.
|
# the device under.
|
||||||
# Corresponds to the JSON property `destination`
|
# Corresponds to the JSON property `destination`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :destination
|
attr_accessor :destination
|
||||||
|
|
@ -852,47 +834,45 @@ module Google
|
||||||
class SasPortalOperation
|
class SasPortalOperation
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# If the value is `false`, it means the operation is still in progress.
|
# If the value is `false`, it means the operation is still in progress. If `true`
|
||||||
# If `true`, the operation is completed, and either `error` or `response` is
|
# , the operation is completed, and either `error` or `response` is available.
|
||||||
# available.
|
|
||||||
# Corresponds to the JSON property `done`
|
# Corresponds to the JSON property `done`
|
||||||
# @return [Boolean]
|
# @return [Boolean]
|
||||||
attr_accessor :done
|
attr_accessor :done
|
||||||
alias_method :done?, :done
|
alias_method :done?, :done
|
||||||
|
|
||||||
# The `Status` type defines a logical error model that is suitable for
|
# The `Status` type defines a logical error model that is suitable for different
|
||||||
# different programming environments, including REST APIs and RPC APIs. It is
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
||||||
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
||||||
# three pieces of data: error code, error message, and error details.
|
# data: error code, error message, and error details. You can find out more
|
||||||
# You can find out more about this error model and how to work with it in the
|
# about this error model and how to work with it in the [API Design Guide](https:
|
||||||
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
# //cloud.google.com/apis/design/errors).
|
||||||
# Corresponds to the JSON property `error`
|
# Corresponds to the JSON property `error`
|
||||||
# @return [Google::Apis::SasportalV1alpha1::SasPortalStatus]
|
# @return [Google::Apis::SasportalV1alpha1::SasPortalStatus]
|
||||||
attr_accessor :error
|
attr_accessor :error
|
||||||
|
|
||||||
# Service-specific metadata associated with the operation. It typically
|
# Service-specific metadata associated with the operation. It typically contains
|
||||||
# contains progress information and common metadata such as create time.
|
# progress information and common metadata such as create time. Some services
|
||||||
# Some services might not provide such metadata. Any method that returns a
|
# might not provide such metadata. Any method that returns a long-running
|
||||||
# long-running operation should document the metadata type, if any.
|
# operation should document the metadata type, if any.
|
||||||
# Corresponds to the JSON property `metadata`
|
# Corresponds to the JSON property `metadata`
|
||||||
# @return [Hash<String,Object>]
|
# @return [Hash<String,Object>]
|
||||||
attr_accessor :metadata
|
attr_accessor :metadata
|
||||||
|
|
||||||
# The server-assigned name, which is only unique within the same service that
|
# The server-assigned name, which is only unique within the same service that
|
||||||
# originally returns it. If you use the default HTTP mapping, the
|
# originally returns it. If you use the default HTTP mapping, the `name` should
|
||||||
# `name` should be a resource name ending with `operations/`unique_id``.
|
# be a resource name ending with `operations/`unique_id``.
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# The normal response of the operation in case of success. If the original
|
# 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
|
# method returns no data on success, such as `Delete`, the response is `google.
|
||||||
# `google.protobuf.Empty`. If the original method is standard
|
# protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
|
||||||
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
# the response should be the resource. For other methods, the response should
|
||||||
# methods, the response should have the type `XxxResponse`, where `Xxx`
|
# have the type `XxxResponse`, where `Xxx` is the original method name. For
|
||||||
# is the original method name. For example, if the original method name
|
# example, if the original method name is `TakeSnapshot()`, the inferred
|
||||||
# is `TakeSnapshot()`, the inferred response type is
|
# response type is `TakeSnapshotResponse`.
|
||||||
# `TakeSnapshotResponse`.
|
|
||||||
# Corresponds to the JSON property `response`
|
# Corresponds to the JSON property `response`
|
||||||
# @return [Hash<String,Object>]
|
# @return [Hash<String,Object>]
|
||||||
attr_accessor :response
|
attr_accessor :response
|
||||||
|
|
@ -920,16 +900,14 @@ module Google
|
||||||
# @return [Array<Google::Apis::SasportalV1alpha1::SasPortalAssignment>]
|
# @return [Array<Google::Apis::SasportalV1alpha1::SasPortalAssignment>]
|
||||||
attr_accessor :assignments
|
attr_accessor :assignments
|
||||||
|
|
||||||
# The [etag] is used for optimistic concurrency control as a way to
|
# The [etag] is used for optimistic concurrency control as a way to help prevent
|
||||||
# help prevent simultaneous updates of a policy from overwriting
|
# simultaneous updates of a policy from overwriting each other. It is strongly
|
||||||
# each other. It is strongly suggested that systems make use of
|
# suggested that systems make use of the [etag] in the read-modify-write cycle
|
||||||
# the [etag] in the read-modify-write cycle to perform policy
|
# to perform policy updates in order to avoid race conditions: An [etag] is
|
||||||
# updates in order to avoid race conditions: An [etag] is returned
|
# returned in the response to [GetPolicy], and systems are expected to put that
|
||||||
# in the response to [GetPolicy], and systems are expected to put
|
# etag in the request to [SetPolicy] to ensure that their change will be applied
|
||||||
# that etag in the request to [SetPolicy] to ensure that their
|
# to the same version of the policy. If no [etag] is provided in the call to [
|
||||||
# change will be applied to the same version of the policy.
|
# SetPolicy], then the existing policy is overwritten blindly.
|
||||||
# If no [etag] is provided in the call to [SetPolicy], then the
|
|
||||||
# existing policy is overwritten blindly.
|
|
||||||
# Corresponds to the JSON property `etag`
|
# Corresponds to the JSON property `etag`
|
||||||
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
||||||
# @return [String]
|
# @return [String]
|
||||||
|
|
@ -976,9 +954,8 @@ module Google
|
||||||
class SasPortalSignDeviceRequest
|
class SasPortalSignDeviceRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Required. The device to sign.
|
# Required. The device to sign. The device fields name, fcc_id and serial_number
|
||||||
# The device fields name, fcc_id and serial_number must be set.
|
# must be set. The user_id field must be set.
|
||||||
# The user_id field must be set.
|
|
||||||
# Corresponds to the JSON property `device`
|
# Corresponds to the JSON property `device`
|
||||||
# @return [Google::Apis::SasportalV1alpha1::SasPortalDevice]
|
# @return [Google::Apis::SasportalV1alpha1::SasPortalDevice]
|
||||||
attr_accessor :device
|
attr_accessor :device
|
||||||
|
|
@ -993,12 +970,12 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# The `Status` type defines a logical error model that is suitable for
|
# The `Status` type defines a logical error model that is suitable for different
|
||||||
# different programming environments, including REST APIs and RPC APIs. It is
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
||||||
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
||||||
# three pieces of data: error code, error message, and error details.
|
# data: error code, error message, and error details. You can find out more
|
||||||
# You can find out more about this error model and how to work with it in the
|
# about this error model and how to work with it in the [API Design Guide](https:
|
||||||
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
# //cloud.google.com/apis/design/errors).
|
||||||
class SasPortalStatus
|
class SasPortalStatus
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -1007,15 +984,15 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :code
|
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.
|
# message types for APIs to use.
|
||||||
# Corresponds to the JSON property `details`
|
# Corresponds to the JSON property `details`
|
||||||
# @return [Array<Hash<String,Object>>]
|
# @return [Array<Hash<String,Object>>]
|
||||||
attr_accessor :details
|
attr_accessor :details
|
||||||
|
|
||||||
# A developer-facing error message, which should be in English. Any
|
# A developer-facing error message, which should be in English. Any user-facing
|
||||||
# user-facing error message should be localized and sent in the
|
# error message should be localized and sent in the google.rpc.Status.details
|
||||||
# google.rpc.Status.details field, or localized by the client.
|
# field, or localized by the client.
|
||||||
# Corresponds to the JSON property `message`
|
# Corresponds to the JSON property `message`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :message
|
attr_accessor :message
|
||||||
|
|
@ -1080,9 +1057,8 @@ module Google
|
||||||
class SasPortalUpdateSignedDeviceRequest
|
class SasPortalUpdateSignedDeviceRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Required. The JSON Web Token signed using a CPI private key. Payload
|
# Required. The JSON Web Token signed using a CPI private key. Payload must be
|
||||||
# must be the JSON encoding
|
# the JSON encoding of the device. The user_id field must be set.
|
||||||
# of the device. The user_id field must be set.
|
|
||||||
# Corresponds to the JSON property `encodedDevice`
|
# Corresponds to the JSON property `encodedDevice`
|
||||||
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
||||||
# @return [String]
|
# @return [String]
|
||||||
|
|
@ -1109,14 +1085,14 @@ module Google
|
||||||
class SasPortalValidateInstallerRequest
|
class SasPortalValidateInstallerRequest
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Required. JSON Web Token signed using a CPI private key. Payload
|
# Required. JSON Web Token signed using a CPI private key. Payload must include
|
||||||
# must include a "secret" claim whose value is the secret.
|
# a "secret" claim whose value is the secret.
|
||||||
# Corresponds to the JSON property `encodedSecret`
|
# Corresponds to the JSON property `encodedSecret`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :encoded_secret
|
attr_accessor :encoded_secret
|
||||||
|
|
||||||
# Required. Unique installer id (cpiId) from the Certified
|
# Required. Unique installer id (cpiId) from the Certified Professional
|
||||||
# Professional Installers database.
|
# Installers database.
|
||||||
# Corresponds to the JSON property `installerId`
|
# Corresponds to the JSON property `installerId`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :installer_id
|
attr_accessor :installer_id
|
||||||
|
|
@ -1138,8 +1114,8 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Response for ValidateInstaller method]
|
# Response for ValidateInstaller method] [spectrum.sas.portal.v1alpha1.
|
||||||
# [spectrum.sas.portal.v1alpha1.DeviceManager.ValidateInstaller].
|
# DeviceManager.ValidateInstaller].
|
||||||
class SasPortalValidateInstallerResponse
|
class SasPortalValidateInstallerResponse
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -79,12 +79,10 @@ module Google
|
||||||
|
|
||||||
# Returns a list of requested customers.
|
# Returns a list of requested customers.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of customers
|
# The maximum number of customers to return in the response.
|
||||||
# to return in the response.
|
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListCustomers method that
|
# A pagination token returned from a previous call to ListCustomers method that
|
||||||
# indicates where
|
# indicates where this listing should continue from.
|
||||||
# this listing should continue from.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -215,8 +213,7 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Creates a signed device under a
|
# Creates a signed device under a node or customer.
|
||||||
# node or customer.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the parent resource.
|
# Required. The name of the parent resource.
|
||||||
# @param [Google::Apis::SasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object
|
# @param [Google::Apis::SasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object
|
||||||
|
|
@ -313,16 +310,15 @@ module Google
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the parent resource.
|
# Required. The name of the parent resource.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# The filter expression. The filter should have one of the following
|
# The filter expression. The filter should have one of the following formats: "
|
||||||
# formats: "sn=123454" or "display_name=MyDevice". sn
|
# sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the
|
||||||
# corresponds to serial_number of the device. The filter is case insensitive.
|
# device. The filter is case insensitive.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of devices to return in the response.
|
# The maximum number of devices to return in the response. If empty or zero, all
|
||||||
# If empty or zero, all devices will be listed.
|
# devices will be listed. Must be in the range [0, 1000].
|
||||||
# Must be in the range [0, 1000].
|
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListDevices
|
# A pagination token returned from a previous call to ListDevices that indicates
|
||||||
# that indicates where this listing should continue from.
|
# where this listing should continue from.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -587,8 +583,8 @@ module Google
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of nodes to return in the response.
|
# The maximum number of nodes to return in the response.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListNodes method
|
# A pagination token returned from a previous call to ListNodes method that
|
||||||
# that indicates where this listing should continue from.
|
# indicates where this listing should continue from.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -620,8 +616,7 @@ module Google
|
||||||
|
|
||||||
# Moves a node under another node or customer.
|
# Moves a node under another node or customer.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The name of the node to
|
# Required. The name of the node to move.
|
||||||
# move.
|
|
||||||
# @param [Google::Apis::SasportalV1alpha1::SasPortalMoveNodeRequest] sas_portal_move_node_request_object
|
# @param [Google::Apis::SasportalV1alpha1::SasPortalMoveNodeRequest] sas_portal_move_node_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -727,8 +722,8 @@ module Google
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of nodes to return in the response.
|
# The maximum number of nodes to return in the response.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListNodes method
|
# A pagination token returned from a previous call to ListNodes method that
|
||||||
# that indicates where this listing should continue from.
|
# indicates where this listing should continue from.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -914,8 +909,7 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Creates a signed device under a
|
# Creates a signed device under a node or customer.
|
||||||
# node or customer.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the parent resource.
|
# Required. The name of the parent resource.
|
||||||
# @param [Google::Apis::SasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object
|
# @param [Google::Apis::SasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object
|
||||||
|
|
@ -1012,16 +1006,15 @@ module Google
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the parent resource.
|
# Required. The name of the parent resource.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# The filter expression. The filter should have one of the following
|
# The filter expression. The filter should have one of the following formats: "
|
||||||
# formats: "sn=123454" or "display_name=MyDevice". sn
|
# sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the
|
||||||
# corresponds to serial_number of the device. The filter is case insensitive.
|
# device. The filter is case insensitive.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of devices to return in the response.
|
# The maximum number of devices to return in the response. If empty or zero, all
|
||||||
# If empty or zero, all devices will be listed.
|
# devices will be listed. Must be in the range [0, 1000].
|
||||||
# Must be in the range [0, 1000].
|
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListDevices
|
# A pagination token returned from a previous call to ListDevices that indicates
|
||||||
# that indicates where this listing should continue from.
|
# where this listing should continue from.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1286,8 +1279,8 @@ module Google
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of nodes to return in the response.
|
# The maximum number of nodes to return in the response.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListNodes method
|
# A pagination token returned from a previous call to ListNodes method that
|
||||||
# that indicates where this listing should continue from.
|
# indicates where this listing should continue from.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1319,8 +1312,7 @@ module Google
|
||||||
|
|
||||||
# Moves a node under another node or customer.
|
# Moves a node under another node or customer.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The name of the node to
|
# Required. The name of the node to move.
|
||||||
# move.
|
|
||||||
# @param [Google::Apis::SasportalV1alpha1::SasPortalMoveNodeRequest] sas_portal_move_node_request_object
|
# @param [Google::Apis::SasportalV1alpha1::SasPortalMoveNodeRequest] sas_portal_move_node_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -1453,8 +1445,7 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Creates a signed device under a
|
# Creates a signed device under a node or customer.
|
||||||
# node or customer.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the parent resource.
|
# Required. The name of the parent resource.
|
||||||
# @param [Google::Apis::SasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object
|
# @param [Google::Apis::SasportalV1alpha1::SasPortalCreateSignedDeviceRequest] sas_portal_create_signed_device_request_object
|
||||||
|
|
@ -1491,16 +1482,15 @@ module Google
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. The name of the parent resource.
|
# Required. The name of the parent resource.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# The filter expression. The filter should have one of the following
|
# The filter expression. The filter should have one of the following formats: "
|
||||||
# formats: "sn=123454" or "display_name=MyDevice". sn
|
# sn=123454" or "display_name=MyDevice". sn corresponds to serial_number of the
|
||||||
# corresponds to serial_number of the device. The filter is case insensitive.
|
# device. The filter is case insensitive.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of devices to return in the response.
|
# The maximum number of devices to return in the response. If empty or zero, all
|
||||||
# If empty or zero, all devices will be listed.
|
# devices will be listed. Must be in the range [0, 1000].
|
||||||
# Must be in the range [0, 1000].
|
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListDevices
|
# A pagination token returned from a previous call to ListDevices that indicates
|
||||||
# that indicates where this listing should continue from.
|
# where this listing should continue from.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1570,8 +1560,8 @@ module Google
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of nodes to return in the response.
|
# The maximum number of nodes to return in the response.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# A pagination token returned from a previous call to ListNodes method
|
# A pagination token returned from a previous call to ListNodes method that
|
||||||
# that indicates where this listing should continue from.
|
# indicates where this listing should continue from.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1601,9 +1591,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the access control policy for a resource.
|
# Gets the access control policy for a resource. Returns an empty policy if the
|
||||||
# Returns an empty policy if the resource exists and does not have a policy
|
# resource exists and does not have a policy set.
|
||||||
# set.
|
|
||||||
# @param [Google::Apis::SasportalV1alpha1::SasPortalGetPolicyRequest] sas_portal_get_policy_request_object
|
# @param [Google::Apis::SasportalV1alpha1::SasPortalGetPolicyRequest] sas_portal_get_policy_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ module Google
|
||||||
# @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview
|
# @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview
|
||||||
module SecuritycenterV1
|
module SecuritycenterV1
|
||||||
VERSION = 'V1'
|
VERSION = 'V1'
|
||||||
REVISION = '20200619'
|
REVISION = '20200731'
|
||||||
|
|
||||||
# View and manage your data across Google Cloud Platform services
|
# View and manage your data across Google Cloud Platform services
|
||||||
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -51,8 +51,7 @@ module Google
|
||||||
# Gets the settings for an organization.
|
# Gets the settings for an organization.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. Name of the organization to get organization settings for. Its
|
# Required. Name of the organization to get organization settings for. Its
|
||||||
# format is
|
# format is "organizations/[organization_id]/organizationSettings".
|
||||||
# "organizations/[organization_id]/organizationSettings".
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -82,14 +81,13 @@ module Google
|
||||||
|
|
||||||
# Updates an organization's settings.
|
# Updates an organization's settings.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of the settings. See:
|
# The relative resource name of the settings. See: https://cloud.google.com/apis/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# design/resource_names#relative_resource_name Example: "organizations/`
|
||||||
# Example:
|
# organization_id`/organizationSettings".
|
||||||
# "organizations/`organization_id`/organizationSettings".
|
|
||||||
# @param [Google::Apis::SecuritycenterV1::OrganizationSettings] organization_settings_object
|
# @param [Google::Apis::SecuritycenterV1::OrganizationSettings] organization_settings_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# The FieldMask to use when updating the settings resource.
|
# The FieldMask to use when updating the settings resource. If empty all mutable
|
||||||
# If empty all mutable fields will be updated.
|
# fields will be updated.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -120,11 +118,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Filters an organization's assets and groups them by their specified
|
# Filters an organization's assets and groups them by their specified properties.
|
||||||
# properties.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the organization to groupBy. Its format is
|
# Required. Name of the organization to groupBy. Its format is "organizations/[
|
||||||
# "organizations/[organization_id]".
|
# organization_id]".
|
||||||
# @param [Google::Apis::SecuritycenterV1::GroupAssetsRequest] group_assets_request_object
|
# @param [Google::Apis::SecuritycenterV1::GroupAssetsRequest] group_assets_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -157,114 +154,86 @@ module Google
|
||||||
|
|
||||||
# Lists an organization's assets.
|
# Lists an organization's assets.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the organization assets should belong to. Its format is
|
# Required. Name of the organization assets should belong to. Its format is "
|
||||||
# "organizations/[organization_id]".
|
# organizations/[organization_id]".
|
||||||
# @param [String] compare_duration
|
# @param [String] compare_duration
|
||||||
# When compare_duration is set, the ListAssetsResult's "state_change"
|
# When compare_duration is set, the ListAssetsResult's "state_change" attribute
|
||||||
# attribute is updated to indicate whether the asset was added, removed, or
|
# is updated to indicate whether the asset was added, removed, or remained
|
||||||
# remained present during the compare_duration period of time that precedes
|
# present during the compare_duration period of time that precedes the read_time.
|
||||||
# the read_time. This is the time between (read_time - compare_duration) and
|
# This is the time between (read_time - compare_duration) and read_time. The
|
||||||
# read_time.
|
# state_change value is derived based on the presence of the asset at the two
|
||||||
# The state_change value is derived based on the presence of the asset at the
|
# points in time. Intermediate state changes between the two times don't affect
|
||||||
# two points in time. Intermediate state changes between the two times don't
|
# the result. For example, the results aren't affected if the asset is removed
|
||||||
# affect the result. For example, the results aren't affected if the asset is
|
# and re-created again. Possible "state_change" values when compare_duration is
|
||||||
# removed and re-created again.
|
# specified: * "ADDED": indicates that the asset was not present at the start of
|
||||||
# Possible "state_change" values when compare_duration is specified:
|
# compare_duration, but present at read_time. * "REMOVED": indicates that the
|
||||||
# * "ADDED": indicates that the asset was not present at the start of
|
# asset was present at the start of compare_duration, but not present at
|
||||||
# compare_duration, but present at read_time.
|
# read_time. * "ACTIVE": indicates that the asset was present at both the start
|
||||||
# * "REMOVED": indicates that the asset was present at the start of
|
# and the end of the time period defined by compare_duration and read_time. If
|
||||||
# compare_duration, but not present at read_time.
|
# compare_duration is not specified, then the only possible state_change is "
|
||||||
# * "ACTIVE": indicates that the asset was present at both the
|
# UNUSED", which will be the state_change set for all assets present at
|
||||||
# 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.
|
# read_time.
|
||||||
# @param [String] field_mask
|
# @param [String] field_mask
|
||||||
# A field mask to specify the ListAssetsResult fields to be listed in the
|
# A field mask to specify the ListAssetsResult fields to be listed in the
|
||||||
# response.
|
# response. An empty field mask will list all fields.
|
||||||
# An empty field mask will list all fields.
|
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# Expression that defines the filter to apply across assets.
|
# Expression that defines the filter to apply across assets. The expression is a
|
||||||
# The expression is a list of zero or more restrictions combined via logical
|
# list of zero or more restrictions combined via logical operators `AND` and `OR`
|
||||||
# operators `AND` and `OR`.
|
# . Parentheses are supported, and `OR` has higher precedence than `AND`.
|
||||||
# Parentheses are supported, and `OR` has higher precedence than `AND`.
|
# Restrictions have the form ` ` and may have a `-` character in front of them
|
||||||
# Restrictions have the form `<field> <operator> <value>` and may have a `-`
|
# to indicate negation. The fields map to those defined in the Asset resource.
|
||||||
# character in front of them to indicate negation. The fields map to those
|
# Examples include: * name * security_center_properties.resource_name *
|
||||||
# defined in the Asset resource. Examples include:
|
# resource_properties.a_property * security_marks.marks.marka The supported
|
||||||
# * name
|
# operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer
|
||||||
# * security_center_properties.resource_name
|
# values. * `:`, meaning substring matching, for strings. The supported value
|
||||||
# * resource_properties.a_property
|
# types are: * string literals in quotes. * integer literals without quotes. *
|
||||||
# * security_marks.marks.marka
|
# boolean literals `true` and `false` without quotes. The following are the
|
||||||
# The supported operators are:
|
# allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `
|
||||||
# * `=` for all value types.
|
# <`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339
|
||||||
# * `>`, `<`, `>=`, `<=` for integer values.
|
# string. Examples: `update_time = "2019-06-10T16:07:18-07:00"` `update_time =
|
||||||
# * `:`, meaning substring matching, for strings.
|
# 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be
|
||||||
# The supported value types are:
|
# milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019-
|
||||||
# * string literals in quotes.
|
# 06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_policy.policy_blob:
|
||||||
# * integer literals without quotes.
|
# `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` *
|
||||||
# * boolean literals `true` and `false` without quotes.
|
# security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`,
|
||||||
# The following are the allowed field and operator combinations:
|
# `:` * security_center_properties.resource_display_name: `=`, `:` *
|
||||||
# * name: `=`
|
# security_center_properties.resource_type: `=`, `:` *
|
||||||
# * update_time: `=`, `>`, `<`, `>=`, `<=`
|
# security_center_properties.resource_parent: `=`, `:` *
|
||||||
# Usage: This should be milliseconds since epoch or an RFC3339 string.
|
# security_center_properties.resource_parent_display_name: `=`, `:` *
|
||||||
# Examples:
|
# security_center_properties.resource_project: `=`, `:` *
|
||||||
# `update_time = "2019-06-10T16:07:18-07:00"`
|
# security_center_properties.resource_project_display_name: `=`, `:` *
|
||||||
# `update_time = 1560208038000`
|
# security_center_properties.resource_owners: `=`, `:` For example, `
|
||||||
# * create_time: `=`, `>`, `<`, `>=`, `<=`
|
# resource_properties.size = 100` is a valid filter string. Use a partial match
|
||||||
# Usage: This should be milliseconds since epoch or an RFC3339 string.
|
# on the empty string to filter based on a property existing: `
|
||||||
# Examples:
|
# resource_properties.my_property : ""` Use a negated partial match on the empty
|
||||||
# `create_time = "2019-06-10T16:07:18-07:00"`
|
# string to filter based on a property not existing: `-resource_properties.
|
||||||
# `create_time = 1560208038000`
|
# my_property : ""`
|
||||||
# * 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
|
# @param [String] order_by
|
||||||
# Expression that defines what fields and order to use for sorting. The
|
# Expression that defines what fields and order to use for sorting. The string
|
||||||
# string value should follow SQL syntax: comma separated list of fields. For
|
# value should follow SQL syntax: comma separated list of fields. For example: "
|
||||||
# example: "name,resource_properties.a_property". The default sorting order
|
# name,resource_properties.a_property". The default sorting order is ascending.
|
||||||
# is ascending. To specify descending order for a field, a suffix " desc"
|
# To specify descending order for a field, a suffix " desc" should be appended
|
||||||
# should be appended to the field name. For example: "name
|
# to the field name. For example: "name desc,resource_properties.a_property".
|
||||||
# desc,resource_properties.a_property". Redundant space characters in the
|
# Redundant space characters in the syntax are insignificant. "name desc,
|
||||||
# syntax are insignificant. "name desc,resource_properties.a_property" and "
|
# resource_properties.a_property" and " name desc , resource_properties.
|
||||||
# name desc , resource_properties.a_property " are equivalent.
|
# a_property " are equivalent. The following fields are supported: name
|
||||||
# The following fields are supported:
|
# update_time resource_properties security_marks.marks
|
||||||
# name
|
# security_center_properties.resource_name security_center_properties.
|
||||||
# update_time
|
# resource_display_name security_center_properties.resource_parent
|
||||||
# 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_parent_display_name
|
||||||
# security_center_properties.resource_project
|
# security_center_properties.resource_project security_center_properties.
|
||||||
# security_center_properties.resource_project_display_name
|
# resource_project_display_name security_center_properties.resource_type
|
||||||
# security_center_properties.resource_type
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of results to return in a single response. Default is
|
# The maximum number of results to return in a single response. Default is 10,
|
||||||
# 10, minimum is 1, maximum is 1000.
|
# minimum is 1, maximum is 1000.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The value returned by the last `ListAssetsResponse`; indicates
|
# The value returned by the last `ListAssetsResponse`; indicates that this is a
|
||||||
# that this is a continuation of a prior `ListAssets` call, and
|
# continuation of a prior `ListAssets` call, and that the system should return
|
||||||
# that the system should return the next page of data.
|
# the next page of data.
|
||||||
# @param [String] read_time
|
# @param [String] read_time
|
||||||
# Time used as a reference point when filtering assets. The filter is limited
|
# Time used as a reference point when filtering assets. The filter is limited to
|
||||||
# to assets existing at the supplied time and their values are those at that
|
# 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
|
# specific time. Absence of this field will default to the API's version of NOW.
|
||||||
# NOW.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -299,14 +268,12 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Runs asset discovery. The discovery is tracked with a long-running
|
# Runs asset discovery. The discovery is tracked with a long-running operation.
|
||||||
# operation.
|
# This API can only be called with limited frequency for an organization. If it
|
||||||
# This API can only be called with limited frequency for an organization. If
|
# is called too frequently the caller will receive a TOO_MANY_REQUESTS error.
|
||||||
# it is called too frequently the caller will receive a TOO_MANY_REQUESTS
|
|
||||||
# error.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the organization to run asset discovery for. Its format is
|
# Required. Name of the organization to run asset discovery for. Its format is "
|
||||||
# "organizations/[organization_id]".
|
# organizations/[organization_id]".
|
||||||
# @param [Google::Apis::SecuritycenterV1::RunAssetDiscoveryRequest] run_asset_discovery_request_object
|
# @param [Google::Apis::SecuritycenterV1::RunAssetDiscoveryRequest] run_asset_discovery_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -339,22 +306,19 @@ module Google
|
||||||
|
|
||||||
# Updates security marks.
|
# Updates security marks.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of the SecurityMarks. See:
|
# The relative resource name of the SecurityMarks. See: https://cloud.google.com/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# apis/design/resource_names#relative_resource_name Examples: "organizations/`
|
||||||
# Examples:
|
# organization_id`/assets/`asset_id`/securityMarks" "organizations/`
|
||||||
# "organizations/`organization_id`/assets/`asset_id`/securityMarks"
|
# organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks".
|
||||||
# "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/
|
|
||||||
# securityMarks".
|
|
||||||
# @param [Google::Apis::SecuritycenterV1::SecurityMarks] security_marks_object
|
# @param [Google::Apis::SecuritycenterV1::SecurityMarks] security_marks_object
|
||||||
# @param [String] start_time
|
# @param [String] start_time
|
||||||
# The time at which the updated SecurityMarks take effect.
|
# The time at which the updated SecurityMarks take effect. If not set uses
|
||||||
# If not set uses current server time. Updates will be applied to the
|
# current server time. Updates will be applied to the SecurityMarks that are
|
||||||
# SecurityMarks that are active immediately preceding this time.
|
# active immediately preceding this time.
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# The FieldMask to use when updating the security marks resource.
|
# The FieldMask to use when updating the security marks resource. The field mask
|
||||||
# The field mask must not contain duplicate fields.
|
# must not contain duplicate fields. If empty or set to "marks", all marks will
|
||||||
# If empty or set to "marks", all marks will be replaced. Individual
|
# be replaced. Individual marks can be updated using "marks.".
|
||||||
# marks can be updated using "marks.<mark_key>".
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -392,10 +356,9 @@ module Google
|
||||||
# "organizations/[organization_id]".
|
# "organizations/[organization_id]".
|
||||||
# @param [Google::Apis::SecuritycenterV1::NotificationConfig] notification_config_object
|
# @param [Google::Apis::SecuritycenterV1::NotificationConfig] notification_config_object
|
||||||
# @param [String] config_id
|
# @param [String] config_id
|
||||||
# Required.
|
# Required. Unique identifier provided by the client within the parent scope. It
|
||||||
# Unique identifier provided by the client within the parent scope.
|
# must be between 1 and 128 characters, and contains alphanumeric characters,
|
||||||
# It must be between 1 and 128 characters, and contains alphanumeric
|
# underscores or hyphens only.
|
||||||
# characters, underscores or hyphens only.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -428,8 +391,8 @@ module Google
|
||||||
|
|
||||||
# Deletes a notification config.
|
# Deletes a notification config.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. Name of the notification config to delete. Its format is
|
# Required. Name of the notification config to delete. Its format is "
|
||||||
# "organizations/[organization_id]/notificationConfigs/[config_id]".
|
# organizations/[organization_id]/notificationConfigs/[config_id]".
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -459,8 +422,8 @@ module Google
|
||||||
|
|
||||||
# Gets a notification config.
|
# Gets a notification config.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. Name of the notification config to get. Its format is
|
# Required. Name of the notification config to get. Its format is "organizations/
|
||||||
# "organizations/[organization_id]/notificationConfigs/[config_id]".
|
# [organization_id]/notificationConfigs/[config_id]".
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -490,11 +453,11 @@ module Google
|
||||||
|
|
||||||
# Lists notification configs.
|
# Lists notification configs.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the organization to list notification configs.
|
# Required. Name of the organization to list notification configs. Its format is
|
||||||
# Its format is "organizations/[organization_id]".
|
# "organizations/[organization_id]".
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of results to return in a single response. Default is
|
# The maximum number of results to return in a single response. Default is 10,
|
||||||
# 10, minimum is 1, maximum is 1000.
|
# minimum is 1, maximum is 1000.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The value returned by the last `ListNotificationConfigsResponse`; indicates
|
# The value returned by the last `ListNotificationConfigsResponse`; indicates
|
||||||
# that this is a continuation of a prior `ListNotificationConfigs` call, and
|
# that this is a continuation of a prior `ListNotificationConfigs` call, and
|
||||||
|
|
@ -528,17 +491,16 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Updates a notification config. The following update
|
# Updates a notification config. The following update fields are allowed:
|
||||||
# fields are allowed: description, pubsub_topic, streaming_config.filter
|
# description, pubsub_topic, streaming_config.filter
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of this notification config. See:
|
# The relative resource name of this notification config. See: https://cloud.
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# google.com/apis/design/resource_names#relative_resource_name Example: "
|
||||||
# Example:
|
# organizations/`organization_id`/notificationConfigs/notify_public_bucket".
|
||||||
# "organizations/`organization_id`/notificationConfigs/notify_public_bucket".
|
|
||||||
# @param [Google::Apis::SecuritycenterV1::NotificationConfig] notification_config_object
|
# @param [Google::Apis::SecuritycenterV1::NotificationConfig] notification_config_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# The FieldMask to use when updating the notification config.
|
# The FieldMask to use when updating the notification config. If empty all
|
||||||
# If empty all mutable fields will be updated.
|
# mutable fields will be updated.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -569,15 +531,13 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Starts asynchronous cancellation on a long-running operation. The server
|
# Starts asynchronous cancellation on a long-running operation. The server makes
|
||||||
# makes a best effort to cancel the operation, but success is not
|
# a best effort to cancel the operation, but success is not guaranteed. If the
|
||||||
# guaranteed. If the server doesn't support this method, it returns
|
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
# Clients can use Operations.GetOperation or other methods to check whether the
|
||||||
# Operations.GetOperation or
|
# cancellation succeeded or whether the operation completed despite cancellation.
|
||||||
# other methods to check whether the cancellation succeeded or whether the
|
# On successful cancellation, the operation is not deleted; instead, it becomes
|
||||||
# operation completed despite cancellation. On successful cancellation,
|
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
||||||
# 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`.
|
# corresponding to `Code.CANCELLED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be cancelled.
|
# The name of the operation resource to be cancelled.
|
||||||
|
|
@ -608,10 +568,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Deletes a long-running operation. This method indicates that the client is
|
# Deletes a long-running operation. This method indicates that the client is no
|
||||||
# no longer interested in the operation result. It does not cancel the
|
# longer interested in the operation result. It does not cancel the operation.
|
||||||
# operation. If the server doesn't support this method, it returns
|
# If the server doesn't support this method, it returns `google.rpc.Code.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`.
|
# UNIMPLEMENTED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be deleted.
|
# The name of the operation resource to be deleted.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -641,9 +601,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the latest state of a long-running operation. Clients can use this
|
# Gets the latest state of a long-running operation. Clients can use this method
|
||||||
# method to poll the operation result at intervals as recommended by the API
|
# to poll the operation result at intervals as recommended by the API service.
|
||||||
# service.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource.
|
# The name of the operation resource.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -673,15 +632,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists operations that match the specified filter in the request. If the
|
# Lists operations that match the specified filter in the request. If the server
|
||||||
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
||||||
# NOTE: the `name` binding allows API services to override the binding
|
# binding allows API services to override the binding to use different resource
|
||||||
# to use different resource name schemes, such as `users/*/operations`. To
|
# name schemes, such as `users/*/operations`. To override the binding, API
|
||||||
# override the binding, API services can add a binding such as
|
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
||||||
# `"/v1/`name=users/*`/operations"` to their service configuration.
|
# service configuration. For backwards compatibility, the default name includes
|
||||||
# For backwards compatibility, the default name includes the operations
|
# the operations collection id, however overriding users must ensure the name
|
||||||
# collection id, however overriding users must ensure the name binding
|
# binding is the parent resource, without the operations collection id.
|
||||||
# is the parent resource, without the operations collection id.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation's parent resource.
|
# The name of the operation's parent resource.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
|
|
@ -722,8 +680,8 @@ module Google
|
||||||
|
|
||||||
# Creates a source.
|
# Creates a source.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Resource name of the new source's parent. Its format should be
|
# Required. Resource name of the new source's parent. Its format should be "
|
||||||
# "organizations/[organization_id]".
|
# organizations/[organization_id]".
|
||||||
# @param [Google::Apis::SecuritycenterV1::Source] source_object
|
# @param [Google::Apis::SecuritycenterV1::Source] source_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -756,8 +714,8 @@ module Google
|
||||||
|
|
||||||
# Gets a source.
|
# Gets a source.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. Relative resource name of the source. Its format is
|
# Required. Relative resource name of the source. Its format is "organizations/[
|
||||||
# "organizations/[organization_id]/source/[source_id]".
|
# organization_id]/source/[source_id]".
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -787,8 +745,8 @@ module Google
|
||||||
|
|
||||||
# Gets the access control policy on the specified Source.
|
# Gets the access control policy on the specified Source.
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy is being requested.
|
# REQUIRED: The resource for which the policy is being requested. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Google::Apis::SecuritycenterV1::GetIamPolicyRequest] get_iam_policy_request_object
|
# @param [Google::Apis::SecuritycenterV1::GetIamPolicyRequest] get_iam_policy_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -824,12 +782,12 @@ module Google
|
||||||
# Required. Resource name of the parent of sources to list. Its format should be
|
# Required. Resource name of the parent of sources to list. Its format should be
|
||||||
# "organizations/[organization_id]".
|
# "organizations/[organization_id]".
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of results to return in a single response. Default is
|
# The maximum number of results to return in a single response. Default is 10,
|
||||||
# 10, minimum is 1, maximum is 1000.
|
# minimum is 1, maximum is 1000.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The value returned by the last `ListSourcesResponse`; indicates
|
# The value returned by the last `ListSourcesResponse`; indicates that this is a
|
||||||
# that this is a continuation of a prior `ListSources` call, and
|
# continuation of a prior `ListSources` call, and that the system should return
|
||||||
# that the system should return the next page of data.
|
# the next page of data.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -861,14 +819,13 @@ module Google
|
||||||
|
|
||||||
# Updates a source.
|
# Updates a source.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of this source. See:
|
# The relative resource name of this source. See: https://cloud.google.com/apis/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# design/resource_names#relative_resource_name Example: "organizations/`
|
||||||
# Example:
|
# organization_id`/sources/`source_id`"
|
||||||
# "organizations/`organization_id`/sources/`source_id`"
|
|
||||||
# @param [Google::Apis::SecuritycenterV1::Source] source_object
|
# @param [Google::Apis::SecuritycenterV1::Source] source_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# The FieldMask to use when updating the source resource.
|
# The FieldMask to use when updating the source resource. If empty all mutable
|
||||||
# If empty all mutable fields will be updated.
|
# fields will be updated.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -901,8 +858,8 @@ module Google
|
||||||
|
|
||||||
# Sets the access control policy on the specified Source.
|
# Sets the access control policy on the specified Source.
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy is being specified.
|
# REQUIRED: The resource for which the policy is being specified. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Google::Apis::SecuritycenterV1::SetIamPolicyRequest] set_iam_policy_request_object
|
# @param [Google::Apis::SecuritycenterV1::SetIamPolicyRequest] set_iam_policy_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -935,8 +892,8 @@ module Google
|
||||||
|
|
||||||
# Returns the permissions that a caller has on the specified source.
|
# Returns the permissions that a caller has on the specified source.
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy detail is being requested.
|
# REQUIRED: The resource for which the policy detail is being requested. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Google::Apis::SecuritycenterV1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
# @param [Google::Apis::SecuritycenterV1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -967,16 +924,16 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Creates a finding. The corresponding source must exist for finding creation
|
# Creates a finding. The corresponding source must exist for finding creation to
|
||||||
# to succeed.
|
# succeed.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Resource name of the new finding's parent. Its format should be
|
# Required. Resource name of the new finding's parent. Its format should be "
|
||||||
# "organizations/[organization_id]/sources/[source_id]".
|
# organizations/[organization_id]/sources/[source_id]".
|
||||||
# @param [Google::Apis::SecuritycenterV1::Finding] finding_object
|
# @param [Google::Apis::SecuritycenterV1::Finding] finding_object
|
||||||
# @param [String] finding_id
|
# @param [String] finding_id
|
||||||
# Required. Unique identifier provided by the client within the parent scope.
|
# Required. Unique identifier provided by the client within the parent scope. It
|
||||||
# It must be alphanumeric and less than or equal to 32 characters and
|
# must be alphanumeric and less than or equal to 32 characters and greater than
|
||||||
# greater than 0 characters in length.
|
# 0 characters in length.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1007,15 +964,13 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Filters an organization or source's findings and groups them by their
|
# Filters an organization or source's findings and groups them by their
|
||||||
# specified properties.
|
# specified properties. To group across all sources provide a `-` as the source
|
||||||
# To group across all sources provide a `-` as the source id.
|
# id. Example: /v1/organizations/`organization_id`/sources/-/findings
|
||||||
# Example: /v1/organizations/`organization_id`/sources/-/findings
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the source to groupBy. Its format is
|
# Required. Name of the source to groupBy. Its format is "organizations/[
|
||||||
# "organizations/[organization_id]/sources/[source_id]". To groupBy across
|
# organization_id]/sources/[source_id]". To groupBy across all sources provide a
|
||||||
# all sources provide a source_id of `-`. For example:
|
# source_id of `-`. For example: organizations/`organization_id`/sources/-
|
||||||
# organizations/`organization_id`/sources/-
|
|
||||||
# @param [Google::Apis::SecuritycenterV1::GroupFindingsRequest] group_findings_request_object
|
# @param [Google::Apis::SecuritycenterV1::GroupFindingsRequest] group_findings_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -1046,111 +1001,80 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists an organization or source's findings.
|
# Lists an organization or source's findings. To list across all sources provide
|
||||||
# To list across all sources provide a `-` as the source id.
|
# a `-` as the source id. Example: /v1/organizations/`organization_id`/sources/-/
|
||||||
# Example: /v1/organizations/`organization_id`/sources/-/findings
|
# findings
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the source the findings belong to. Its format is
|
# Required. Name of the source the findings belong to. Its format is "
|
||||||
# "organizations/[organization_id]/sources/[source_id]". To list across all
|
# organizations/[organization_id]/sources/[source_id]". To list across all
|
||||||
# sources provide a source_id of `-`. For example:
|
# sources provide a source_id of `-`. For example: organizations/`
|
||||||
# organizations/`organization_id`/sources/-
|
# organization_id`/sources/-
|
||||||
# @param [String] compare_duration
|
# @param [String] compare_duration
|
||||||
# When compare_duration is set, the ListFindingsResult's "state_change"
|
# When compare_duration is set, the ListFindingsResult's "state_change"
|
||||||
# attribute is updated to indicate whether the finding had its state changed,
|
# 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
|
# 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
|
# state during the compare_duration period of time that precedes the read_time.
|
||||||
# read_time. This is the time between (read_time - compare_duration) and
|
# This is the time between (read_time - compare_duration) and read_time. The
|
||||||
# read_time.
|
# state_change value is derived based on the presence and state of the finding
|
||||||
# The state_change value is derived based on the presence and state of the
|
# at the two points in time. Intermediate state changes between the two times
|
||||||
# finding at the two points in time. Intermediate state changes between the
|
# don't affect the result. For example, the results aren't affected if the
|
||||||
# two times don't affect the result. For example, the results aren't affected
|
# finding is made inactive and then active again. Possible "state_change" values
|
||||||
# if the finding is made inactive and then active again.
|
# when compare_duration is specified: * "CHANGED": indicates that the finding
|
||||||
# Possible "state_change" values when compare_duration is specified:
|
# was present and matched the given filter at the start of compare_duration, but
|
||||||
# * "CHANGED": indicates that the finding was present and matched the given
|
# changed its state at read_time. * "UNCHANGED": indicates that the finding was
|
||||||
# filter at the start of compare_duration, but changed its
|
# present and matched the given filter at the start of compare_duration and did
|
||||||
# state at read_time.
|
# not change state at read_time. * "ADDED": indicates that the finding did not
|
||||||
# * "UNCHANGED": indicates that the finding was present and matched the given
|
# match the given filter or was not present at the start of compare_duration,
|
||||||
# filter at the start of compare_duration and did not change
|
# but was present at read_time. * "REMOVED": indicates that the finding was
|
||||||
# state at read_time.
|
# present and matched the filter at the start of compare_duration, but did not
|
||||||
# * "ADDED": indicates that the finding did not match the given filter or
|
# match the filter at read_time. If compare_duration is not specified, then the
|
||||||
# was not present at the start of compare_duration, but was
|
# only possible state_change is "UNUSED", which will be the state_change set for
|
||||||
# present at read_time.
|
# all findings 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
|
# @param [String] field_mask
|
||||||
# A field mask to specify the Finding fields to be listed in the response.
|
# A field mask to specify the Finding fields to be listed in the response. An
|
||||||
# An empty field mask will list all fields.
|
# empty field mask will list all fields.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# Expression that defines the filter to apply across findings.
|
# Expression that defines the filter to apply across findings. The expression is
|
||||||
# The expression is a list of one or more restrictions combined via logical
|
# a list of one or more restrictions combined via logical operators `AND` and `
|
||||||
# operators `AND` and `OR`.
|
# OR`. Parentheses are supported, and `OR` has higher precedence than `AND`.
|
||||||
# Parentheses are supported, and `OR` has higher precedence than `AND`.
|
# Restrictions have the form ` ` and may have a `-` character in front of them
|
||||||
# Restrictions have the form `<field> <operator> <value>` and may have a `-`
|
# to indicate negation. Examples include: * name * source_properties.a_property *
|
||||||
# character in front of them to indicate negation. Examples include:
|
# security_marks.marks.marka The supported operators are: * `=` for all value
|
||||||
# * name
|
# types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring
|
||||||
# * source_properties.a_property
|
# matching, for strings. The supported value types are: * string literals in
|
||||||
# * security_marks.marks.marka
|
# quotes. * integer literals without quotes. * boolean literals `true` and `
|
||||||
# The supported operators are:
|
# false` without quotes. The following field and operator combinations are
|
||||||
# * `=` for all value types.
|
# supported: name: `=` parent: `=`, `:` resource_name: `=`, `:` state: `=`, `:`
|
||||||
# * `>`, `<`, `>=`, `<=` for integer values.
|
# category: `=`, `:` external_uri: `=`, `:` event_time: `=`, `>`, `<`, `>=`, `<=`
|
||||||
# * `:`, meaning substring matching, for strings.
|
# Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:
|
||||||
# The supported value types are:
|
# `event_time = "2019-06-10T16:07:18-07:00"` `event_time = 1560208038000`
|
||||||
# * string literals in quotes.
|
# security_marks.marks: `=`, `:` source_properties: `=`, `:`, `>`, `<`, `>=`, `<=
|
||||||
# * integer literals without quotes.
|
# ` For example, `source_properties.size = 100` is a valid filter string. Use a
|
||||||
# * boolean literals `true` and `false` without quotes.
|
# partial match on the empty string to filter based on a property existing: `
|
||||||
# The following field and operator combinations are supported:
|
# source_properties.my_property : ""` Use a negated partial match on the empty
|
||||||
# name: `=`
|
# string to filter based on a property not existing: `-source_properties.
|
||||||
# parent: `=`, `:`
|
# my_property : ""`
|
||||||
# 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
|
# @param [String] order_by
|
||||||
# Expression that defines what fields and order to use for sorting. The
|
# Expression that defines what fields and order to use for sorting. The string
|
||||||
# string value should follow SQL syntax: comma separated list of fields. For
|
# value should follow SQL syntax: comma separated list of fields. For example: "
|
||||||
# example: "name,resource_properties.a_property". The default sorting order
|
# name,resource_properties.a_property". The default sorting order is ascending.
|
||||||
# is ascending. To specify descending order for a field, a suffix " desc"
|
# To specify descending order for a field, a suffix " desc" should be appended
|
||||||
# should be appended to the field name. For example: "name
|
# to the field name. For example: "name desc,source_properties.a_property".
|
||||||
# desc,source_properties.a_property". Redundant space characters in the
|
# Redundant space characters in the syntax are insignificant. "name desc,
|
||||||
# syntax are insignificant. "name desc,source_properties.a_property" and "
|
# source_properties.a_property" and " name desc , source_properties.a_property "
|
||||||
# name desc , source_properties.a_property " are equivalent.
|
# are equivalent. The following fields are supported: name parent state category
|
||||||
# The following fields are supported:
|
# resource_name event_time source_properties security_marks.marks
|
||||||
# name
|
|
||||||
# parent
|
|
||||||
# state
|
|
||||||
# category
|
|
||||||
# resource_name
|
|
||||||
# event_time
|
|
||||||
# source_properties
|
|
||||||
# security_marks.marks
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of results to return in a single response. Default is
|
# The maximum number of results to return in a single response. Default is 10,
|
||||||
# 10, minimum is 1, maximum is 1000.
|
# minimum is 1, maximum is 1000.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The value returned by the last `ListFindingsResponse`; indicates
|
# The value returned by the last `ListFindingsResponse`; indicates that this is
|
||||||
# that this is a continuation of a prior `ListFindings` call, and
|
# a continuation of a prior `ListFindings` call, and that the system should
|
||||||
# that the system should return the next page of data.
|
# return the next page of data.
|
||||||
# @param [String] read_time
|
# @param [String] read_time
|
||||||
# Time used as a reference point when filtering findings. The filter is
|
# Time used as a reference point when filtering findings. The filter is limited
|
||||||
# limited to findings existing at the supplied time and their values are
|
# to findings existing at the supplied time and their values are those at that
|
||||||
# those at that specific time. Absence of this field will default to the
|
# specific time. Absence of this field will default to the API's version of NOW.
|
||||||
# API's version of NOW.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1188,18 +1112,16 @@ module Google
|
||||||
# Creates or updates a finding. The corresponding source must exist for a
|
# Creates or updates a finding. The corresponding source must exist for a
|
||||||
# finding creation to succeed.
|
# finding creation to succeed.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of this finding. See:
|
# The relative resource name of this finding. See: https://cloud.google.com/apis/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# design/resource_names#relative_resource_name Example: "organizations/`
|
||||||
# Example:
|
# organization_id`/sources/`source_id`/findings/`finding_id`"
|
||||||
# "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`"
|
|
||||||
# @param [Google::Apis::SecuritycenterV1::Finding] finding_object
|
# @param [Google::Apis::SecuritycenterV1::Finding] finding_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# The FieldMask to use when updating the finding resource. This field should
|
# The FieldMask to use when updating the finding resource. This field should not
|
||||||
# not be specified when creating a finding.
|
# be specified when creating a finding. When updating a finding, an empty mask
|
||||||
# When updating a finding, an empty mask is treated as updating all mutable
|
# is treated as updating all mutable fields and replacing source_properties.
|
||||||
# fields and replacing source_properties. Individual source_properties can
|
# Individual source_properties can be added/updated by using "source_properties."
|
||||||
# be added/updated by using "source_properties.<property key>" in the field
|
# in the field mask.
|
||||||
# mask.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1232,10 +1154,9 @@ module Google
|
||||||
|
|
||||||
# Updates the state of a finding.
|
# Updates the state of a finding.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The relative resource name of the finding. See:
|
# Required. The relative resource name of the finding. See: https://cloud.google.
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# com/apis/design/resource_names#relative_resource_name Example: "organizations/`
|
||||||
# Example:
|
# organization_id`/sources/`source_id`/finding/`finding_id`".
|
||||||
# "organizations/`organization_id`/sources/`source_id`/finding/`finding_id`".
|
|
||||||
# @param [Google::Apis::SecuritycenterV1::SetFindingStateRequest] set_finding_state_request_object
|
# @param [Google::Apis::SecuritycenterV1::SetFindingStateRequest] set_finding_state_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -1268,22 +1189,19 @@ module Google
|
||||||
|
|
||||||
# Updates security marks.
|
# Updates security marks.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of the SecurityMarks. See:
|
# The relative resource name of the SecurityMarks. See: https://cloud.google.com/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# apis/design/resource_names#relative_resource_name Examples: "organizations/`
|
||||||
# Examples:
|
# organization_id`/assets/`asset_id`/securityMarks" "organizations/`
|
||||||
# "organizations/`organization_id`/assets/`asset_id`/securityMarks"
|
# organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks".
|
||||||
# "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/
|
|
||||||
# securityMarks".
|
|
||||||
# @param [Google::Apis::SecuritycenterV1::SecurityMarks] security_marks_object
|
# @param [Google::Apis::SecuritycenterV1::SecurityMarks] security_marks_object
|
||||||
# @param [String] start_time
|
# @param [String] start_time
|
||||||
# The time at which the updated SecurityMarks take effect.
|
# The time at which the updated SecurityMarks take effect. If not set uses
|
||||||
# If not set uses current server time. Updates will be applied to the
|
# current server time. Updates will be applied to the SecurityMarks that are
|
||||||
# SecurityMarks that are active immediately preceding this time.
|
# active immediately preceding this time.
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# The FieldMask to use when updating the security marks resource.
|
# The FieldMask to use when updating the security marks resource. The field mask
|
||||||
# The field mask must not contain duplicate fields.
|
# must not contain duplicate fields. If empty or set to "marks", all marks will
|
||||||
# If empty or set to "marks", all marks will be replaced. Individual
|
# be replaced. Individual marks can be updated using "marks.".
|
||||||
# marks can be updated using "marks.<mark_key>".
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ module Google
|
||||||
# @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview
|
# @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview
|
||||||
module SecuritycenterV1beta1
|
module SecuritycenterV1beta1
|
||||||
VERSION = 'V1beta1'
|
VERSION = 'V1beta1'
|
||||||
REVISION = '20200605'
|
REVISION = '20200731'
|
||||||
|
|
||||||
# View and manage your data across Google Cloud Platform services
|
# View and manage your data across Google Cloud Platform services
|
||||||
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -51,8 +51,7 @@ module Google
|
||||||
# Gets the settings for an organization.
|
# Gets the settings for an organization.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. Name of the organization to get organization settings for. Its
|
# Required. Name of the organization to get organization settings for. Its
|
||||||
# format is
|
# format is "organizations/[organization_id]/organizationSettings".
|
||||||
# "organizations/[organization_id]/organizationSettings".
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -82,10 +81,9 @@ module Google
|
||||||
|
|
||||||
# Updates an organization's settings.
|
# Updates an organization's settings.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of the settings. See:
|
# The relative resource name of the settings. See: https://cloud.google.com/apis/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# design/resource_names#relative_resource_name Example: "organizations/`
|
||||||
# Example:
|
# organization_id`/organizationSettings".
|
||||||
# "organizations/`organization_id`/organizationSettings".
|
|
||||||
# @param [Google::Apis::SecuritycenterV1beta1::OrganizationSettings] organization_settings_object
|
# @param [Google::Apis::SecuritycenterV1beta1::OrganizationSettings] organization_settings_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# The FieldMask to use when updating the settings resource.
|
# The FieldMask to use when updating the settings resource.
|
||||||
|
|
@ -119,11 +117,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Filters an organization's assets and groups them by their specified
|
# Filters an organization's assets and groups them by their specified properties.
|
||||||
# properties.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the organization to groupBy. Its format is
|
# Required. Name of the organization to groupBy. Its format is "organizations/[
|
||||||
# "organizations/[organization_id]".
|
# organization_id]".
|
||||||
# @param [Google::Apis::SecuritycenterV1beta1::GroupAssetsRequest] group_assets_request_object
|
# @param [Google::Apis::SecuritycenterV1beta1::GroupAssetsRequest] group_assets_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -156,75 +153,60 @@ module Google
|
||||||
|
|
||||||
# Lists an organization's assets.
|
# Lists an organization's assets.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the organization assets should belong to. Its format is
|
# Required. Name of the organization assets should belong to. Its format is "
|
||||||
# "organizations/[organization_id]".
|
# organizations/[organization_id]".
|
||||||
# @param [String] compare_duration
|
# @param [String] compare_duration
|
||||||
# When compare_duration is set, the ListAssetResult's "state" attribute is
|
# When compare_duration is set, the ListAssetResult's "state" attribute is
|
||||||
# updated to indicate whether the asset was added, removed, or remained
|
# updated to indicate whether the asset was added, removed, or remained present
|
||||||
# present during the compare_duration period of time that precedes the
|
# during the compare_duration period of time that precedes the read_time. This
|
||||||
# read_time. This is the time between (read_time -
|
# is the time between (read_time - compare_duration) and read_time. The state
|
||||||
# compare_duration) and read_time.
|
# value is derived based on the presence of the asset at the two points in time.
|
||||||
# The state value is derived based on the presence of the asset at the two
|
# Intermediate state changes between the two times don't affect the result. For
|
||||||
# points in time. Intermediate state changes between the two times don't
|
# example, the results aren't affected if the asset is removed and re-created
|
||||||
# affect the result. For example, the results aren't affected if the asset is
|
# again. Possible "state" values when compare_duration is specified: * "ADDED":
|
||||||
# removed and re-created again.
|
# indicates that the asset was not present before compare_duration, but present
|
||||||
# Possible "state" values when compare_duration is specified:
|
# at read_time. * "REMOVED": indicates that the asset was present at the start
|
||||||
# * "ADDED": indicates that the asset was not present before
|
# of compare_duration, but not present at read_time. * "ACTIVE": indicates that
|
||||||
# compare_duration, but present at read_time.
|
# the asset was present at both the start and the end of the time period defined
|
||||||
# * "REMOVED": indicates that the asset was present at the start of
|
# by compare_duration and read_time. If compare_duration is not specified, then
|
||||||
# compare_duration, but not present at read_time.
|
# the only possible state is "UNUSED", which indicates that the asset is present
|
||||||
# * "ACTIVE": indicates that the asset was present at both the
|
# at read_time.
|
||||||
# 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 is
|
|
||||||
# "UNUSED", which indicates that the asset is present at read_time.
|
|
||||||
# @param [String] field_mask
|
# @param [String] field_mask
|
||||||
# Optional. A field mask to specify the ListAssetsResult fields to be listed in
|
# Optional. A field mask to specify the ListAssetsResult fields to be listed in
|
||||||
# the
|
# the response. An empty field mask will list all fields.
|
||||||
# response.
|
|
||||||
# An empty field mask will list all fields.
|
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# Expression that defines the filter to apply across assets.
|
# Expression that defines the filter to apply across assets. The expression is a
|
||||||
# The expression is a list of zero or more restrictions combined via logical
|
# list of zero or more restrictions combined via logical operators `AND` and `OR`
|
||||||
# operators `AND` and `OR`.
|
# . Parentheses are not supported, and `OR` has higher precedence than `AND`.
|
||||||
# Parentheses are not supported, and `OR` has higher precedence than `AND`.
|
# Restrictions have the form ` ` and may have a `-` character in front of them
|
||||||
# Restrictions have the form `<field> <operator> <value>` and may have a `-`
|
# to indicate negation. The fields map to those defined in the Asset resource.
|
||||||
# character in front of them to indicate negation. The fields map to those
|
# Examples include: * name * security_center_properties.resource_name *
|
||||||
# defined in the Asset resource. Examples include:
|
# resource_properties.a_property * security_marks.marks.marka The supported
|
||||||
# * name
|
# operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer
|
||||||
# * security_center_properties.resource_name
|
# values. * `:`, meaning substring matching, for strings. The supported value
|
||||||
# * resource_properties.a_property
|
# types are: * string literals in quotes. * integer literals without quotes. *
|
||||||
# * security_marks.marks.marka
|
# boolean literals `true` and `false` without quotes. For example, `
|
||||||
# The supported operators are:
|
# resource_properties.size = 100` is a valid filter string.
|
||||||
# * `=` 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.
|
|
||||||
# For example, `resource_properties.size = 100` is a valid filter string.
|
|
||||||
# @param [String] order_by
|
# @param [String] order_by
|
||||||
# Expression that defines what fields and order to use for sorting. The
|
# Expression that defines what fields and order to use for sorting. The string
|
||||||
# string value should follow SQL syntax: comma separated list of fields. For
|
# value should follow SQL syntax: comma separated list of fields. For example: "
|
||||||
# example: "name,resource_properties.a_property". The default sorting order
|
# name,resource_properties.a_property". The default sorting order is ascending.
|
||||||
# is ascending. To specify descending order for a field, a suffix " desc"
|
# To specify descending order for a field, a suffix " desc" should be appended
|
||||||
# should be appended to the field name. For example: "name
|
# to the field name. For example: "name desc,resource_properties.a_property".
|
||||||
# desc,resource_properties.a_property". Redundant space characters in the
|
# Redundant space characters in the syntax are insignificant. "name desc,
|
||||||
# syntax are insignificant. "name desc,resource_properties.a_property" and "
|
# resource_properties.a_property" and " name desc , resource_properties.
|
||||||
# name desc , resource_properties.a_property " are equivalent.
|
# a_property " are equivalent.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of results to return in a single response. Default is
|
# The maximum number of results to return in a single response. Default is 10,
|
||||||
# 10, minimum is 1, maximum is 1000.
|
# minimum is 1, maximum is 1000.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The value returned by the last `ListAssetsResponse`; indicates
|
# The value returned by the last `ListAssetsResponse`; indicates that this is a
|
||||||
# that this is a continuation of a prior `ListAssets` call, and
|
# continuation of a prior `ListAssets` call, and that the system should return
|
||||||
# that the system should return the next page of data.
|
# the next page of data.
|
||||||
# @param [String] read_time
|
# @param [String] read_time
|
||||||
# Time used as a reference point when filtering assets. The filter is limited
|
# Time used as a reference point when filtering assets. The filter is limited to
|
||||||
# to assets existing at the supplied time and their values are those at that
|
# 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
|
# specific time. Absence of this field will default to the API's version of NOW.
|
||||||
# NOW.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -259,14 +241,12 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Runs asset discovery. The discovery is tracked with a long-running
|
# Runs asset discovery. The discovery is tracked with a long-running operation.
|
||||||
# operation.
|
# This API can only be called with limited frequency for an organization. If it
|
||||||
# This API can only be called with limited frequency for an organization. If
|
# is called too frequently the caller will receive a TOO_MANY_REQUESTS error.
|
||||||
# it is called too frequently the caller will receive a TOO_MANY_REQUESTS
|
|
||||||
# error.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the organization to run asset discovery for. Its format is
|
# Required. Name of the organization to run asset discovery for. Its format is "
|
||||||
# "organizations/[organization_id]".
|
# organizations/[organization_id]".
|
||||||
# @param [Google::Apis::SecuritycenterV1beta1::RunAssetDiscoveryRequest] run_asset_discovery_request_object
|
# @param [Google::Apis::SecuritycenterV1beta1::RunAssetDiscoveryRequest] run_asset_discovery_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -299,12 +279,10 @@ module Google
|
||||||
|
|
||||||
# Updates security marks.
|
# Updates security marks.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of the SecurityMarks. See:
|
# The relative resource name of the SecurityMarks. See: https://cloud.google.com/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# apis/design/resource_names#relative_resource_name Examples: "organizations/`
|
||||||
# Examples:
|
# organization_id`/assets/`asset_id`/securityMarks" "organizations/`
|
||||||
# "organizations/`organization_id`/assets/`asset_id`/securityMarks"
|
# organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks".
|
||||||
# "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/
|
|
||||||
# securityMarks".
|
|
||||||
# @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1SecurityMarks] google_cloud_securitycenter_v1beta1_security_marks_object
|
# @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1SecurityMarks] google_cloud_securitycenter_v1beta1_security_marks_object
|
||||||
# @param [String] start_time
|
# @param [String] start_time
|
||||||
# The time at which the updated SecurityMarks take effect.
|
# The time at which the updated SecurityMarks take effect.
|
||||||
|
|
@ -341,15 +319,13 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Starts asynchronous cancellation on a long-running operation. The server
|
# Starts asynchronous cancellation on a long-running operation. The server makes
|
||||||
# makes a best effort to cancel the operation, but success is not
|
# a best effort to cancel the operation, but success is not guaranteed. If the
|
||||||
# guaranteed. If the server doesn't support this method, it returns
|
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
# Clients can use Operations.GetOperation or other methods to check whether the
|
||||||
# Operations.GetOperation or
|
# cancellation succeeded or whether the operation completed despite cancellation.
|
||||||
# other methods to check whether the cancellation succeeded or whether the
|
# On successful cancellation, the operation is not deleted; instead, it becomes
|
||||||
# operation completed despite cancellation. On successful cancellation,
|
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
||||||
# 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`.
|
# corresponding to `Code.CANCELLED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be cancelled.
|
# The name of the operation resource to be cancelled.
|
||||||
|
|
@ -383,10 +359,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Deletes a long-running operation. This method indicates that the client is
|
# Deletes a long-running operation. This method indicates that the client is no
|
||||||
# no longer interested in the operation result. It does not cancel the
|
# longer interested in the operation result. It does not cancel the operation.
|
||||||
# operation. If the server doesn't support this method, it returns
|
# If the server doesn't support this method, it returns `google.rpc.Code.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`.
|
# UNIMPLEMENTED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be deleted.
|
# The name of the operation resource to be deleted.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -416,9 +392,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the latest state of a long-running operation. Clients can use this
|
# Gets the latest state of a long-running operation. Clients can use this method
|
||||||
# method to poll the operation result at intervals as recommended by the API
|
# to poll the operation result at intervals as recommended by the API service.
|
||||||
# service.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource.
|
# The name of the operation resource.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -448,15 +423,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists operations that match the specified filter in the request. If the
|
# Lists operations that match the specified filter in the request. If the server
|
||||||
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
||||||
# NOTE: the `name` binding allows API services to override the binding
|
# binding allows API services to override the binding to use different resource
|
||||||
# to use different resource name schemes, such as `users/*/operations`. To
|
# name schemes, such as `users/*/operations`. To override the binding, API
|
||||||
# override the binding, API services can add a binding such as
|
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
||||||
# `"/v1/`name=users/*`/operations"` to their service configuration.
|
# service configuration. For backwards compatibility, the default name includes
|
||||||
# For backwards compatibility, the default name includes the operations
|
# the operations collection id, however overriding users must ensure the name
|
||||||
# collection id, however overriding users must ensure the name binding
|
# binding is the parent resource, without the operations collection id.
|
||||||
# is the parent resource, without the operations collection id.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation's parent resource.
|
# The name of the operation's parent resource.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
|
|
@ -497,8 +471,8 @@ module Google
|
||||||
|
|
||||||
# Creates a source.
|
# Creates a source.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Resource name of the new source's parent. Its format should be
|
# Required. Resource name of the new source's parent. Its format should be "
|
||||||
# "organizations/[organization_id]".
|
# organizations/[organization_id]".
|
||||||
# @param [Google::Apis::SecuritycenterV1beta1::Source] source_object
|
# @param [Google::Apis::SecuritycenterV1beta1::Source] source_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -531,8 +505,8 @@ module Google
|
||||||
|
|
||||||
# Gets a source.
|
# Gets a source.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. Relative resource name of the source. Its format is
|
# Required. Relative resource name of the source. Its format is "organizations/[
|
||||||
# "organizations/[organization_id]/source/[source_id]".
|
# organization_id]/source/[source_id]".
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -562,8 +536,8 @@ module Google
|
||||||
|
|
||||||
# Gets the access control policy on the specified Source.
|
# Gets the access control policy on the specified Source.
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy is being requested.
|
# REQUIRED: The resource for which the policy is being requested. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Google::Apis::SecuritycenterV1beta1::GetIamPolicyRequest] get_iam_policy_request_object
|
# @param [Google::Apis::SecuritycenterV1beta1::GetIamPolicyRequest] get_iam_policy_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -599,12 +573,12 @@ module Google
|
||||||
# Required. Resource name of the parent of sources to list. Its format should be
|
# Required. Resource name of the parent of sources to list. Its format should be
|
||||||
# "organizations/[organization_id]".
|
# "organizations/[organization_id]".
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of results to return in a single response. Default is
|
# The maximum number of results to return in a single response. Default is 10,
|
||||||
# 10, minimum is 1, maximum is 1000.
|
# minimum is 1, maximum is 1000.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The value returned by the last `ListSourcesResponse`; indicates
|
# The value returned by the last `ListSourcesResponse`; indicates that this is a
|
||||||
# that this is a continuation of a prior `ListSources` call, and
|
# continuation of a prior `ListSources` call, and that the system should return
|
||||||
# that the system should return the next page of data.
|
# the next page of data.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -636,10 +610,9 @@ module Google
|
||||||
|
|
||||||
# Updates a source.
|
# Updates a source.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of this source. See:
|
# The relative resource name of this source. See: https://cloud.google.com/apis/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# design/resource_names#relative_resource_name Example: "organizations/`
|
||||||
# Example:
|
# organization_id`/sources/`source_id`"
|
||||||
# "organizations/`organization_id`/sources/`source_id`"
|
|
||||||
# @param [Google::Apis::SecuritycenterV1beta1::Source] source_object
|
# @param [Google::Apis::SecuritycenterV1beta1::Source] source_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# The FieldMask to use when updating the source resource.
|
# The FieldMask to use when updating the source resource.
|
||||||
|
|
@ -675,8 +648,8 @@ module Google
|
||||||
|
|
||||||
# Sets the access control policy on the specified Source.
|
# Sets the access control policy on the specified Source.
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy is being specified.
|
# REQUIRED: The resource for which the policy is being specified. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Google::Apis::SecuritycenterV1beta1::SetIamPolicyRequest] set_iam_policy_request_object
|
# @param [Google::Apis::SecuritycenterV1beta1::SetIamPolicyRequest] set_iam_policy_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -709,8 +682,8 @@ module Google
|
||||||
|
|
||||||
# Returns the permissions that a caller has on the specified source.
|
# Returns the permissions that a caller has on the specified source.
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy detail is being requested.
|
# REQUIRED: The resource for which the policy detail is being requested. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Google::Apis::SecuritycenterV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
# @param [Google::Apis::SecuritycenterV1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -741,16 +714,16 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Creates a finding. The corresponding source must exist for finding creation
|
# Creates a finding. The corresponding source must exist for finding creation to
|
||||||
# to succeed.
|
# succeed.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Resource name of the new finding's parent. Its format should be
|
# Required. Resource name of the new finding's parent. Its format should be "
|
||||||
# "organizations/[organization_id]/sources/[source_id]".
|
# organizations/[organization_id]/sources/[source_id]".
|
||||||
# @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1Finding] google_cloud_securitycenter_v1beta1_finding_object
|
# @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1Finding] google_cloud_securitycenter_v1beta1_finding_object
|
||||||
# @param [String] finding_id
|
# @param [String] finding_id
|
||||||
# Required. Unique identifier provided by the client within the parent scope.
|
# Required. Unique identifier provided by the client within the parent scope. It
|
||||||
# It must be alphanumeric and less than or equal to 32 characters and
|
# must be alphanumeric and less than or equal to 32 characters and greater than
|
||||||
# greater than 0 characters in length.
|
# 0 characters in length.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -781,15 +754,13 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Filters an organization or source's findings and groups them by their
|
# Filters an organization or source's findings and groups them by their
|
||||||
# specified properties.
|
# specified properties. To group across all sources provide a `-` as the source
|
||||||
# To group across all sources provide a `-` as the source id.
|
# id. Example: /v1beta1/organizations/`organization_id`/sources/-/findings
|
||||||
# Example: /v1beta1/organizations/`organization_id`/sources/-/findings
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the source to groupBy. Its format is
|
# Required. Name of the source to groupBy. Its format is "organizations/[
|
||||||
# "organizations/[organization_id]/sources/[source_id]". To groupBy across
|
# organization_id]/sources/[source_id]". To groupBy across all sources provide a
|
||||||
# all sources provide a source_id of `-`. For example:
|
# source_id of `-`. For example: organizations/`organization_id`/sources/-
|
||||||
# organizations/`organization_id`/sources/-
|
|
||||||
# @param [Google::Apis::SecuritycenterV1beta1::GroupFindingsRequest] group_findings_request_object
|
# @param [Google::Apis::SecuritycenterV1beta1::GroupFindingsRequest] group_findings_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -820,58 +791,49 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists an organization or source's findings.
|
# Lists an organization or source's findings. To list across all sources provide
|
||||||
# To list across all sources provide a `-` as the source id.
|
# a `-` as the source id. Example: /v1beta1/organizations/`organization_id`/
|
||||||
# Example: /v1beta1/organizations/`organization_id`/sources/-/findings
|
# sources/-/findings
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the source the findings belong to. Its format is
|
# Required. Name of the source the findings belong to. Its format is "
|
||||||
# "organizations/[organization_id]/sources/[source_id]". To list across all
|
# organizations/[organization_id]/sources/[source_id]". To list across all
|
||||||
# sources provide a source_id of `-`. For example:
|
# sources provide a source_id of `-`. For example: organizations/`
|
||||||
# organizations/`organization_id`/sources/-
|
# organization_id`/sources/-
|
||||||
# @param [String] field_mask
|
# @param [String] field_mask
|
||||||
# Optional. A field mask to specify the Finding fields to be listed in the
|
# Optional. A field mask to specify the Finding fields to be listed in the
|
||||||
# response.
|
# response. An empty field mask will list all fields.
|
||||||
# An empty field mask will list all fields.
|
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# Expression that defines the filter to apply across findings.
|
# Expression that defines the filter to apply across findings. The expression is
|
||||||
# The expression is a list of one or more restrictions combined via logical
|
# a list of one or more restrictions combined via logical operators `AND` and `
|
||||||
# operators `AND` and `OR`.
|
# OR`. Parentheses are not supported, and `OR` has higher precedence than `AND`.
|
||||||
# Parentheses are not supported, and `OR` has higher precedence than `AND`.
|
# Restrictions have the form ` ` and may have a `-` character in front of them
|
||||||
# Restrictions have the form `<field> <operator> <value>` and may have a `-`
|
# to indicate negation. Examples include: * name * source_properties.a_property *
|
||||||
# character in front of them to indicate negation. Examples include:
|
# security_marks.marks.marka The supported operators are: * `=` for all value
|
||||||
# * name
|
# types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring
|
||||||
# * source_properties.a_property
|
# matching, for strings. The supported value types are: * string literals in
|
||||||
# * security_marks.marks.marka
|
# quotes. * integer literals without quotes. * boolean literals `true` and `
|
||||||
# The supported operators are:
|
# false` without quotes. For example, `source_properties.size = 100` is a valid
|
||||||
# * `=` for all value types.
|
# filter string.
|
||||||
# * `>`, `<`, `>=`, `<=` 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.
|
|
||||||
# For example, `source_properties.size = 100` is a valid filter string.
|
|
||||||
# @param [String] order_by
|
# @param [String] order_by
|
||||||
# Expression that defines what fields and order to use for sorting. The
|
# Expression that defines what fields and order to use for sorting. The string
|
||||||
# string value should follow SQL syntax: comma separated list of fields. For
|
# value should follow SQL syntax: comma separated list of fields. For example: "
|
||||||
# example: "name,resource_properties.a_property". The default sorting order
|
# name,resource_properties.a_property". The default sorting order is ascending.
|
||||||
# is ascending. To specify descending order for a field, a suffix " desc"
|
# To specify descending order for a field, a suffix " desc" should be appended
|
||||||
# should be appended to the field name. For example: "name
|
# to the field name. For example: "name desc,source_properties.a_property".
|
||||||
# desc,source_properties.a_property". Redundant space characters in the
|
# Redundant space characters in the syntax are insignificant. "name desc,
|
||||||
# syntax are insignificant. "name desc,source_properties.a_property" and "
|
# source_properties.a_property" and " name desc , source_properties.a_property "
|
||||||
# name desc , source_properties.a_property " are equivalent.
|
# are equivalent.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of results to return in a single response. Default is
|
# The maximum number of results to return in a single response. Default is 10,
|
||||||
# 10, minimum is 1, maximum is 1000.
|
# minimum is 1, maximum is 1000.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The value returned by the last `ListFindingsResponse`; indicates
|
# The value returned by the last `ListFindingsResponse`; indicates that this is
|
||||||
# that this is a continuation of a prior `ListFindings` call, and
|
# a continuation of a prior `ListFindings` call, and that the system should
|
||||||
# that the system should return the next page of data.
|
# return the next page of data.
|
||||||
# @param [String] read_time
|
# @param [String] read_time
|
||||||
# Time used as a reference point when filtering findings. The filter is
|
# Time used as a reference point when filtering findings. The filter is limited
|
||||||
# limited to findings existing at the supplied time and their values are
|
# to findings existing at the supplied time and their values are those at that
|
||||||
# those at that specific time. Absence of this field will default to the
|
# specific time. Absence of this field will default to the API's version of NOW.
|
||||||
# API's version of NOW.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -908,14 +870,13 @@ module Google
|
||||||
# Creates or updates a finding. The corresponding source must exist for a
|
# Creates or updates a finding. The corresponding source must exist for a
|
||||||
# finding creation to succeed.
|
# finding creation to succeed.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of this finding. See:
|
# The relative resource name of this finding. See: https://cloud.google.com/apis/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# design/resource_names#relative_resource_name Example: "organizations/`
|
||||||
# Example:
|
# organization_id`/sources/`source_id`/findings/`finding_id`"
|
||||||
# "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`"
|
|
||||||
# @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1Finding] google_cloud_securitycenter_v1beta1_finding_object
|
# @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1Finding] google_cloud_securitycenter_v1beta1_finding_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# The FieldMask to use when updating the finding resource. This field should
|
# The FieldMask to use when updating the finding resource. This field should not
|
||||||
# not be specified when creating a finding.
|
# be specified when creating a finding.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -948,10 +909,9 @@ module Google
|
||||||
|
|
||||||
# Updates the state of a finding.
|
# Updates the state of a finding.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The relative resource name of the finding. See:
|
# Required. The relative resource name of the finding. See: https://cloud.google.
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# com/apis/design/resource_names#relative_resource_name Example: "organizations/`
|
||||||
# Example:
|
# organization_id`/sources/`source_id`/finding/`finding_id`".
|
||||||
# "organizations/`organization_id`/sources/`source_id`/finding/`finding_id`".
|
|
||||||
# @param [Google::Apis::SecuritycenterV1beta1::SetFindingStateRequest] set_finding_state_request_object
|
# @param [Google::Apis::SecuritycenterV1beta1::SetFindingStateRequest] set_finding_state_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -984,12 +944,10 @@ module Google
|
||||||
|
|
||||||
# Updates security marks.
|
# Updates security marks.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of the SecurityMarks. See:
|
# The relative resource name of the SecurityMarks. See: https://cloud.google.com/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# apis/design/resource_names#relative_resource_name Examples: "organizations/`
|
||||||
# Examples:
|
# organization_id`/assets/`asset_id`/securityMarks" "organizations/`
|
||||||
# "organizations/`organization_id`/assets/`asset_id`/securityMarks"
|
# organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks".
|
||||||
# "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/
|
|
||||||
# securityMarks".
|
|
||||||
# @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1SecurityMarks] google_cloud_securitycenter_v1beta1_security_marks_object
|
# @param [Google::Apis::SecuritycenterV1beta1::GoogleCloudSecuritycenterV1beta1SecurityMarks] google_cloud_securitycenter_v1beta1_security_marks_object
|
||||||
# @param [String] start_time
|
# @param [String] start_time
|
||||||
# The time at which the updated SecurityMarks take effect.
|
# The time at which the updated SecurityMarks take effect.
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ module Google
|
||||||
# @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview
|
# @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview
|
||||||
module SecuritycenterV1p1alpha1
|
module SecuritycenterV1p1alpha1
|
||||||
VERSION = 'V1p1alpha1'
|
VERSION = 'V1p1alpha1'
|
||||||
REVISION = '20200605'
|
REVISION = '20200731'
|
||||||
|
|
||||||
# View and manage your data across Google Cloud Platform services
|
# View and manage your data across Google Cloud Platform services
|
||||||
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||||
|
|
|
||||||
|
|
@ -22,13 +22,11 @@ module Google
|
||||||
module Apis
|
module Apis
|
||||||
module SecuritycenterV1p1alpha1
|
module SecuritycenterV1p1alpha1
|
||||||
|
|
||||||
# A generic empty message that you can re-use to avoid defining duplicated
|
# A generic empty message that you can re-use to avoid defining duplicated empty
|
||||||
# empty messages in your APIs. A typical example is to use it as the request
|
# messages in your APIs. A typical example is to use it as the request or the
|
||||||
# or the response type of an API method. For instance:
|
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
||||||
# service Foo `
|
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
||||||
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
|
# `Empty` is empty JSON object ````.
|
||||||
# `
|
|
||||||
# The JSON representation for `Empty` is empty JSON object ````.
|
|
||||||
class Empty
|
class Empty
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -41,18 +39,16 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Security Command Center finding.
|
# Security Command Center finding. A finding is a record of assessment data like
|
||||||
# A finding is a record of assessment data like security, risk, health, or
|
# security, risk, health, or privacy, that is ingested into Security Command
|
||||||
# privacy, that is ingested into Security Command Center for presentation,
|
# Center for presentation, notification, analysis, policy testing, and
|
||||||
# notification, analysis, policy testing, and enforcement. For example, a
|
# enforcement. For example, a cross-site scripting (XSS) vulnerability in an App
|
||||||
# cross-site scripting (XSS) vulnerability in an App Engine application is a
|
# Engine application is a finding.
|
||||||
# finding.
|
|
||||||
class Finding
|
class Finding
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The additional taxonomy group within findings from a given source.
|
# The additional taxonomy group within findings from a given source. This field
|
||||||
# This field is immutable after creation time.
|
# is immutable after creation time. Example: "XSS_FLASH_INJECTION"
|
||||||
# Example: "XSS_FLASH_INJECTION"
|
|
||||||
# Corresponds to the JSON property `category`
|
# Corresponds to the JSON property `category`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :category
|
attr_accessor :category
|
||||||
|
|
@ -62,59 +58,56 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :create_time
|
attr_accessor :create_time
|
||||||
|
|
||||||
# The time at which the event took place. For example, if the finding
|
# The time at which the event took place. For example, if the finding represents
|
||||||
# represents an open firewall it would capture the time the detector believes
|
# an open firewall it would capture the time the detector believes the firewall
|
||||||
# the firewall became open. The accuracy is determined by the detector.
|
# became open. The accuracy is determined by the detector.
|
||||||
# Corresponds to the JSON property `eventTime`
|
# Corresponds to the JSON property `eventTime`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :event_time
|
attr_accessor :event_time
|
||||||
|
|
||||||
# The URI that, if available, points to a web page outside of Security
|
# The URI that, if available, points to a web page outside of Security Command
|
||||||
# Command Center where additional information about the finding can be found.
|
# Center where additional information about the finding can be found. This field
|
||||||
# This field is guaranteed to be either empty or a well formed URL.
|
# is guaranteed to be either empty or a well formed URL.
|
||||||
# Corresponds to the JSON property `externalUri`
|
# Corresponds to the JSON property `externalUri`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :external_uri
|
attr_accessor :external_uri
|
||||||
|
|
||||||
# The relative resource name of this finding. See:
|
# The relative resource name of this finding. See: https://cloud.google.com/apis/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# design/resource_names#relative_resource_name Example: "organizations/`
|
||||||
# Example:
|
# organization_id`/sources/`source_id`/findings/`finding_id`"
|
||||||
# "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`"
|
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# The relative resource name of the source the finding belongs to. See:
|
# The relative resource name of the source the finding belongs to. See: https://
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# cloud.google.com/apis/design/resource_names#relative_resource_name This field
|
||||||
# This field is immutable after creation time.
|
# is immutable after creation time. For example: "organizations/`organization_id`
|
||||||
# For example:
|
# /sources/`source_id`"
|
||||||
# "organizations/`organization_id`/sources/`source_id`"
|
|
||||||
# Corresponds to the JSON property `parent`
|
# Corresponds to the JSON property `parent`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :parent
|
attr_accessor :parent
|
||||||
|
|
||||||
# For findings on Google Cloud resources, the full resource
|
# For findings on Google Cloud resources, the full resource name of the Google
|
||||||
# name of the Google Cloud resource this finding is for. See:
|
# Cloud resource this finding is for. See: https://cloud.google.com/apis/design/
|
||||||
# https://cloud.google.com/apis/design/resource_names#full_resource_name
|
# resource_names#full_resource_name When the finding is for a non-Google Cloud
|
||||||
# When the finding is for a non-Google Cloud resource, the resourceName can
|
# resource, the resourceName can be a customer or partner defined string. This
|
||||||
# be a customer or partner defined string. This field is immutable after
|
# field is immutable after creation time.
|
||||||
# creation time.
|
|
||||||
# Corresponds to the JSON property `resourceName`
|
# Corresponds to the JSON property `resourceName`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :resource_name
|
attr_accessor :resource_name
|
||||||
|
|
||||||
# User specified security marks that are attached to the parent Security
|
# User specified security marks that are attached to the parent Security Command
|
||||||
# Command Center resource. Security marks are scoped within a Security Command
|
# Center resource. Security marks are scoped within a Security Command Center
|
||||||
# Center organization -- they can be modified and viewed by all users who have
|
# organization -- they can be modified and viewed by all users who have proper
|
||||||
# proper permissions on the organization.
|
# permissions on the organization.
|
||||||
# Corresponds to the JSON property `securityMarks`
|
# Corresponds to the JSON property `securityMarks`
|
||||||
# @return [Google::Apis::SecuritycenterV1p1alpha1::SecurityMarks]
|
# @return [Google::Apis::SecuritycenterV1p1alpha1::SecurityMarks]
|
||||||
attr_accessor :security_marks
|
attr_accessor :security_marks
|
||||||
|
|
||||||
# Source specific properties. These properties are managed by the source
|
# Source specific properties. These properties are managed by the source that
|
||||||
# that writes the finding. The key names in the source_properties map must be
|
# writes the finding. The key names in the source_properties map must be between
|
||||||
# between 1 and 255 characters, and must start with a letter and contain
|
# 1 and 255 characters, and must start with a letter and contain alphanumeric
|
||||||
# alphanumeric characters or underscores only.
|
# characters or underscores only.
|
||||||
# Corresponds to the JSON property `sourceProperties`
|
# Corresponds to the JSON property `sourceProperties`
|
||||||
# @return [Hash<String,Object>]
|
# @return [Hash<String,Object>]
|
||||||
attr_accessor :source_properties
|
attr_accessor :source_properties
|
||||||
|
|
@ -147,12 +140,11 @@ module Google
|
||||||
class GoogleCloudSecuritycenterV1NotificationMessage
|
class GoogleCloudSecuritycenterV1NotificationMessage
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Security Command Center finding.
|
# Security Command Center finding. A finding is a record of assessment data like
|
||||||
# A finding is a record of assessment data like security, risk, health, or
|
# security, risk, health, or privacy, that is ingested into Security Command
|
||||||
# privacy, that is ingested into Security Command Center for presentation,
|
# Center for presentation, notification, analysis, policy testing, and
|
||||||
# notification, analysis, policy testing, and enforcement. For example, a
|
# enforcement. For example, a cross-site scripting (XSS) vulnerability in an App
|
||||||
# cross-site scripting (XSS) vulnerability in an App Engine application is a
|
# Engine application is a finding.
|
||||||
# finding.
|
|
||||||
# Corresponds to the JSON property `finding`
|
# Corresponds to the JSON property `finding`
|
||||||
# @return [Google::Apis::SecuritycenterV1p1alpha1::Finding]
|
# @return [Google::Apis::SecuritycenterV1p1alpha1::Finding]
|
||||||
attr_accessor :finding
|
attr_accessor :finding
|
||||||
|
|
@ -183,8 +175,8 @@ module Google
|
||||||
class GoogleCloudSecuritycenterV1Resource
|
class GoogleCloudSecuritycenterV1Resource
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The full resource name of the resource. See:
|
# The full resource name of the resource. See: https://cloud.google.com/apis/
|
||||||
# https://cloud.google.com/apis/design/resource_names#full_resource_name
|
# design/resource_names#full_resource_name
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
@ -273,12 +265,11 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Security Command Center representation of a Google Cloud
|
# Security Command Center representation of a Google Cloud resource. The Asset
|
||||||
# resource.
|
# is a Security Command Center resource that captures information about a single
|
||||||
# The Asset is a Security Command Center resource that captures information
|
# Google Cloud resource. All modifications to an Asset are only within the
|
||||||
# about a single Google Cloud resource. All modifications to an Asset are only
|
# context of Security Command Center and don't affect the referenced Google
|
||||||
# within the context of Security Command Center and don't affect the referenced
|
# Cloud resource.
|
||||||
# Google Cloud resource.
|
|
||||||
class GoogleCloudSecuritycenterV1p1beta1Asset
|
class GoogleCloudSecuritycenterV1p1beta1Asset
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -289,22 +280,20 @@ module Google
|
||||||
|
|
||||||
# Cloud IAM Policy information associated with the Google Cloud resource
|
# Cloud IAM Policy information associated with the Google Cloud resource
|
||||||
# described by the Security Command Center asset. This information is managed
|
# described by the Security Command Center asset. This information is managed
|
||||||
# and defined by the Google Cloud resource and cannot be modified by the
|
# and defined by the Google Cloud resource and cannot be modified by the user.
|
||||||
# user.
|
|
||||||
# Corresponds to the JSON property `iamPolicy`
|
# Corresponds to the JSON property `iamPolicy`
|
||||||
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1IamPolicy]
|
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1IamPolicy]
|
||||||
attr_accessor :iam_policy
|
attr_accessor :iam_policy
|
||||||
|
|
||||||
# The relative resource name of this asset. See:
|
# The relative resource name of this asset. See: https://cloud.google.com/apis/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# design/resource_names#relative_resource_name Example: "organizations/`
|
||||||
# Example:
|
# organization_id`/assets/`asset_id`".
|
||||||
# "organizations/`organization_id`/assets/`asset_id`".
|
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# Resource managed properties. These properties are managed and defined by
|
# Resource managed properties. These properties are managed and defined by the
|
||||||
# the Google Cloud resource and cannot be modified by the user.
|
# Google Cloud resource and cannot be modified by the user.
|
||||||
# Corresponds to the JSON property `resourceProperties`
|
# Corresponds to the JSON property `resourceProperties`
|
||||||
# @return [Hash<String,Object>]
|
# @return [Hash<String,Object>]
|
||||||
attr_accessor :resource_properties
|
attr_accessor :resource_properties
|
||||||
|
|
@ -315,16 +304,15 @@ module Google
|
||||||
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties]
|
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties]
|
||||||
attr_accessor :security_center_properties
|
attr_accessor :security_center_properties
|
||||||
|
|
||||||
# User specified security marks that are attached to the parent Security
|
# User specified security marks that are attached to the parent Security Command
|
||||||
# Command Center resource. Security marks are scoped within a Security Command
|
# Center resource. Security marks are scoped within a Security Command Center
|
||||||
# Center organization -- they can be modified and viewed by all users who have
|
# organization -- they can be modified and viewed by all users who have proper
|
||||||
# proper permissions on the organization.
|
# permissions on the organization.
|
||||||
# Corresponds to the JSON property `securityMarks`
|
# Corresponds to the JSON property `securityMarks`
|
||||||
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks]
|
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks]
|
||||||
attr_accessor :security_marks
|
attr_accessor :security_marks
|
||||||
|
|
||||||
# The time at which the asset was last updated, added, or deleted in Cloud
|
# The time at which the asset was last updated, added, or deleted in Cloud SCC.
|
||||||
# SCC.
|
|
||||||
# Corresponds to the JSON property `updateTime`
|
# Corresponds to the JSON property `updateTime`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :update_time
|
attr_accessor :update_time
|
||||||
|
|
@ -345,17 +333,15 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Security Command Center finding.
|
# Security Command Center finding. A finding is a record of assessment data (
|
||||||
# A finding is a record of assessment data (security, risk, health or privacy)
|
# security, risk, health or privacy) ingested into Security Command Center for
|
||||||
# ingested into Security Command Center for presentation, notification,
|
# presentation, notification, analysis, policy testing, and enforcement. For
|
||||||
# analysis, policy testing, and enforcement. For example, an XSS vulnerability
|
# example, an XSS vulnerability in an App Engine application is a finding.
|
||||||
# in an App Engine application is a finding.
|
|
||||||
class GoogleCloudSecuritycenterV1p1beta1Finding
|
class GoogleCloudSecuritycenterV1p1beta1Finding
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The additional taxonomy group within findings from a given source.
|
# The additional taxonomy group within findings from a given source. This field
|
||||||
# This field is immutable after creation time.
|
# is immutable after creation time. Example: "XSS_FLASH_INJECTION"
|
||||||
# Example: "XSS_FLASH_INJECTION"
|
|
||||||
# Corresponds to the JSON property `category`
|
# Corresponds to the JSON property `category`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :category
|
attr_accessor :category
|
||||||
|
|
@ -365,59 +351,56 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :create_time
|
attr_accessor :create_time
|
||||||
|
|
||||||
# The time at which the event took place. For example, if the finding
|
# The time at which the event took place. For example, if the finding represents
|
||||||
# represents an open firewall it would capture the time the detector believes
|
# an open firewall it would capture the time the detector believes the firewall
|
||||||
# the firewall became open. The accuracy is determined by the detector.
|
# became open. The accuracy is determined by the detector.
|
||||||
# Corresponds to the JSON property `eventTime`
|
# Corresponds to the JSON property `eventTime`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :event_time
|
attr_accessor :event_time
|
||||||
|
|
||||||
# The URI that, if available, points to a web page outside of Security
|
# The URI that, if available, points to a web page outside of Security Command
|
||||||
# Command Center where additional information about the finding can be found.
|
# Center where additional information about the finding can be found. This field
|
||||||
# This field is guaranteed to be either empty or a well formed URL.
|
# is guaranteed to be either empty or a well formed URL.
|
||||||
# Corresponds to the JSON property `externalUri`
|
# Corresponds to the JSON property `externalUri`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :external_uri
|
attr_accessor :external_uri
|
||||||
|
|
||||||
# The relative resource name of this finding. See:
|
# The relative resource name of this finding. See: https://cloud.google.com/apis/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# design/resource_names#relative_resource_name Example: "organizations/`
|
||||||
# Example:
|
# organization_id`/sources/`source_id`/findings/`finding_id`"
|
||||||
# "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`"
|
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# The relative resource name of the source the finding belongs to. See:
|
# The relative resource name of the source the finding belongs to. See: https://
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# cloud.google.com/apis/design/resource_names#relative_resource_name This field
|
||||||
# This field is immutable after creation time.
|
# is immutable after creation time. For example: "organizations/`organization_id`
|
||||||
# For example:
|
# /sources/`source_id`"
|
||||||
# "organizations/`organization_id`/sources/`source_id`"
|
|
||||||
# Corresponds to the JSON property `parent`
|
# Corresponds to the JSON property `parent`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :parent
|
attr_accessor :parent
|
||||||
|
|
||||||
# For findings on Google Cloud resources, the full resource
|
# For findings on Google Cloud resources, the full resource name of the Google
|
||||||
# name of the Google Cloud resource this finding is for. See:
|
# Cloud resource this finding is for. See: https://cloud.google.com/apis/design/
|
||||||
# https://cloud.google.com/apis/design/resource_names#full_resource_name
|
# resource_names#full_resource_name When the finding is for a non-Google Cloud
|
||||||
# When the finding is for a non-Google Cloud resource, the resourceName can
|
# resource, the resourceName can be a customer or partner defined string. This
|
||||||
# be a customer or partner defined string. This field is immutable after
|
# field is immutable after creation time.
|
||||||
# creation time.
|
|
||||||
# Corresponds to the JSON property `resourceName`
|
# Corresponds to the JSON property `resourceName`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :resource_name
|
attr_accessor :resource_name
|
||||||
|
|
||||||
# User specified security marks that are attached to the parent Security
|
# User specified security marks that are attached to the parent Security Command
|
||||||
# Command Center resource. Security marks are scoped within a Security Command
|
# Center resource. Security marks are scoped within a Security Command Center
|
||||||
# Center organization -- they can be modified and viewed by all users who have
|
# organization -- they can be modified and viewed by all users who have proper
|
||||||
# proper permissions on the organization.
|
# permissions on the organization.
|
||||||
# Corresponds to the JSON property `securityMarks`
|
# Corresponds to the JSON property `securityMarks`
|
||||||
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks]
|
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks]
|
||||||
attr_accessor :security_marks
|
attr_accessor :security_marks
|
||||||
|
|
||||||
# Source specific properties. These properties are managed by the source
|
# Source specific properties. These properties are managed by the source that
|
||||||
# that writes the finding. The key names in the source_properties map must be
|
# writes the finding. The key names in the source_properties map must be between
|
||||||
# between 1 and 255 characters, and must start with a letter and contain
|
# 1 and 255 characters, and must start with a letter and contain alphanumeric
|
||||||
# alphanumeric characters or underscores only.
|
# characters or underscores only.
|
||||||
# Corresponds to the JSON property `sourceProperties`
|
# Corresponds to the JSON property `sourceProperties`
|
||||||
# @return [Hash<String,Object>]
|
# @return [Hash<String,Object>]
|
||||||
attr_accessor :source_properties
|
attr_accessor :source_properties
|
||||||
|
|
@ -448,14 +431,12 @@ module Google
|
||||||
|
|
||||||
# Cloud IAM Policy information associated with the Google Cloud resource
|
# Cloud IAM Policy information associated with the Google Cloud resource
|
||||||
# described by the Security Command Center asset. This information is managed
|
# described by the Security Command Center asset. This information is managed
|
||||||
# and defined by the Google Cloud resource and cannot be modified by the
|
# and defined by the Google Cloud resource and cannot be modified by the user.
|
||||||
# user.
|
|
||||||
class GoogleCloudSecuritycenterV1p1beta1IamPolicy
|
class GoogleCloudSecuritycenterV1p1beta1IamPolicy
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The JSON representation of the Policy associated with the asset.
|
# The JSON representation of the Policy associated with the asset. See https://
|
||||||
# See https://cloud.google.com/iam/docs/reference/rest/v1/Policy for
|
# cloud.google.com/iam/docs/reference/rest/v1/Policy for format details.
|
||||||
# format details.
|
|
||||||
# Corresponds to the JSON property `policyBlob`
|
# Corresponds to the JSON property `policyBlob`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :policy_blob
|
attr_accessor :policy_blob
|
||||||
|
|
@ -474,11 +455,10 @@ module Google
|
||||||
class GoogleCloudSecuritycenterV1p1beta1NotificationMessage
|
class GoogleCloudSecuritycenterV1p1beta1NotificationMessage
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Security Command Center finding.
|
# Security Command Center finding. A finding is a record of assessment data (
|
||||||
# A finding is a record of assessment data (security, risk, health or privacy)
|
# security, risk, health or privacy) ingested into Security Command Center for
|
||||||
# ingested into Security Command Center for presentation, notification,
|
# presentation, notification, analysis, policy testing, and enforcement. For
|
||||||
# analysis, policy testing, and enforcement. For example, an XSS vulnerability
|
# example, an XSS vulnerability in an App Engine application is a finding.
|
||||||
# in an App Engine application is a finding.
|
|
||||||
# Corresponds to the JSON property `finding`
|
# Corresponds to the JSON property `finding`
|
||||||
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Finding]
|
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Finding]
|
||||||
attr_accessor :finding
|
attr_accessor :finding
|
||||||
|
|
@ -493,8 +473,8 @@ module Google
|
||||||
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Resource]
|
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Resource]
|
||||||
attr_accessor :resource
|
attr_accessor :resource
|
||||||
|
|
||||||
# Wrapper over asset object that also captures the state change for the asset
|
# Wrapper over asset object that also captures the state change for the asset e.
|
||||||
# e.g. if it was a newly created asset vs updated or deleted asset.
|
# g. if it was a newly created asset vs updated or deleted asset.
|
||||||
# Corresponds to the JSON property `temporalAsset`
|
# Corresponds to the JSON property `temporalAsset`
|
||||||
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1TemporalAsset]
|
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1TemporalAsset]
|
||||||
attr_accessor :temporal_asset
|
attr_accessor :temporal_asset
|
||||||
|
|
@ -516,8 +496,8 @@ module Google
|
||||||
class GoogleCloudSecuritycenterV1p1beta1Resource
|
class GoogleCloudSecuritycenterV1p1beta1Resource
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# The full resource name of the resource. See:
|
# The full resource name of the resource. See: https://cloud.google.com/apis/
|
||||||
# https://cloud.google.com/apis/design/resource_names#full_resource_name
|
# design/resource_names#full_resource_name
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
@ -591,9 +571,9 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :resource_display_name
|
attr_accessor :resource_display_name
|
||||||
|
|
||||||
# The full resource name of the Google Cloud resource this asset
|
# The full resource name of the Google Cloud resource this asset represents.
|
||||||
# represents. This field is immutable after create time. See:
|
# This field is immutable after create time. See: https://cloud.google.com/apis/
|
||||||
# https://cloud.google.com/apis/design/resource_names#full_resource_name
|
# design/resource_names#full_resource_name
|
||||||
# Corresponds to the JSON property `resourceName`
|
# Corresponds to the JSON property `resourceName`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :resource_name
|
attr_accessor :resource_name
|
||||||
|
|
@ -603,8 +583,8 @@ module Google
|
||||||
# @return [Array<String>]
|
# @return [Array<String>]
|
||||||
attr_accessor :resource_owners
|
attr_accessor :resource_owners
|
||||||
|
|
||||||
# The full resource name of the immediate parent of the resource. See:
|
# The full resource name of the immediate parent of the resource. See: https://
|
||||||
# https://cloud.google.com/apis/design/resource_names#full_resource_name
|
# cloud.google.com/apis/design/resource_names#full_resource_name
|
||||||
# Corresponds to the JSON property `resourceParent`
|
# Corresponds to the JSON property `resourceParent`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :resource_parent
|
attr_accessor :resource_parent
|
||||||
|
|
@ -614,8 +594,8 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :resource_parent_display_name
|
attr_accessor :resource_parent_display_name
|
||||||
|
|
||||||
# The full resource name of the project the resource belongs to. See:
|
# The full resource name of the project the resource belongs to. See: https://
|
||||||
# https://cloud.google.com/apis/design/resource_names#full_resource_name
|
# cloud.google.com/apis/design/resource_names#full_resource_name
|
||||||
# Corresponds to the JSON property `resourceProject`
|
# Corresponds to the JSON property `resourceProject`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :resource_project
|
attr_accessor :resource_project
|
||||||
|
|
@ -625,10 +605,9 @@ module Google
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :resource_project_display_name
|
attr_accessor :resource_project_display_name
|
||||||
|
|
||||||
# The type of the Google Cloud resource. Examples include: APPLICATION,
|
# The type of the Google Cloud resource. Examples include: APPLICATION, PROJECT,
|
||||||
# PROJECT, and ORGANIZATION. This is a case insensitive field defined by
|
# and ORGANIZATION. This is a case insensitive field defined by Security Command
|
||||||
# Security Command Center and/or the producer of the resource and is
|
# Center and/or the producer of the resource and is immutable after create time.
|
||||||
# immutable after create time.
|
|
||||||
# Corresponds to the JSON property `resourceType`
|
# Corresponds to the JSON property `resourceType`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :resource_type
|
attr_accessor :resource_type
|
||||||
|
|
@ -650,30 +629,26 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# User specified security marks that are attached to the parent Security
|
# User specified security marks that are attached to the parent Security Command
|
||||||
# Command Center resource. Security marks are scoped within a Security Command
|
# Center resource. Security marks are scoped within a Security Command Center
|
||||||
# Center organization -- they can be modified and viewed by all users who have
|
# organization -- they can be modified and viewed by all users who have proper
|
||||||
# proper permissions on the organization.
|
# permissions on the organization.
|
||||||
class GoogleCloudSecuritycenterV1p1beta1SecurityMarks
|
class GoogleCloudSecuritycenterV1p1beta1SecurityMarks
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Mutable user specified security marks belonging to the parent resource.
|
# Mutable user specified security marks belonging to the parent resource.
|
||||||
# Constraints are as follows:
|
# Constraints are as follows: * Keys and values are treated as case insensitive *
|
||||||
# * Keys and values are treated as case insensitive
|
# Keys must be between 1 - 256 characters (inclusive) * Keys must be letters,
|
||||||
# * Keys must be between 1 - 256 characters (inclusive)
|
# numbers, underscores, or dashes * Values have leading and trailing whitespace
|
||||||
# * Keys must be letters, numbers, underscores, or dashes
|
# trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
|
||||||
# * Values have leading and trailing whitespace trimmed, remaining
|
|
||||||
# characters must be between 1 - 4096 characters (inclusive)
|
|
||||||
# Corresponds to the JSON property `marks`
|
# Corresponds to the JSON property `marks`
|
||||||
# @return [Hash<String,String>]
|
# @return [Hash<String,String>]
|
||||||
attr_accessor :marks
|
attr_accessor :marks
|
||||||
|
|
||||||
# The relative resource name of the SecurityMarks. See:
|
# The relative resource name of the SecurityMarks. See: https://cloud.google.com/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# apis/design/resource_names#relative_resource_name Examples: "organizations/`
|
||||||
# Examples:
|
# organization_id`/assets/`asset_id`/securityMarks" "organizations/`
|
||||||
# "organizations/`organization_id`/assets/`asset_id`/securityMarks"
|
# organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks".
|
||||||
# "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/
|
|
||||||
# securityMarks".
|
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
@ -689,17 +664,16 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Wrapper over asset object that also captures the state change for the asset
|
# Wrapper over asset object that also captures the state change for the asset e.
|
||||||
# e.g. if it was a newly created asset vs updated or deleted asset.
|
# g. if it was a newly created asset vs updated or deleted asset.
|
||||||
class GoogleCloudSecuritycenterV1p1beta1TemporalAsset
|
class GoogleCloudSecuritycenterV1p1beta1TemporalAsset
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Security Command Center representation of a Google Cloud
|
# Security Command Center representation of a Google Cloud resource. The Asset
|
||||||
# resource.
|
# is a Security Command Center resource that captures information about a single
|
||||||
# The Asset is a Security Command Center resource that captures information
|
# Google Cloud resource. All modifications to an Asset are only within the
|
||||||
# about a single Google Cloud resource. All modifications to an Asset are only
|
# context of Security Command Center and don't affect the referenced Google
|
||||||
# within the context of Security Command Center and don't affect the referenced
|
# Cloud resource.
|
||||||
# Google Cloud resource.
|
|
||||||
# Corresponds to the JSON property `asset`
|
# Corresponds to the JSON property `asset`
|
||||||
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Asset]
|
# @return [Google::Apis::SecuritycenterV1p1alpha1::GoogleCloudSecuritycenterV1p1beta1Asset]
|
||||||
attr_accessor :asset
|
attr_accessor :asset
|
||||||
|
|
@ -750,47 +724,45 @@ module Google
|
||||||
class Operation
|
class Operation
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# If the value is `false`, it means the operation is still in progress.
|
# If the value is `false`, it means the operation is still in progress. If `true`
|
||||||
# If `true`, the operation is completed, and either `error` or `response` is
|
# , the operation is completed, and either `error` or `response` is available.
|
||||||
# available.
|
|
||||||
# Corresponds to the JSON property `done`
|
# Corresponds to the JSON property `done`
|
||||||
# @return [Boolean]
|
# @return [Boolean]
|
||||||
attr_accessor :done
|
attr_accessor :done
|
||||||
alias_method :done?, :done
|
alias_method :done?, :done
|
||||||
|
|
||||||
# The `Status` type defines a logical error model that is suitable for
|
# The `Status` type defines a logical error model that is suitable for different
|
||||||
# different programming environments, including REST APIs and RPC APIs. It is
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
||||||
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
||||||
# three pieces of data: error code, error message, and error details.
|
# data: error code, error message, and error details. You can find out more
|
||||||
# You can find out more about this error model and how to work with it in the
|
# about this error model and how to work with it in the [API Design Guide](https:
|
||||||
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
# //cloud.google.com/apis/design/errors).
|
||||||
# Corresponds to the JSON property `error`
|
# Corresponds to the JSON property `error`
|
||||||
# @return [Google::Apis::SecuritycenterV1p1alpha1::Status]
|
# @return [Google::Apis::SecuritycenterV1p1alpha1::Status]
|
||||||
attr_accessor :error
|
attr_accessor :error
|
||||||
|
|
||||||
# Service-specific metadata associated with the operation. It typically
|
# Service-specific metadata associated with the operation. It typically contains
|
||||||
# contains progress information and common metadata such as create time.
|
# progress information and common metadata such as create time. Some services
|
||||||
# Some services might not provide such metadata. Any method that returns a
|
# might not provide such metadata. Any method that returns a long-running
|
||||||
# long-running operation should document the metadata type, if any.
|
# operation should document the metadata type, if any.
|
||||||
# Corresponds to the JSON property `metadata`
|
# Corresponds to the JSON property `metadata`
|
||||||
# @return [Hash<String,Object>]
|
# @return [Hash<String,Object>]
|
||||||
attr_accessor :metadata
|
attr_accessor :metadata
|
||||||
|
|
||||||
# The server-assigned name, which is only unique within the same service that
|
# The server-assigned name, which is only unique within the same service that
|
||||||
# originally returns it. If you use the default HTTP mapping, the
|
# originally returns it. If you use the default HTTP mapping, the `name` should
|
||||||
# `name` should be a resource name ending with `operations/`unique_id``.
|
# be a resource name ending with `operations/`unique_id``.
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
||||||
# The normal response of the operation in case of success. If the original
|
# 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
|
# method returns no data on success, such as `Delete`, the response is `google.
|
||||||
# `google.protobuf.Empty`. If the original method is standard
|
# protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
|
||||||
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
# the response should be the resource. For other methods, the response should
|
||||||
# methods, the response should have the type `XxxResponse`, where `Xxx`
|
# have the type `XxxResponse`, where `Xxx` is the original method name. For
|
||||||
# is the original method name. For example, if the original method name
|
# example, if the original method name is `TakeSnapshot()`, the inferred
|
||||||
# is `TakeSnapshot()`, the inferred response type is
|
# response type is `TakeSnapshotResponse`.
|
||||||
# `TakeSnapshotResponse`.
|
|
||||||
# Corresponds to the JSON property `response`
|
# Corresponds to the JSON property `response`
|
||||||
# @return [Hash<String,Object>]
|
# @return [Hash<String,Object>]
|
||||||
attr_accessor :response
|
attr_accessor :response
|
||||||
|
|
@ -809,30 +781,26 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# User specified security marks that are attached to the parent Security
|
# User specified security marks that are attached to the parent Security Command
|
||||||
# Command Center resource. Security marks are scoped within a Security Command
|
# Center resource. Security marks are scoped within a Security Command Center
|
||||||
# Center organization -- they can be modified and viewed by all users who have
|
# organization -- they can be modified and viewed by all users who have proper
|
||||||
# proper permissions on the organization.
|
# permissions on the organization.
|
||||||
class SecurityMarks
|
class SecurityMarks
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
# Mutable user specified security marks belonging to the parent resource.
|
# Mutable user specified security marks belonging to the parent resource.
|
||||||
# Constraints are as follows:
|
# Constraints are as follows: * Keys and values are treated as case insensitive *
|
||||||
# * Keys and values are treated as case insensitive
|
# Keys must be between 1 - 256 characters (inclusive) * Keys must be letters,
|
||||||
# * Keys must be between 1 - 256 characters (inclusive)
|
# numbers, underscores, or dashes * Values have leading and trailing whitespace
|
||||||
# * Keys must be letters, numbers, underscores, or dashes
|
# trimmed, remaining characters must be between 1 - 4096 characters (inclusive)
|
||||||
# * Values have leading and trailing whitespace trimmed, remaining
|
|
||||||
# characters must be between 1 - 4096 characters (inclusive)
|
|
||||||
# Corresponds to the JSON property `marks`
|
# Corresponds to the JSON property `marks`
|
||||||
# @return [Hash<String,String>]
|
# @return [Hash<String,String>]
|
||||||
attr_accessor :marks
|
attr_accessor :marks
|
||||||
|
|
||||||
# The relative resource name of the SecurityMarks. See:
|
# The relative resource name of the SecurityMarks. See: https://cloud.google.com/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# apis/design/resource_names#relative_resource_name Examples: "organizations/`
|
||||||
# Examples:
|
# organization_id`/assets/`asset_id`/securityMarks" "organizations/`
|
||||||
# "organizations/`organization_id`/assets/`asset_id`/securityMarks"
|
# organization_id`/sources/`source_id`/findings/`finding_id`/securityMarks".
|
||||||
# "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`/
|
|
||||||
# securityMarks".
|
|
||||||
# Corresponds to the JSON property `name`
|
# Corresponds to the JSON property `name`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :name
|
attr_accessor :name
|
||||||
|
|
@ -848,12 +816,12 @@ module Google
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# The `Status` type defines a logical error model that is suitable for
|
# The `Status` type defines a logical error model that is suitable for different
|
||||||
# different programming environments, including REST APIs and RPC APIs. It is
|
# programming environments, including REST APIs and RPC APIs. It is used by [
|
||||||
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
|
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
|
||||||
# three pieces of data: error code, error message, and error details.
|
# data: error code, error message, and error details. You can find out more
|
||||||
# You can find out more about this error model and how to work with it in the
|
# about this error model and how to work with it in the [API Design Guide](https:
|
||||||
# [API Design Guide](https://cloud.google.com/apis/design/errors).
|
# //cloud.google.com/apis/design/errors).
|
||||||
class Status
|
class Status
|
||||||
include Google::Apis::Core::Hashable
|
include Google::Apis::Core::Hashable
|
||||||
|
|
||||||
|
|
@ -862,15 +830,15 @@ module Google
|
||||||
# @return [Fixnum]
|
# @return [Fixnum]
|
||||||
attr_accessor :code
|
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.
|
# message types for APIs to use.
|
||||||
# Corresponds to the JSON property `details`
|
# Corresponds to the JSON property `details`
|
||||||
# @return [Array<Hash<String,Object>>]
|
# @return [Array<Hash<String,Object>>]
|
||||||
attr_accessor :details
|
attr_accessor :details
|
||||||
|
|
||||||
# A developer-facing error message, which should be in English. Any
|
# A developer-facing error message, which should be in English. Any user-facing
|
||||||
# user-facing error message should be localized and sent in the
|
# error message should be localized and sent in the google.rpc.Status.details
|
||||||
# google.rpc.Status.details field, or localized by the client.
|
# field, or localized by the client.
|
||||||
# Corresponds to the JSON property `message`
|
# Corresponds to the JSON property `message`
|
||||||
# @return [String]
|
# @return [String]
|
||||||
attr_accessor :message
|
attr_accessor :message
|
||||||
|
|
|
||||||
|
|
@ -48,15 +48,13 @@ module Google
|
||||||
@batch_path = 'batch'
|
@batch_path = 'batch'
|
||||||
end
|
end
|
||||||
|
|
||||||
# Starts asynchronous cancellation on a long-running operation. The server
|
# Starts asynchronous cancellation on a long-running operation. The server makes
|
||||||
# makes a best effort to cancel the operation, but success is not
|
# a best effort to cancel the operation, but success is not guaranteed. If the
|
||||||
# guaranteed. If the server doesn't support this method, it returns
|
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
# Clients can use Operations.GetOperation or other methods to check whether the
|
||||||
# Operations.GetOperation or
|
# cancellation succeeded or whether the operation completed despite cancellation.
|
||||||
# other methods to check whether the cancellation succeeded or whether the
|
# On successful cancellation, the operation is not deleted; instead, it becomes
|
||||||
# operation completed despite cancellation. On successful cancellation,
|
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
||||||
# 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`.
|
# corresponding to `Code.CANCELLED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be cancelled.
|
# The name of the operation resource to be cancelled.
|
||||||
|
|
@ -87,10 +85,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Deletes a long-running operation. This method indicates that the client is
|
# Deletes a long-running operation. This method indicates that the client is no
|
||||||
# no longer interested in the operation result. It does not cancel the
|
# longer interested in the operation result. It does not cancel the operation.
|
||||||
# operation. If the server doesn't support this method, it returns
|
# If the server doesn't support this method, it returns `google.rpc.Code.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`.
|
# UNIMPLEMENTED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be deleted.
|
# The name of the operation resource to be deleted.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -120,9 +118,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the latest state of a long-running operation. Clients can use this
|
# Gets the latest state of a long-running operation. Clients can use this method
|
||||||
# method to poll the operation result at intervals as recommended by the API
|
# to poll the operation result at intervals as recommended by the API service.
|
||||||
# service.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource.
|
# The name of the operation resource.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -152,15 +149,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists operations that match the specified filter in the request. If the
|
# Lists operations that match the specified filter in the request. If the server
|
||||||
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
||||||
# NOTE: the `name` binding allows API services to override the binding
|
# binding allows API services to override the binding to use different resource
|
||||||
# to use different resource name schemes, such as `users/*/operations`. To
|
# name schemes, such as `users/*/operations`. To override the binding, API
|
||||||
# override the binding, API services can add a binding such as
|
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
||||||
# `"/v1/`name=users/*`/operations"` to their service configuration.
|
# service configuration. For backwards compatibility, the default name includes
|
||||||
# For backwards compatibility, the default name includes the operations
|
# the operations collection id, however overriding users must ensure the name
|
||||||
# collection id, however overriding users must ensure the name binding
|
# binding is the parent resource, without the operations collection id.
|
||||||
# is the parent resource, without the operations collection id.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation's parent resource.
|
# The name of the operation's parent resource.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ module Google
|
||||||
# @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview
|
# @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview
|
||||||
module SecuritycenterV1p1beta1
|
module SecuritycenterV1p1beta1
|
||||||
VERSION = 'V1p1beta1'
|
VERSION = 'V1p1beta1'
|
||||||
REVISION = '20200619'
|
REVISION = '20200731'
|
||||||
|
|
||||||
# View and manage your data across Google Cloud Platform services
|
# View and manage your data across Google Cloud Platform services
|
||||||
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -51,8 +51,7 @@ module Google
|
||||||
# Gets the settings for an organization.
|
# Gets the settings for an organization.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. Name of the organization to get organization settings for. Its
|
# Required. Name of the organization to get organization settings for. Its
|
||||||
# format is
|
# format is "organizations/[organization_id]/organizationSettings".
|
||||||
# "organizations/[organization_id]/organizationSettings".
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -82,14 +81,13 @@ module Google
|
||||||
|
|
||||||
# Updates an organization's settings.
|
# Updates an organization's settings.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of the settings. See:
|
# The relative resource name of the settings. See: https://cloud.google.com/apis/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# design/resource_names#relative_resource_name Example: "organizations/`
|
||||||
# Example:
|
# organization_id`/organizationSettings".
|
||||||
# "organizations/`organization_id`/organizationSettings".
|
|
||||||
# @param [Google::Apis::SecuritycenterV1p1beta1::OrganizationSettings] organization_settings_object
|
# @param [Google::Apis::SecuritycenterV1p1beta1::OrganizationSettings] organization_settings_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# The FieldMask to use when updating the settings resource.
|
# The FieldMask to use when updating the settings resource. If empty all mutable
|
||||||
# If empty all mutable fields will be updated.
|
# fields will be updated.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -120,11 +118,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Filters an organization's assets and groups them by their specified
|
# Filters an organization's assets and groups them by their specified properties.
|
||||||
# properties.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the organization to groupBy. Its format is
|
# Required. Name of the organization to groupBy. Its format is "organizations/[
|
||||||
# "organizations/[organization_id]".
|
# organization_id]".
|
||||||
# @param [Google::Apis::SecuritycenterV1p1beta1::GroupAssetsRequest] group_assets_request_object
|
# @param [Google::Apis::SecuritycenterV1p1beta1::GroupAssetsRequest] group_assets_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -157,114 +154,86 @@ module Google
|
||||||
|
|
||||||
# Lists an organization's assets.
|
# Lists an organization's assets.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the organization assets should belong to. Its format is
|
# Required. Name of the organization assets should belong to. Its format is "
|
||||||
# "organizations/[organization_id]".
|
# organizations/[organization_id]".
|
||||||
# @param [String] compare_duration
|
# @param [String] compare_duration
|
||||||
# When compare_duration is set, the ListAssetsResult's "state_change"
|
# When compare_duration is set, the ListAssetsResult's "state_change" attribute
|
||||||
# attribute is updated to indicate whether the asset was added, removed, or
|
# is updated to indicate whether the asset was added, removed, or remained
|
||||||
# remained present during the compare_duration period of time that precedes
|
# present during the compare_duration period of time that precedes the read_time.
|
||||||
# the read_time. This is the time between (read_time - compare_duration) and
|
# This is the time between (read_time - compare_duration) and read_time. The
|
||||||
# read_time.
|
# state_change value is derived based on the presence of the asset at the two
|
||||||
# The state_change value is derived based on the presence of the asset at the
|
# points in time. Intermediate state changes between the two times don't affect
|
||||||
# two points in time. Intermediate state changes between the two times don't
|
# the result. For example, the results aren't affected if the asset is removed
|
||||||
# affect the result. For example, the results aren't affected if the asset is
|
# and re-created again. Possible "state_change" values when compare_duration is
|
||||||
# removed and re-created again.
|
# specified: * "ADDED": indicates that the asset was not present at the start of
|
||||||
# Possible "state_change" values when compare_duration is specified:
|
# compare_duration, but present at read_time. * "REMOVED": indicates that the
|
||||||
# * "ADDED": indicates that the asset was not present at the start of
|
# asset was present at the start of compare_duration, but not present at
|
||||||
# compare_duration, but present at read_time.
|
# read_time. * "ACTIVE": indicates that the asset was present at both the start
|
||||||
# * "REMOVED": indicates that the asset was present at the start of
|
# and the end of the time period defined by compare_duration and read_time. If
|
||||||
# compare_duration, but not present at read_time.
|
# compare_duration is not specified, then the only possible state_change is "
|
||||||
# * "ACTIVE": indicates that the asset was present at both the
|
# UNUSED", which will be the state_change set for all assets present at
|
||||||
# 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.
|
# read_time.
|
||||||
# @param [String] field_mask
|
# @param [String] field_mask
|
||||||
# A field mask to specify the ListAssetsResult fields to be listed in the
|
# A field mask to specify the ListAssetsResult fields to be listed in the
|
||||||
# response.
|
# response. An empty field mask will list all fields.
|
||||||
# An empty field mask will list all fields.
|
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# Expression that defines the filter to apply across assets.
|
# Expression that defines the filter to apply across assets. The expression is a
|
||||||
# The expression is a list of zero or more restrictions combined via logical
|
# list of zero or more restrictions combined via logical operators `AND` and `OR`
|
||||||
# operators `AND` and `OR`.
|
# . Parentheses are supported, and `OR` has higher precedence than `AND`.
|
||||||
# Parentheses are supported, and `OR` has higher precedence than `AND`.
|
# Restrictions have the form ` ` and may have a `-` character in front of them
|
||||||
# Restrictions have the form `<field> <operator> <value>` and may have a `-`
|
# to indicate negation. The fields map to those defined in the Asset resource.
|
||||||
# character in front of them to indicate negation. The fields map to those
|
# Examples include: * name * security_center_properties.resource_name *
|
||||||
# defined in the Asset resource. Examples include:
|
# resource_properties.a_property * security_marks.marks.marka The supported
|
||||||
# * name
|
# operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer
|
||||||
# * security_center_properties.resource_name
|
# values. * `:`, meaning substring matching, for strings. The supported value
|
||||||
# * resource_properties.a_property
|
# types are: * string literals in quotes. * integer literals without quotes. *
|
||||||
# * security_marks.marks.marka
|
# boolean literals `true` and `false` without quotes. The following are the
|
||||||
# The supported operators are:
|
# allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `
|
||||||
# * `=` for all value types.
|
# <`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339
|
||||||
# * `>`, `<`, `>=`, `<=` for integer values.
|
# string. Examples: `update_time = "2019-06-10T16:07:18-07:00"` `update_time =
|
||||||
# * `:`, meaning substring matching, for strings.
|
# 1560208038000` * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be
|
||||||
# The supported value types are:
|
# milliseconds since epoch or an RFC3339 string. Examples: `create_time = "2019-
|
||||||
# * string literals in quotes.
|
# 06-10T16:07:18-07:00"` `create_time = 1560208038000` * iam_policy.policy_blob:
|
||||||
# * integer literals without quotes.
|
# `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` *
|
||||||
# * boolean literals `true` and `false` without quotes.
|
# security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`,
|
||||||
# The following are the allowed field and operator combinations:
|
# `:` * security_center_properties.resource_display_name: `=`, `:` *
|
||||||
# * name: `=`
|
# security_center_properties.resource_type: `=`, `:` *
|
||||||
# * update_time: `=`, `>`, `<`, `>=`, `<=`
|
# security_center_properties.resource_parent: `=`, `:` *
|
||||||
# Usage: This should be milliseconds since epoch or an RFC3339 string.
|
# security_center_properties.resource_parent_display_name: `=`, `:` *
|
||||||
# Examples:
|
# security_center_properties.resource_project: `=`, `:` *
|
||||||
# `update_time = "2019-06-10T16:07:18-07:00"`
|
# security_center_properties.resource_project_display_name: `=`, `:` *
|
||||||
# `update_time = 1560208038000`
|
# security_center_properties.resource_owners: `=`, `:` For example, `
|
||||||
# * create_time: `=`, `>`, `<`, `>=`, `<=`
|
# resource_properties.size = 100` is a valid filter string. Use a partial match
|
||||||
# Usage: This should be milliseconds since epoch or an RFC3339 string.
|
# on the empty string to filter based on a property existing: `
|
||||||
# Examples:
|
# resource_properties.my_property : ""` Use a negated partial match on the empty
|
||||||
# `create_time = "2019-06-10T16:07:18-07:00"`
|
# string to filter based on a property not existing: `-resource_properties.
|
||||||
# `create_time = 1560208038000`
|
# my_property : ""`
|
||||||
# * 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
|
# @param [String] order_by
|
||||||
# Expression that defines what fields and order to use for sorting. The
|
# Expression that defines what fields and order to use for sorting. The string
|
||||||
# string value should follow SQL syntax: comma separated list of fields. For
|
# value should follow SQL syntax: comma separated list of fields. For example: "
|
||||||
# example: "name,resource_properties.a_property". The default sorting order
|
# name,resource_properties.a_property". The default sorting order is ascending.
|
||||||
# is ascending. To specify descending order for a field, a suffix " desc"
|
# To specify descending order for a field, a suffix " desc" should be appended
|
||||||
# should be appended to the field name. For example: "name
|
# to the field name. For example: "name desc,resource_properties.a_property".
|
||||||
# desc,resource_properties.a_property". Redundant space characters in the
|
# Redundant space characters in the syntax are insignificant. "name desc,
|
||||||
# syntax are insignificant. "name desc,resource_properties.a_property" and "
|
# resource_properties.a_property" and " name desc , resource_properties.
|
||||||
# name desc , resource_properties.a_property " are equivalent.
|
# a_property " are equivalent. The following fields are supported: name
|
||||||
# The following fields are supported:
|
# update_time resource_properties security_marks.marks
|
||||||
# name
|
# security_center_properties.resource_name security_center_properties.
|
||||||
# update_time
|
# resource_display_name security_center_properties.resource_parent
|
||||||
# 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_parent_display_name
|
||||||
# security_center_properties.resource_project
|
# security_center_properties.resource_project security_center_properties.
|
||||||
# security_center_properties.resource_project_display_name
|
# resource_project_display_name security_center_properties.resource_type
|
||||||
# security_center_properties.resource_type
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of results to return in a single response. Default is
|
# The maximum number of results to return in a single response. Default is 10,
|
||||||
# 10, minimum is 1, maximum is 1000.
|
# minimum is 1, maximum is 1000.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The value returned by the last `ListAssetsResponse`; indicates
|
# The value returned by the last `ListAssetsResponse`; indicates that this is a
|
||||||
# that this is a continuation of a prior `ListAssets` call, and
|
# continuation of a prior `ListAssets` call, and that the system should return
|
||||||
# that the system should return the next page of data.
|
# the next page of data.
|
||||||
# @param [String] read_time
|
# @param [String] read_time
|
||||||
# Time used as a reference point when filtering assets. The filter is limited
|
# Time used as a reference point when filtering assets. The filter is limited to
|
||||||
# to assets existing at the supplied time and their values are those at that
|
# 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
|
# specific time. Absence of this field will default to the API's version of NOW.
|
||||||
# NOW.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -299,15 +268,12 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Runs asset discovery. The discovery is tracked with a long-running
|
# Runs asset discovery. The discovery is tracked with a long-running operation. /
|
||||||
# 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.
|
||||||
# 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
|
# @param [String] parent
|
||||||
# Required. Name of the organization to run asset discovery for. Its format is
|
# Required. Name of the organization to run asset discovery for. Its format is "
|
||||||
# "organizations/[organization_id]".
|
# organizations/[organization_id]".
|
||||||
# @param [Google::Apis::SecuritycenterV1p1beta1::RunAssetDiscoveryRequest] run_asset_discovery_request_object
|
# @param [Google::Apis::SecuritycenterV1p1beta1::RunAssetDiscoveryRequest] run_asset_discovery_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -340,22 +306,19 @@ module Google
|
||||||
|
|
||||||
# Updates security marks.
|
# Updates security marks.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of the SecurityMarks. See:
|
# The relative resource name of the SecurityMarks. See: https://cloud.google.com/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# apis/design/resource_names#relative_resource_name Examples: "organizations/`
|
||||||
# Examples:
|
# organization_id`/assets/`asset_id`/securityMarks" "organizations/`
|
||||||
# "organizations/`organization_id`/assets/`asset_id`/securityMarks"
|
# organization_id`/sources/`source_id`/findings/`finding_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 [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] google_cloud_securitycenter_v1p1beta1_security_marks_object
|
||||||
# @param [String] start_time
|
# @param [String] start_time
|
||||||
# The time at which the updated SecurityMarks take effect.
|
# The time at which the updated SecurityMarks take effect. If not set uses
|
||||||
# If not set uses current server time. Updates will be applied to the
|
# current server time. Updates will be applied to the SecurityMarks that are
|
||||||
# SecurityMarks that are active immediately preceding this time.
|
# active immediately preceding this time.
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# The FieldMask to use when updating the security marks resource.
|
# The FieldMask to use when updating the security marks resource. The field mask
|
||||||
# The field mask must not contain duplicate fields.
|
# must not contain duplicate fields. If empty or set to "marks", all marks will
|
||||||
# If empty or set to "marks", all marks will be replaced. Individual
|
# be replaced. Individual marks can be updated using "marks.".
|
||||||
# marks can be updated using "marks.<mark_key>".
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -393,10 +356,9 @@ module Google
|
||||||
# "organizations/[organization_id]".
|
# "organizations/[organization_id]".
|
||||||
# @param [Google::Apis::SecuritycenterV1p1beta1::NotificationConfig] notification_config_object
|
# @param [Google::Apis::SecuritycenterV1p1beta1::NotificationConfig] notification_config_object
|
||||||
# @param [String] config_id
|
# @param [String] config_id
|
||||||
# Required.
|
# Required. Unique identifier provided by the client within the parent scope. It
|
||||||
# Unique identifier provided by the client within the parent scope.
|
# must be between 1 and 128 characters, and contains alphanumeric characters,
|
||||||
# It must be between 1 and 128 characters, and contains alphanumeric
|
# underscores or hyphens only.
|
||||||
# characters, underscores or hyphens only.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -429,8 +391,8 @@ module Google
|
||||||
|
|
||||||
# Deletes a notification config.
|
# Deletes a notification config.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. Name of the notification config to delete. Its format is
|
# Required. Name of the notification config to delete. Its format is "
|
||||||
# "organizations/[organization_id]/notificationConfigs/[config_id]".
|
# organizations/[organization_id]/notificationConfigs/[config_id]".
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -460,8 +422,8 @@ module Google
|
||||||
|
|
||||||
# Gets a notification config.
|
# Gets a notification config.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. Name of the notification config to get. Its format is
|
# Required. Name of the notification config to get. Its format is "organizations/
|
||||||
# "organizations/[organization_id]/notificationConfigs/[config_id]".
|
# [organization_id]/notificationConfigs/[config_id]".
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -491,11 +453,11 @@ module Google
|
||||||
|
|
||||||
# Lists notification configs.
|
# Lists notification configs.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the organization to list notification configs.
|
# Required. Name of the organization to list notification configs. Its format is
|
||||||
# Its format is "organizations/[organization_id]".
|
# "organizations/[organization_id]".
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of results to return in a single response. Default is
|
# The maximum number of results to return in a single response. Default is 10,
|
||||||
# 10, minimum is 1, maximum is 1000.
|
# minimum is 1, maximum is 1000.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The value returned by the last `ListNotificationConfigsResponse`; indicates
|
# The value returned by the last `ListNotificationConfigsResponse`; indicates
|
||||||
# that this is a continuation of a prior `ListNotificationConfigs` call, and
|
# that this is a continuation of a prior `ListNotificationConfigs` call, and
|
||||||
|
|
@ -529,17 +491,16 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Updates a notification config. The following update
|
# Updates a notification config. The following update fields are allowed:
|
||||||
# fields are allowed: description, pubsub_topic, streaming_config.filter
|
# description, pubsub_topic, streaming_config.filter
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of this notification config. See:
|
# The relative resource name of this notification config. See: https://cloud.
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# google.com/apis/design/resource_names#relative_resource_name Example: "
|
||||||
# Example:
|
# organizations/`organization_id`/notificationConfigs/notify_public_bucket".
|
||||||
# "organizations/`organization_id`/notificationConfigs/notify_public_bucket".
|
|
||||||
# @param [Google::Apis::SecuritycenterV1p1beta1::NotificationConfig] notification_config_object
|
# @param [Google::Apis::SecuritycenterV1p1beta1::NotificationConfig] notification_config_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# The FieldMask to use when updating the notification config.
|
# The FieldMask to use when updating the notification config. If empty all
|
||||||
# If empty all mutable fields will be updated.
|
# mutable fields will be updated.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -570,15 +531,13 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Starts asynchronous cancellation on a long-running operation. The server
|
# Starts asynchronous cancellation on a long-running operation. The server makes
|
||||||
# makes a best effort to cancel the operation, but success is not
|
# a best effort to cancel the operation, but success is not guaranteed. If the
|
||||||
# guaranteed. If the server doesn't support this method, it returns
|
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
# Clients can use Operations.GetOperation or other methods to check whether the
|
||||||
# Operations.GetOperation or
|
# cancellation succeeded or whether the operation completed despite cancellation.
|
||||||
# other methods to check whether the cancellation succeeded or whether the
|
# On successful cancellation, the operation is not deleted; instead, it becomes
|
||||||
# operation completed despite cancellation. On successful cancellation,
|
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
||||||
# 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`.
|
# corresponding to `Code.CANCELLED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be cancelled.
|
# The name of the operation resource to be cancelled.
|
||||||
|
|
@ -609,10 +568,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Deletes a long-running operation. This method indicates that the client is
|
# Deletes a long-running operation. This method indicates that the client is no
|
||||||
# no longer interested in the operation result. It does not cancel the
|
# longer interested in the operation result. It does not cancel the operation.
|
||||||
# operation. If the server doesn't support this method, it returns
|
# If the server doesn't support this method, it returns `google.rpc.Code.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`.
|
# UNIMPLEMENTED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be deleted.
|
# The name of the operation resource to be deleted.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -642,9 +601,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the latest state of a long-running operation. Clients can use this
|
# Gets the latest state of a long-running operation. Clients can use this method
|
||||||
# method to poll the operation result at intervals as recommended by the API
|
# to poll the operation result at intervals as recommended by the API service.
|
||||||
# service.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource.
|
# The name of the operation resource.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -674,15 +632,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists operations that match the specified filter in the request. If the
|
# Lists operations that match the specified filter in the request. If the server
|
||||||
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
||||||
# NOTE: the `name` binding allows API services to override the binding
|
# binding allows API services to override the binding to use different resource
|
||||||
# to use different resource name schemes, such as `users/*/operations`. To
|
# name schemes, such as `users/*/operations`. To override the binding, API
|
||||||
# override the binding, API services can add a binding such as
|
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
||||||
# `"/v1/`name=users/*`/operations"` to their service configuration.
|
# service configuration. For backwards compatibility, the default name includes
|
||||||
# For backwards compatibility, the default name includes the operations
|
# the operations collection id, however overriding users must ensure the name
|
||||||
# collection id, however overriding users must ensure the name binding
|
# binding is the parent resource, without the operations collection id.
|
||||||
# is the parent resource, without the operations collection id.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation's parent resource.
|
# The name of the operation's parent resource.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
|
|
@ -723,8 +680,8 @@ module Google
|
||||||
|
|
||||||
# Creates a source.
|
# Creates a source.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Resource name of the new source's parent. Its format should be
|
# Required. Resource name of the new source's parent. Its format should be "
|
||||||
# "organizations/[organization_id]".
|
# organizations/[organization_id]".
|
||||||
# @param [Google::Apis::SecuritycenterV1p1beta1::Source] source_object
|
# @param [Google::Apis::SecuritycenterV1p1beta1::Source] source_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -757,8 +714,8 @@ module Google
|
||||||
|
|
||||||
# Gets a source.
|
# Gets a source.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. Relative resource name of the source. Its format is
|
# Required. Relative resource name of the source. Its format is "organizations/[
|
||||||
# "organizations/[organization_id]/source/[source_id]".
|
# organization_id]/source/[source_id]".
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -788,8 +745,8 @@ module Google
|
||||||
|
|
||||||
# Gets the access control policy on the specified Source.
|
# Gets the access control policy on the specified Source.
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy is being requested.
|
# REQUIRED: The resource for which the policy is being requested. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Google::Apis::SecuritycenterV1p1beta1::GetIamPolicyRequest] get_iam_policy_request_object
|
# @param [Google::Apis::SecuritycenterV1p1beta1::GetIamPolicyRequest] get_iam_policy_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -825,12 +782,12 @@ module Google
|
||||||
# Required. Resource name of the parent of sources to list. Its format should be
|
# Required. Resource name of the parent of sources to list. Its format should be
|
||||||
# "organizations/[organization_id]".
|
# "organizations/[organization_id]".
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of results to return in a single response. Default is
|
# The maximum number of results to return in a single response. Default is 10,
|
||||||
# 10, minimum is 1, maximum is 1000.
|
# minimum is 1, maximum is 1000.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The value returned by the last `ListSourcesResponse`; indicates
|
# The value returned by the last `ListSourcesResponse`; indicates that this is a
|
||||||
# that this is a continuation of a prior `ListSources` call, and
|
# continuation of a prior `ListSources` call, and that the system should return
|
||||||
# that the system should return the next page of data.
|
# the next page of data.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -862,14 +819,13 @@ module Google
|
||||||
|
|
||||||
# Updates a source.
|
# Updates a source.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of this source. See:
|
# The relative resource name of this source. See: https://cloud.google.com/apis/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# design/resource_names#relative_resource_name Example: "organizations/`
|
||||||
# Example:
|
# organization_id`/sources/`source_id`"
|
||||||
# "organizations/`organization_id`/sources/`source_id`"
|
|
||||||
# @param [Google::Apis::SecuritycenterV1p1beta1::Source] source_object
|
# @param [Google::Apis::SecuritycenterV1p1beta1::Source] source_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# The FieldMask to use when updating the source resource.
|
# The FieldMask to use when updating the source resource. If empty all mutable
|
||||||
# If empty all mutable fields will be updated.
|
# fields will be updated.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -902,8 +858,8 @@ module Google
|
||||||
|
|
||||||
# Sets the access control policy on the specified Source.
|
# Sets the access control policy on the specified Source.
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy is being specified.
|
# REQUIRED: The resource for which the policy is being specified. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Google::Apis::SecuritycenterV1p1beta1::SetIamPolicyRequest] set_iam_policy_request_object
|
# @param [Google::Apis::SecuritycenterV1p1beta1::SetIamPolicyRequest] set_iam_policy_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -936,8 +892,8 @@ module Google
|
||||||
|
|
||||||
# Returns the permissions that a caller has on the specified source.
|
# Returns the permissions that a caller has on the specified source.
|
||||||
# @param [String] resource
|
# @param [String] resource
|
||||||
# REQUIRED: The resource for which the policy detail is being requested.
|
# REQUIRED: The resource for which the policy detail is being requested. See the
|
||||||
# See the operation documentation for the appropriate value for this field.
|
# operation documentation for the appropriate value for this field.
|
||||||
# @param [Google::Apis::SecuritycenterV1p1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
# @param [Google::Apis::SecuritycenterV1p1beta1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -968,11 +924,11 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Creates a finding. The corresponding source must exist for finding
|
# Creates a finding. The corresponding source must exist for finding creation
|
||||||
# creation to succeed.
|
# to succeed.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Resource name of the new finding's parent. Its format should be
|
# Required. Resource name of the new finding's parent. Its format should be "
|
||||||
# "organizations/[organization_id]/sources/[source_id]".
|
# organizations/[organization_id]/sources/[source_id]".
|
||||||
# @param [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] google_cloud_securitycenter_v1p1beta1_finding_object
|
# @param [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] google_cloud_securitycenter_v1p1beta1_finding_object
|
||||||
# @param [String] finding_id
|
# @param [String] finding_id
|
||||||
# Required. Unique identifier provided by the client within the parent scope.
|
# Required. Unique identifier provided by the client within the parent scope.
|
||||||
|
|
@ -1006,15 +962,13 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Filters an organization or source's findings and groups them by their
|
# Filters an organization or source's findings and groups them by their
|
||||||
# specified properties.
|
# specified properties. To group across all sources provide a `-` as the source
|
||||||
# To group across all sources provide a `-` as the source id.
|
# id. Example: /v1p1beta1/organizations/`organization_id`/sources/-/findings
|
||||||
# Example: /v1p1beta1/organizations/`organization_id`/sources/-/findings
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the source to groupBy. Its format is
|
# Required. Name of the source to groupBy. Its format is "organizations/[
|
||||||
# "organizations/[organization_id]/sources/[source_id]". To groupBy across
|
# organization_id]/sources/[source_id]". To groupBy across all sources provide a
|
||||||
# all sources provide a source_id of `-`. For example:
|
# source_id of `-`. For example: organizations/`organization_id`/sources/-
|
||||||
# organizations/`organization_id`/sources/-
|
|
||||||
# @param [Google::Apis::SecuritycenterV1p1beta1::GroupFindingsRequest] group_findings_request_object
|
# @param [Google::Apis::SecuritycenterV1p1beta1::GroupFindingsRequest] group_findings_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -1045,111 +999,80 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists an organization or source's findings.
|
# Lists an organization or source's findings. To list across all sources provide
|
||||||
# To list across all sources provide a `-` as the source id.
|
# a `-` as the source id. Example: /v1p1beta1/organizations/`organization_id`/
|
||||||
# Example: /v1p1beta1/organizations/`organization_id`/sources/-/findings
|
# sources/-/findings
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Required. Name of the source the findings belong to. Its format is
|
# Required. Name of the source the findings belong to. Its format is "
|
||||||
# "organizations/[organization_id]/sources/[source_id]". To list across all
|
# organizations/[organization_id]/sources/[source_id]". To list across all
|
||||||
# sources provide a source_id of `-`. For example:
|
# sources provide a source_id of `-`. For example: organizations/`
|
||||||
# organizations/`organization_id`/sources/-
|
# organization_id`/sources/-
|
||||||
# @param [String] compare_duration
|
# @param [String] compare_duration
|
||||||
# When compare_duration is set, the ListFindingsResult's "state_change"
|
# When compare_duration is set, the ListFindingsResult's "state_change"
|
||||||
# attribute is updated to indicate whether the finding had its state changed,
|
# 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
|
# 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
|
# state during the compare_duration period of time that precedes the read_time.
|
||||||
# read_time. This is the time between (read_time - compare_duration) and
|
# This is the time between (read_time - compare_duration) and read_time. The
|
||||||
# read_time.
|
# state_change value is derived based on the presence and state of the finding
|
||||||
# The state_change value is derived based on the presence and state of the
|
# at the two points in time. Intermediate state changes between the two times
|
||||||
# finding at the two points in time. Intermediate state changes between the
|
# don't affect the result. For example, the results aren't affected if the
|
||||||
# two times don't affect the result. For example, the results aren't affected
|
# finding is made inactive and then active again. Possible "state_change" values
|
||||||
# if the finding is made inactive and then active again.
|
# when compare_duration is specified: * "CHANGED": indicates that the finding
|
||||||
# Possible "state_change" values when compare_duration is specified:
|
# was present and matched the given filter at the start of compare_duration, but
|
||||||
# * "CHANGED": indicates that the finding was present and matched the given
|
# changed its state at read_time. * "UNCHANGED": indicates that the finding was
|
||||||
# filter at the start of compare_duration, but changed its
|
# present and matched the given filter at the start of compare_duration and did
|
||||||
# state at read_time.
|
# not change state at read_time. * "ADDED": indicates that the finding did not
|
||||||
# * "UNCHANGED": indicates that the finding was present and matched the given
|
# match the given filter or was not present at the start of compare_duration,
|
||||||
# filter at the start of compare_duration and did not change
|
# but was present at read_time. * "REMOVED": indicates that the finding was
|
||||||
# state at read_time.
|
# present and matched the filter at the start of compare_duration, but did not
|
||||||
# * "ADDED": indicates that the finding did not match the given filter or
|
# match the filter at read_time. If compare_duration is not specified, then the
|
||||||
# was not present at the start of compare_duration, but was
|
# only possible state_change is "UNUSED", which will be the state_change set for
|
||||||
# present at read_time.
|
# all findings 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
|
# @param [String] field_mask
|
||||||
# A field mask to specify the Finding fields to be listed in the response.
|
# A field mask to specify the Finding fields to be listed in the response. An
|
||||||
# An empty field mask will list all fields.
|
# empty field mask will list all fields.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# Expression that defines the filter to apply across findings.
|
# Expression that defines the filter to apply across findings. The expression is
|
||||||
# The expression is a list of one or more restrictions combined via logical
|
# a list of one or more restrictions combined via logical operators `AND` and `
|
||||||
# operators `AND` and `OR`.
|
# OR`. Parentheses are supported, and `OR` has higher precedence than `AND`.
|
||||||
# Parentheses are supported, and `OR` has higher precedence than `AND`.
|
# Restrictions have the form ` ` and may have a `-` character in front of them
|
||||||
# Restrictions have the form `<field> <operator> <value>` and may have a `-`
|
# to indicate negation. Examples include: * name * source_properties.a_property *
|
||||||
# character in front of them to indicate negation. Examples include:
|
# security_marks.marks.marka The supported operators are: * `=` for all value
|
||||||
# * name
|
# types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring
|
||||||
# * source_properties.a_property
|
# matching, for strings. The supported value types are: * string literals in
|
||||||
# * security_marks.marks.marka
|
# quotes. * integer literals without quotes. * boolean literals `true` and `
|
||||||
# The supported operators are:
|
# false` without quotes. The following field and operator combinations are
|
||||||
# * `=` for all value types.
|
# supported: name: `=` parent: `=`, `:` resource_name: `=`, `:` state: `=`, `:`
|
||||||
# * `>`, `<`, `>=`, `<=` for integer values.
|
# category: `=`, `:` external_uri: `=`, `:` event_time: `=`, `>`, `<`, `>=`, `<=`
|
||||||
# * `:`, meaning substring matching, for strings.
|
# Usage: This should be milliseconds since epoch or an RFC3339 string. Examples:
|
||||||
# The supported value types are:
|
# `event_time = "2019-06-10T16:07:18-07:00"` `event_time = 1560208038000`
|
||||||
# * string literals in quotes.
|
# security_marks.marks: `=`, `:` source_properties: `=`, `:`, `>`, `<`, `>=`, `<=
|
||||||
# * integer literals without quotes.
|
# ` For example, `source_properties.size = 100` is a valid filter string. Use a
|
||||||
# * boolean literals `true` and `false` without quotes.
|
# partial match on the empty string to filter based on a property existing: `
|
||||||
# The following field and operator combinations are supported:
|
# source_properties.my_property : ""` Use a negated partial match on the empty
|
||||||
# name: `=`
|
# string to filter based on a property not existing: `-source_properties.
|
||||||
# parent: `=`, `:`
|
# my_property : ""`
|
||||||
# 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
|
# @param [String] order_by
|
||||||
# Expression that defines what fields and order to use for sorting. The
|
# Expression that defines what fields and order to use for sorting. The string
|
||||||
# string value should follow SQL syntax: comma separated list of fields. For
|
# value should follow SQL syntax: comma separated list of fields. For example: "
|
||||||
# example: "name,resource_properties.a_property". The default sorting order
|
# name,resource_properties.a_property". The default sorting order is ascending.
|
||||||
# is ascending. To specify descending order for a field, a suffix " desc"
|
# To specify descending order for a field, a suffix " desc" should be appended
|
||||||
# should be appended to the field name. For example: "name
|
# to the field name. For example: "name desc,source_properties.a_property".
|
||||||
# desc,source_properties.a_property". Redundant space characters in the
|
# Redundant space characters in the syntax are insignificant. "name desc,
|
||||||
# syntax are insignificant. "name desc,source_properties.a_property" and "
|
# source_properties.a_property" and " name desc , source_properties.a_property "
|
||||||
# name desc , source_properties.a_property " are equivalent.
|
# are equivalent. The following fields are supported: name parent state category
|
||||||
# The following fields are supported:
|
# resource_name event_time source_properties security_marks.marks
|
||||||
# name
|
|
||||||
# parent
|
|
||||||
# state
|
|
||||||
# category
|
|
||||||
# resource_name
|
|
||||||
# event_time
|
|
||||||
# source_properties
|
|
||||||
# security_marks.marks
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of results to return in a single response. Default is
|
# The maximum number of results to return in a single response. Default is 10,
|
||||||
# 10, minimum is 1, maximum is 1000.
|
# minimum is 1, maximum is 1000.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The value returned by the last `ListFindingsResponse`; indicates
|
# The value returned by the last `ListFindingsResponse`; indicates that this is
|
||||||
# that this is a continuation of a prior `ListFindings` call, and
|
# a continuation of a prior `ListFindings` call, and that the system should
|
||||||
# that the system should return the next page of data.
|
# return the next page of data.
|
||||||
# @param [String] read_time
|
# @param [String] read_time
|
||||||
# Time used as a reference point when filtering findings. The filter is
|
# Time used as a reference point when filtering findings. The filter is limited
|
||||||
# limited to findings existing at the supplied time and their values are
|
# to findings existing at the supplied time and their values are those at that
|
||||||
# those at that specific time. Absence of this field will default to the
|
# specific time. Absence of this field will default to the API's version of NOW.
|
||||||
# API's version of NOW.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1187,18 +1110,16 @@ module Google
|
||||||
# Creates or updates a finding. The corresponding source must exist for a
|
# Creates or updates a finding. The corresponding source must exist for a
|
||||||
# finding creation to succeed.
|
# finding creation to succeed.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of this finding. See:
|
# The relative resource name of this finding. See: https://cloud.google.com/apis/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# design/resource_names#relative_resource_name Example: "organizations/`
|
||||||
# Example:
|
# organization_id`/sources/`source_id`/findings/`finding_id`"
|
||||||
# "organizations/`organization_id`/sources/`source_id`/findings/`finding_id`"
|
|
||||||
# @param [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] google_cloud_securitycenter_v1p1beta1_finding_object
|
# @param [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1Finding] google_cloud_securitycenter_v1p1beta1_finding_object
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# The FieldMask to use when updating the finding resource. This field should
|
# The FieldMask to use when updating the finding resource. This field should not
|
||||||
# not be specified when creating a finding.
|
# be specified when creating a finding. When updating a finding, an empty mask
|
||||||
# When updating a finding, an empty mask is treated as updating all mutable
|
# is treated as updating all mutable fields and replacing source_properties.
|
||||||
# fields and replacing source_properties. Individual source_properties can
|
# Individual source_properties can be added/updated by using "source_properties."
|
||||||
# be added/updated by using "source_properties.<property key>" in the field
|
# in the field mask.
|
||||||
# mask.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -1231,10 +1152,9 @@ module Google
|
||||||
|
|
||||||
# Updates the state of a finding.
|
# Updates the state of a finding.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Required. The relative resource name of the finding. See:
|
# Required. The relative resource name of the finding. See: https://cloud.google.
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# com/apis/design/resource_names#relative_resource_name Example: "organizations/`
|
||||||
# Example:
|
# organization_id`/sources/`source_id`/finding/`finding_id`".
|
||||||
# "organizations/`organization_id`/sources/`source_id`/finding/`finding_id`".
|
|
||||||
# @param [Google::Apis::SecuritycenterV1p1beta1::SetFindingStateRequest] set_finding_state_request_object
|
# @param [Google::Apis::SecuritycenterV1p1beta1::SetFindingStateRequest] set_finding_state_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -1267,22 +1187,19 @@ module Google
|
||||||
|
|
||||||
# Updates security marks.
|
# Updates security marks.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The relative resource name of the SecurityMarks. See:
|
# The relative resource name of the SecurityMarks. See: https://cloud.google.com/
|
||||||
# https://cloud.google.com/apis/design/resource_names#relative_resource_name
|
# apis/design/resource_names#relative_resource_name Examples: "organizations/`
|
||||||
# Examples:
|
# organization_id`/assets/`asset_id`/securityMarks" "organizations/`
|
||||||
# "organizations/`organization_id`/assets/`asset_id`/securityMarks"
|
# organization_id`/sources/`source_id`/findings/`finding_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 [Google::Apis::SecuritycenterV1p1beta1::GoogleCloudSecuritycenterV1p1beta1SecurityMarks] google_cloud_securitycenter_v1p1beta1_security_marks_object
|
||||||
# @param [String] start_time
|
# @param [String] start_time
|
||||||
# The time at which the updated SecurityMarks take effect.
|
# The time at which the updated SecurityMarks take effect. If not set uses
|
||||||
# If not set uses current server time. Updates will be applied to the
|
# current server time. Updates will be applied to the SecurityMarks that are
|
||||||
# SecurityMarks that are active immediately preceding this time.
|
# active immediately preceding this time.
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# The FieldMask to use when updating the security marks resource.
|
# The FieldMask to use when updating the security marks resource. The field mask
|
||||||
# The field mask must not contain duplicate fields.
|
# must not contain duplicate fields. If empty or set to "marks", all marks will
|
||||||
# If empty or set to "marks", all marks will be replaced. Individual
|
# be replaced. Individual marks can be updated using "marks.".
|
||||||
# marks can be updated using "marks.<mark_key>".
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ module Google
|
||||||
# @see https://cloud.google.com/service-consumer-management/docs/overview
|
# @see https://cloud.google.com/service-consumer-management/docs/overview
|
||||||
module ServiceconsumermanagementV1
|
module ServiceconsumermanagementV1
|
||||||
VERSION = 'V1'
|
VERSION = 'V1'
|
||||||
REVISION = '20200722'
|
REVISION = '20200801'
|
||||||
|
|
||||||
# View and manage your data across Google Cloud Platform services
|
# View and manage your data across Google Cloud Platform services
|
||||||
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -47,15 +47,13 @@ module Google
|
||||||
@batch_path = 'batch'
|
@batch_path = 'batch'
|
||||||
end
|
end
|
||||||
|
|
||||||
# Starts asynchronous cancellation on a long-running operation. The server
|
# Starts asynchronous cancellation on a long-running operation. The server makes
|
||||||
# makes a best effort to cancel the operation, but success is not
|
# a best effort to cancel the operation, but success is not guaranteed. If the
|
||||||
# guaranteed. If the server doesn't support this method, it returns
|
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
# Clients can use Operations.GetOperation or other methods to check whether the
|
||||||
# Operations.GetOperation or
|
# cancellation succeeded or whether the operation completed despite cancellation.
|
||||||
# other methods to check whether the cancellation succeeded or whether the
|
# On successful cancellation, the operation is not deleted; instead, it becomes
|
||||||
# operation completed despite cancellation. On successful cancellation,
|
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
||||||
# 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`.
|
# corresponding to `Code.CANCELLED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be cancelled.
|
# The name of the operation resource to be cancelled.
|
||||||
|
|
@ -89,10 +87,10 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Deletes a long-running operation. This method indicates that the client is
|
# Deletes a long-running operation. This method indicates that the client is no
|
||||||
# no longer interested in the operation result. It does not cancel the
|
# longer interested in the operation result. It does not cancel the operation.
|
||||||
# operation. If the server doesn't support this method, it returns
|
# If the server doesn't support this method, it returns `google.rpc.Code.
|
||||||
# `google.rpc.Code.UNIMPLEMENTED`.
|
# UNIMPLEMENTED`.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource to be deleted.
|
# The name of the operation resource to be deleted.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -122,9 +120,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the latest state of a long-running operation. Clients can use this
|
# Gets the latest state of a long-running operation. Clients can use this method
|
||||||
# method to poll the operation result at intervals as recommended by the API
|
# to poll the operation result at intervals as recommended by the API service.
|
||||||
# service.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource.
|
# The name of the operation resource.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -154,15 +151,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Lists operations that match the specified filter in the request. If the
|
# Lists operations that match the specified filter in the request. If the server
|
||||||
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
# doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
|
||||||
# NOTE: the `name` binding allows API services to override the binding
|
# binding allows API services to override the binding to use different resource
|
||||||
# to use different resource name schemes, such as `users/*/operations`. To
|
# name schemes, such as `users/*/operations`. To override the binding, API
|
||||||
# override the binding, API services can add a binding such as
|
# services can add a binding such as `"/v1/`name=users/*`/operations"` to their
|
||||||
# `"/v1/`name=users/*`/operations"` to their service configuration.
|
# service configuration. For backwards compatibility, the default name includes
|
||||||
# For backwards compatibility, the default name includes the operations
|
# the operations collection id, however overriding users must ensure the name
|
||||||
# collection id, however overriding users must ensure the name binding
|
# binding is the parent resource, without the operations collection id.
|
||||||
# is the parent resource, without the operations collection id.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation's parent resource.
|
# The name of the operation's parent resource.
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
|
|
@ -203,33 +199,28 @@ module Google
|
||||||
|
|
||||||
# Search tenancy units for a managed service.
|
# Search tenancy units for a managed service.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Service for which search is performed.
|
# Service for which search is performed. services/`service` `service` the name
|
||||||
# services/`service`
|
# of a service, for example 'service.googleapis.com'.
|
||||||
# `service` the name of a service, for example 'service.googleapis.com'.
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# Optional. The maximum number of results returned by this request. Currently,
|
# Optional. The maximum number of results returned by this request. Currently,
|
||||||
# the
|
# the default maximum is set to 1000. If `page_size` isn't provided or the size
|
||||||
# default maximum is set to 1000. If `page_size` isn't provided or the size
|
|
||||||
# provided is a number larger than 1000, it's automatically set to 1000.
|
# provided is a number larger than 1000, it's automatically set to 1000.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# Optional. The continuation token, which is used to page through large result
|
# Optional. The continuation token, which is used to page through large result
|
||||||
# sets.
|
# sets. To get the next page of results, set this parameter to the value of `
|
||||||
# To get the next page of results, set this parameter to the value of
|
# nextPageToken` from the previous response.
|
||||||
# `nextPageToken` from the previous response.
|
|
||||||
# @param [String] query
|
# @param [String] query
|
||||||
# Optional. Set a query ``expression`` for querying tenancy units. Your ``
|
# Optional. Set a query ``expression`` for querying tenancy units. Your ``
|
||||||
# expression``
|
# expression`` must be in the format: `field_name=literal_string`. The `
|
||||||
# must be in the format: `field_name=literal_string`. The `field_name` is the
|
# field_name` is the name of the field you want to compare. Supported fields are
|
||||||
# name of the field you want to compare. Supported fields are
|
# `tenant_resources.tag` and `tenant_resources.resource`. For example, to search
|
||||||
# `tenant_resources.tag` and `tenant_resources.resource`.
|
# tenancy units that contain at least one tenant resource with a given tag 'xyz',
|
||||||
# For example, to search tenancy units that contain at least one tenant
|
# use the query `tenant_resources.tag=xyz`. To search tenancy units that
|
||||||
# resource with a given tag 'xyz', use the query `tenant_resources.tag=xyz`.
|
# contain at least one tenant resource with a given resource name 'projects/
|
||||||
# To search tenancy units that contain at least one tenant resource with
|
# 123456', use the query `tenant_resources.resource=projects/123456`. Multiple
|
||||||
# a given resource name 'projects/123456', use the query
|
# expressions can be joined with `AND`s. Tenancy units must match all
|
||||||
# `tenant_resources.resource=projects/123456`.
|
# expressions to be included in the result set. For example, `tenant_resources.
|
||||||
# Multiple expressions can be joined with `AND`s. Tenancy units must match
|
# tag=xyz AND tenant_resources.resource=projects/123456`
|
||||||
# all expressions to be included in the result set. For example,
|
|
||||||
# `tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456`
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -260,15 +251,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Add a new tenant project to the tenancy unit.
|
# Add a new tenant project to the tenancy unit. There can be a maximum of 512
|
||||||
# There can be a maximum of 512 tenant projects in a tenancy unit.
|
# tenant projects in a tenancy unit. If there are previously failed `
|
||||||
# If there are previously failed `AddTenantProject` calls, you might need to
|
# AddTenantProject` calls, you might need to call `RemoveTenantProject` first to
|
||||||
# call `RemoveTenantProject` first to resolve them before you can make
|
# resolve them before you can make another call to `AddTenantProject` with the
|
||||||
# another call to `AddTenantProject` with the same tag.
|
# same tag. Operation.
|
||||||
# Operation<response: Empty>.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Name of the tenancy unit.
|
# Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/
|
||||||
# Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'.
|
# 12345/tenancyUnits/abcd'.
|
||||||
# @param [Google::Apis::ServiceconsumermanagementV1::AddTenantProjectRequest] add_tenant_project_request_object
|
# @param [Google::Apis::ServiceconsumermanagementV1::AddTenantProjectRequest] add_tenant_project_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -299,26 +289,22 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Apply a configuration to an existing tenant project.
|
# Apply a configuration to an existing tenant project. This project must exist
|
||||||
# This project must exist in an active state and have the original owner
|
# in an active state and have the original owner account. The caller must have
|
||||||
# account. The caller must have permission to add a project to the given
|
# permission to add a project to the given tenancy unit. The configuration is
|
||||||
# tenancy unit. The configuration is applied, but any existing settings on
|
# applied, but any existing settings on the project aren't modified. Specified
|
||||||
# the project aren't modified.
|
# policy bindings are applied. Existing bindings aren't modified. Specified
|
||||||
# Specified policy bindings are applied. Existing bindings aren't modified.
|
# services are activated. No service is deactivated. If specified, new billing
|
||||||
# Specified services are activated. No service is deactivated.
|
# configuration is applied. Omit a billing configuration to keep the existing
|
||||||
# If specified, new billing configuration is applied.
|
# one. A service account in the project is created if previously non existed.
|
||||||
# Omit a billing configuration to keep the existing one.
|
|
||||||
# A service account in the project is created if previously non existed.
|
|
||||||
# Specified labels will be appended to tenant project, note that the value of
|
# Specified labels will be appended to tenant project, note that the value of
|
||||||
# existing label key will be updated if the same label key is requested.
|
# existing label key will be updated if the same label key is requested. The
|
||||||
# The specified folder is ignored, as moving a tenant project to a different
|
# specified folder is ignored, as moving a tenant project to a different folder
|
||||||
# folder isn't supported.
|
# isn't supported. The operation fails if any of the steps fail, but no rollback
|
||||||
# The operation fails if any of the steps fail, but no rollback of already
|
# of already applied configuration changes is attempted. Operation.
|
||||||
# applied configuration changes is attempted.
|
|
||||||
# Operation<response: Empty>.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Name of the tenancy unit.
|
# Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/
|
||||||
# Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'.
|
# 12345/tenancyUnits/abcd'.
|
||||||
# @param [Google::Apis::ServiceconsumermanagementV1::ApplyTenantProjectConfigRequest] apply_tenant_project_config_request_object
|
# @param [Google::Apis::ServiceconsumermanagementV1::ApplyTenantProjectConfigRequest] apply_tenant_project_config_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -349,20 +335,18 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Attach an existing project to the tenancy unit as a new tenant
|
# Attach an existing project to the tenancy unit as a new tenant resource. The
|
||||||
# resource. The project could either be the tenant project reserved by
|
# project could either be the tenant project reserved by calling `
|
||||||
# calling `AddTenantProject` under a tenancy unit of a service producer's
|
# AddTenantProject` under a tenancy unit of a service producer's project of a
|
||||||
# project of a managed service, or from a separate project.
|
# managed service, or from a separate project. The caller is checked against a
|
||||||
# The caller is checked against a set of permissions as if calling
|
# set of permissions as if calling `AddTenantProject` on the same service
|
||||||
# `AddTenantProject` on the same service consumer.
|
# consumer. To trigger the attachment, the targeted tenant project must be in a
|
||||||
# To trigger the attachment, the targeted tenant project must be in a
|
# folder. Make sure the ServiceConsumerManagement service account is the owner
|
||||||
# folder. Make sure the ServiceConsumerManagement service account is
|
# of that project. These two requirements are already met if the project is
|
||||||
# the owner of that project. These two requirements are already met
|
# reserved by calling `AddTenantProject`. Operation.
|
||||||
# if the project is reserved by calling `AddTenantProject`.
|
|
||||||
# Operation<response: Empty>.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Name of the tenancy unit that the project will be attached to.
|
# Name of the tenancy unit that the project will be attached to. Such as '
|
||||||
# Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'.
|
# services/service.googleapis.com/projects/12345/tenancyUnits/abcd'.
|
||||||
# @param [Google::Apis::ServiceconsumermanagementV1::AttachTenantProjectRequest] attach_tenant_project_request_object
|
# @param [Google::Apis::ServiceconsumermanagementV1::AttachTenantProjectRequest] attach_tenant_project_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -393,18 +377,16 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Creates a tenancy unit with no tenant resources.
|
# Creates a tenancy unit with no tenant resources. If tenancy unit already
|
||||||
# If tenancy unit already exists, it will be returned,
|
# exists, it will be returned, however, in this case, returned TenancyUnit does
|
||||||
# however, in this case, returned TenancyUnit does not have tenant_resources
|
# not have tenant_resources field set and ListTenancyUnits has to be used to get
|
||||||
# field set and ListTenancyUnits has to be used to get a complete
|
# a complete TenancyUnit with all fields populated.
|
||||||
# TenancyUnit with all fields populated.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# services/`service`/`collection id`/`resource id`
|
# services/`service`/`collection id`/`resource id` `collection id` is the cloud
|
||||||
# `collection id` is the cloud resource collection type representing the
|
# resource collection type representing the service consumer, for example '
|
||||||
# service consumer, for example 'projects', or 'organizations'.
|
# projects', or 'organizations'. `resource id` is the consumer numeric id, such
|
||||||
# `resource id` is the consumer numeric id, such as project number: '123456'.
|
# as project number: '123456'. `service` the name of a managed service, such as '
|
||||||
# `service` the name of a managed service, such as 'service.googleapis.com'.
|
# service.googleapis.com'. Enables service binding using the new tenancy unit.
|
||||||
# Enables service binding using the new tenancy unit.
|
|
||||||
# @param [Google::Apis::ServiceconsumermanagementV1::CreateTenancyUnitRequest] create_tenancy_unit_request_object
|
# @param [Google::Apis::ServiceconsumermanagementV1::CreateTenancyUnitRequest] create_tenancy_unit_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -435,9 +417,8 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Delete a tenancy unit. Before you delete the tenancy unit, there should be
|
# Delete a tenancy unit. Before you delete the tenancy unit, there should be no
|
||||||
# no tenant resources in it that aren't in a DELETED state.
|
# tenant resources in it that aren't in a DELETED state. Operation.
|
||||||
# Operation<response: Empty>.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Name of the tenancy unit to be deleted.
|
# Name of the tenancy unit to be deleted.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -470,16 +451,13 @@ module Google
|
||||||
# Deletes the specified project resource identified by a tenant resource tag.
|
# Deletes the specified project resource identified by a tenant resource tag.
|
||||||
# The mothod removes a project lien with a 'TenantManager' origin if that was
|
# The mothod removes a project lien with a 'TenantManager' origin if that was
|
||||||
# added. It will then attempt to delete the project. If that operation fails,
|
# added. It will then attempt to delete the project. If that operation fails,
|
||||||
# this method also fails.
|
# this method also fails. After the project has been deleted, the tenant
|
||||||
# After the project has been deleted, the tenant resource state is set to
|
# resource state is set to DELETED. To permanently remove resource metadata,
|
||||||
# DELETED. To permanently remove resource metadata, call the
|
# call the `RemoveTenantProject` method. New resources with the same tag can't
|
||||||
# `RemoveTenantProject` method.
|
# be added if there are existing resources in a DELETED state. Operation.
|
||||||
# New resources with the same tag can't be added if there are existing
|
|
||||||
# resources in a DELETED state.
|
|
||||||
# Operation<response: Empty>.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Name of the tenancy unit.
|
# Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/
|
||||||
# Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'.
|
# 12345/tenancyUnits/abcd'.
|
||||||
# @param [Google::Apis::ServiceconsumermanagementV1::DeleteTenantProjectRequest] delete_tenant_project_request_object
|
# @param [Google::Apis::ServiceconsumermanagementV1::DeleteTenantProjectRequest] delete_tenant_project_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -510,26 +488,24 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Find the tenancy unit for a managed service and service consumer.
|
# Find the tenancy unit for a managed service and service consumer. This method
|
||||||
# This method shouldn't be used in a service producer's runtime path, for
|
# shouldn't be used in a service producer's runtime path, for example to find
|
||||||
# example to find the tenant project number when creating VMs. Service
|
# the tenant project number when creating VMs. Service producers must persist
|
||||||
# producers must persist the tenant project's information after the project
|
# the tenant project's information after the project is created.
|
||||||
# is created.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Managed service and service consumer. Required.
|
# Managed service and service consumer. Required. services/`service`/`collection
|
||||||
# services/`service`/`collection id`/`resource id`
|
# id`/`resource id` `collection id` is the cloud resource collection type
|
||||||
# `collection id` is the cloud resource collection type representing the
|
# representing the service consumer, for example 'projects', or 'organizations'.
|
||||||
# service consumer, for example 'projects', or 'organizations'.
|
# `resource id` is the consumer numeric id, such as project number: '123456'. `
|
||||||
# `resource id` is the consumer numeric id, such as project number: '123456'.
|
# service` the name of a service, such as 'service.googleapis.com'.
|
||||||
# `service` the name of a service, such as 'service.googleapis.com'.
|
|
||||||
# @param [String] filter
|
# @param [String] filter
|
||||||
# Filter expression over tenancy resources field. Optional.
|
# Filter expression over tenancy resources field. Optional.
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# The maximum number of results returned by this request.
|
# The maximum number of results returned by this request.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# The continuation token, which is used to page through large result sets.
|
# The continuation token, which is used to page through large result sets. To
|
||||||
# To get the next page of results, set this parameter to the value of
|
# get the next page of results, set this parameter to the value of `
|
||||||
# `nextPageToken` from the previous response.
|
# nextPageToken` from the previous response.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -561,16 +537,15 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Removes the specified project resource identified by a tenant resource tag.
|
# Removes the specified project resource identified by a tenant resource tag.
|
||||||
# The method removes the project lien with 'TenantManager' origin if that
|
# The method removes the project lien with 'TenantManager' origin if that was
|
||||||
# was added. It then attempts to delete the project. If that operation
|
# added. It then attempts to delete the project. If that operation fails, this
|
||||||
# fails, this method also fails.
|
# method also fails. Calls to remove already removed or non-existent tenant
|
||||||
# Calls to remove already removed or non-existent tenant project succeed.
|
# project succeed. After the project has been deleted, or if was already in a
|
||||||
# After the project has been deleted, or if was already in a DELETED state,
|
# DELETED state, resource metadata is permanently removed from the tenancy unit.
|
||||||
# resource metadata is permanently removed from the tenancy unit.
|
# Operation.
|
||||||
# Operation<response: Empty>.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Name of the tenancy unit.
|
# Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/
|
||||||
# Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'.
|
# 12345/tenancyUnits/abcd'.
|
||||||
# @param [Google::Apis::ServiceconsumermanagementV1::RemoveTenantProjectRequest] remove_tenant_project_request_object
|
# @param [Google::Apis::ServiceconsumermanagementV1::RemoveTenantProjectRequest] remove_tenant_project_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -601,16 +576,14 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Attempts to undelete a previously deleted tenant project. The project must
|
# Attempts to undelete a previously deleted tenant project. The project must be
|
||||||
# be in a DELETED state.
|
# in a DELETED state. There are no guarantees that an undeleted project will be
|
||||||
# There are no guarantees that an undeleted project will be in
|
# in a fully restored and functional state. Call the `ApplyTenantProjectConfig`
|
||||||
# a fully restored and functional state. Call the `ApplyTenantProjectConfig`
|
|
||||||
# method to update its configuration and then validate all managed service
|
# method to update its configuration and then validate all managed service
|
||||||
# resources.
|
# resources. Operation.
|
||||||
# Operation<response: Empty>.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# Name of the tenancy unit.
|
# Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/
|
||||||
# Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'.
|
# 12345/tenancyUnits/abcd'.
|
||||||
# @param [Google::Apis::ServiceconsumermanagementV1::UndeleteTenantProjectRequest] undelete_tenant_project_request_object
|
# @param [Google::Apis::ServiceconsumermanagementV1::UndeleteTenantProjectRequest] undelete_tenant_project_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
|
||||||
|
|
@ -25,7 +25,7 @@ module Google
|
||||||
# @see https://cloud.google.com/service-consumer-management/docs/overview
|
# @see https://cloud.google.com/service-consumer-management/docs/overview
|
||||||
module ServiceconsumermanagementV1beta1
|
module ServiceconsumermanagementV1beta1
|
||||||
VERSION = 'V1beta1'
|
VERSION = 'V1beta1'
|
||||||
REVISION = '20200721'
|
REVISION = '20200801'
|
||||||
|
|
||||||
# View and manage your data across Google Cloud Platform services
|
# View and manage your data across Google Cloud Platform services
|
||||||
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -47,9 +47,8 @@ module Google
|
||||||
@batch_path = 'batch'
|
@batch_path = 'batch'
|
||||||
end
|
end
|
||||||
|
|
||||||
# Gets the latest state of a long-running operation. Clients can use this
|
# Gets the latest state of a long-running operation. Clients can use this method
|
||||||
# method to poll the operation result at intervals as recommended by the API
|
# to poll the operation result at intervals as recommended by the API service.
|
||||||
# service.
|
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The name of the operation resource.
|
# The name of the operation resource.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -81,11 +80,9 @@ module Google
|
||||||
|
|
||||||
# Retrieves a summary of quota information for a specific quota metric.
|
# Retrieves a summary of quota information for a specific quota metric.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The resource name of the quota metric, returned by a
|
# The resource name of the quota metric, returned by a ListConsumerQuotaMetrics
|
||||||
# ListConsumerQuotaMetrics call.
|
# call. An example name would be: `services/compute.googleapis.com/projects/123/
|
||||||
# An example name would be:
|
# consumerQuotaMetrics/compute.googleapis.com%2Fcpus`
|
||||||
# `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.
|
|
||||||
# googleapis.com%2Fcpus`
|
|
||||||
# @param [String] view
|
# @param [String] view
|
||||||
# Specifies the level of detail for quota information in the response.
|
# Specifies the level of detail for quota information in the response.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -116,13 +113,12 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Create or update multiple producer overrides atomically, all on the
|
# Create or update multiple producer overrides atomically, all on the same
|
||||||
# same consumer, but on many different metrics or limits.
|
# consumer, but on many different metrics or limits. The name field in the quota
|
||||||
# The name field in the quota override message should not be set.
|
# override message should not be set.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# The resource name of the consumer.
|
# The resource name of the consumer. An example name would be: `services/compute.
|
||||||
# An example name would be:
|
# googleapis.com/projects/123`
|
||||||
# `services/compute.googleapis.com/projects/123`
|
|
||||||
# @param [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ImportProducerOverridesRequest] v1_beta1_import_producer_overrides_request_object
|
# @param [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1ImportProducerOverridesRequest] v1_beta1_import_producer_overrides_request_object
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
|
|
@ -154,20 +150,17 @@ module Google
|
||||||
end
|
end
|
||||||
|
|
||||||
# Retrieves a summary of all quota information about this consumer that is
|
# Retrieves a summary of all quota information about this consumer that is
|
||||||
# visible to the service producer, for each quota metric defined by the
|
# visible to the service producer, for each quota metric defined by the service.
|
||||||
# service. Each metric includes information about all of its defined limits.
|
# Each metric includes information about all of its defined limits. Each limit
|
||||||
# Each limit includes the limit configuration (quota unit, preciseness,
|
# includes the limit configuration (quota unit, preciseness, default value), the
|
||||||
# default value), the current effective limit value, and all of the overrides
|
# current effective limit value, and all of the overrides applied to the limit.
|
||||||
# applied to the limit.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# Parent of the quotas resource.
|
# Parent of the quotas resource. An example parent would be: `services/
|
||||||
# An example parent would be:
|
# serviceconsumermanagement.googleapis.com/projects/123`
|
||||||
# `services/serviceconsumermanagement.googleapis.com/projects/123`
|
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# Requested size of the next page of data.
|
# Requested size of the next page of data.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# Token identifying which result to start with; returned by a previous list
|
# Token identifying which result to start with; returned by a previous list call.
|
||||||
# call.
|
|
||||||
# @param [String] view
|
# @param [String] view
|
||||||
# Specifies the level of detail for quota information in the response.
|
# Specifies the level of detail for quota information in the response.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -202,11 +195,10 @@ module Google
|
||||||
|
|
||||||
# Retrieves a summary of quota information for a specific quota limit.
|
# Retrieves a summary of quota information for a specific quota limit.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The resource name of the quota limit, returned by a
|
# The resource name of the quota limit, returned by a ListConsumerQuotaMetrics
|
||||||
# ListConsumerQuotaMetrics or GetConsumerQuotaMetric call.
|
# or GetConsumerQuotaMetric call. An example name would be: `services/compute.
|
||||||
# An example name would be:
|
# googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/
|
||||||
# `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.
|
# limits/%2Fproject%2Fregion`
|
||||||
# googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
|
|
||||||
# @param [String] view
|
# @param [String] view
|
||||||
# Specifies the level of detail for quota information in the response.
|
# Specifies the level of detail for quota information in the response.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
|
|
@ -237,27 +229,25 @@ module Google
|
||||||
execute_or_queue_command(command, &block)
|
execute_or_queue_command(command, &block)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Creates a producer override.
|
# Creates a producer override. A producer override is applied by the owner or
|
||||||
# A producer override is applied by the owner or administrator of a service
|
# administrator of a service to increase or decrease the amount of quota a
|
||||||
# to increase or decrease the amount of quota a consumer of the service is
|
# consumer of the service is allowed to use. To create multiple overrides at
|
||||||
# allowed to use.
|
# once, use ImportProducerOverrides instead. If an override with the specified
|
||||||
# To create multiple overrides at once, use ImportProducerOverrides instead.
|
# dimensions already exists, this call will fail. To overwrite an existing
|
||||||
# If an override with the specified dimensions already exists, this call will
|
# override if one is already present ("upsert" semantics), use
|
||||||
# fail. To overwrite an existing override if one is already present ("upsert"
|
# ImportProducerOverrides instead.
|
||||||
# semantics), use ImportProducerOverrides instead.
|
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# The resource name of the parent quota limit, returned by a
|
# The resource name of the parent quota limit, returned by a
|
||||||
# ListConsumerQuotaMetrics or GetConsumerQuotaMetric call.
|
# ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would
|
||||||
# An example name would be:
|
# be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.
|
||||||
# `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.
|
|
||||||
# googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
|
# googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
|
||||||
# @param [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride] v1_beta1_quota_override_object
|
# @param [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride] v1_beta1_quota_override_object
|
||||||
# @param [Boolean] force
|
# @param [Boolean] force
|
||||||
# Whether to force the creation of the quota override.
|
# Whether to force the creation of the quota override. If creating an override
|
||||||
# If creating an override would cause the effective quota for the consumer to
|
# would cause the effective quota for the consumer to decrease by more than 10
|
||||||
# decrease by more than 10 percent, the call is rejected, as a safety measure
|
# percent, the call is rejected, as a safety measure to avoid accidentally
|
||||||
# to avoid accidentally decreasing quota too quickly. Setting the force
|
# decreasing quota too quickly. Setting the force parameter to true ignores this
|
||||||
# parameter to true ignores this restriction.
|
# restriction.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -290,16 +280,15 @@ module Google
|
||||||
|
|
||||||
# Deletes a producer override.
|
# Deletes a producer override.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The resource name of the override to delete.
|
# The resource name of the override to delete. An example name would be: `
|
||||||
# An example name would be:
|
# services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.
|
||||||
# `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.
|
|
||||||
# googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
|
# googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
|
||||||
# @param [Boolean] force
|
# @param [Boolean] force
|
||||||
# Whether to force the deletion of the quota override.
|
# Whether to force the deletion of the quota override. If deleting an override
|
||||||
# If deleting an override would cause the effective quota for the consumer to
|
# would cause the effective quota for the consumer to decrease by more than 10
|
||||||
# decrease by more than 10 percent, the call is rejected, as a safety measure
|
# percent, the call is rejected, as a safety measure to avoid accidentally
|
||||||
# to avoid accidentally decreasing quota too quickly. Setting the force
|
# decreasing quota too quickly. Setting the force parameter to true ignores this
|
||||||
# parameter to true ignores this restriction.
|
# restriction.
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -331,15 +320,13 @@ module Google
|
||||||
# Lists all producer overrides on this limit.
|
# Lists all producer overrides on this limit.
|
||||||
# @param [String] parent
|
# @param [String] parent
|
||||||
# The resource name of the parent quota limit, returned by a
|
# The resource name of the parent quota limit, returned by a
|
||||||
# ListConsumerQuotaMetrics or GetConsumerQuotaMetric call.
|
# ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. An example name would
|
||||||
# An example name would be:
|
# be: `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.
|
||||||
# `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.
|
|
||||||
# googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
|
# googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
|
||||||
# @param [Fixnum] page_size
|
# @param [Fixnum] page_size
|
||||||
# Requested size of the next page of data.
|
# Requested size of the next page of data.
|
||||||
# @param [String] page_token
|
# @param [String] page_token
|
||||||
# Token identifying which result to start with; returned by a previous list
|
# Token identifying which result to start with; returned by a previous list call.
|
||||||
# call.
|
|
||||||
# @param [String] fields
|
# @param [String] fields
|
||||||
# Selector specifying which fields to include in a partial response.
|
# Selector specifying which fields to include in a partial response.
|
||||||
# @param [String] quota_user
|
# @param [String] quota_user
|
||||||
|
|
@ -371,17 +358,16 @@ module Google
|
||||||
|
|
||||||
# Updates a producer override.
|
# Updates a producer override.
|
||||||
# @param [String] name
|
# @param [String] name
|
||||||
# The resource name of the override to update.
|
# The resource name of the override to update. An example name would be: `
|
||||||
# An example name would be:
|
# services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.
|
||||||
# `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.
|
|
||||||
# googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
|
# googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
|
||||||
# @param [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride] v1_beta1_quota_override_object
|
# @param [Google::Apis::ServiceconsumermanagementV1beta1::V1Beta1QuotaOverride] v1_beta1_quota_override_object
|
||||||
# @param [Boolean] force
|
# @param [Boolean] force
|
||||||
# Whether to force the update of the quota override.
|
# Whether to force the update of the quota override. If updating an override
|
||||||
# If updating an override would cause the effective quota for the consumer to
|
# would cause the effective quota for the consumer to decrease by more than 10
|
||||||
# decrease by more than 10 percent, the call is rejected, as a safety measure
|
# percent, the call is rejected, as a safety measure to avoid accidentally
|
||||||
# to avoid accidentally decreasing quota too quickly. Setting the force
|
# decreasing quota too quickly. Setting the force parameter to true ignores this
|
||||||
# parameter to true ignores this restriction.
|
# restriction.
|
||||||
# @param [String] update_mask
|
# @param [String] update_mask
|
||||||
# Update only the specified fields. If unset, all modifiable fields will be
|
# Update only the specified fields. If unset, all modifiable fields will be
|
||||||
# updated.
|
# updated.
|
||||||
|
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue