Autogenerated update (2019-08-08)

Update:
- androidmanagement_v1
- content_v2
- content_v2_1
- firebase_v1beta1
- healthcare_v1alpha2
- healthcare_v1beta1
- serviceconsumermanagement_v1
- serviceusage_v1
- speech_v1
- speech_v1p1beta1
- websecurityscanner_v1
- websecurityscanner_v1beta
This commit is contained in:
Google APIs 2019-08-08 00:38:23 +00:00
parent d77f2b6534
commit ea20d1fd3f
33 changed files with 2090 additions and 71 deletions

View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/android/management
module AndroidmanagementV1
VERSION = 'V1'
REVISION = '20190801'
REVISION = '20190805'
# Manage Android devices and apps for your customers
AUTH_ANDROIDMANAGEMENT = 'https://www.googleapis.com/auth/androidmanagement'

View File

@ -2990,6 +2990,12 @@ module Google
attr_accessor :software_info_enabled
alias_method :software_info_enabled?, :software_info_enabled
# Whether system properties reporting is enabled.
# Corresponds to the JSON property `systemPropertiesEnabled`
# @return [Boolean]
attr_accessor :system_properties_enabled
alias_method :system_properties_enabled?, :system_properties_enabled
def initialize(**args)
update!(**args)
end
@ -3005,6 +3011,7 @@ module Google
@network_info_enabled = args[:network_info_enabled] if args.key?(:network_info_enabled)
@power_management_events_enabled = args[:power_management_events_enabled] if args.key?(:power_management_events_enabled)
@software_info_enabled = args[:software_info_enabled] if args.key?(:software_info_enabled)
@system_properties_enabled = args[:system_properties_enabled] if args.key?(:system_properties_enabled)
end
end

View File

@ -1073,6 +1073,7 @@ module Google
property :network_info_enabled, as: 'networkInfoEnabled'
property :power_management_events_enabled, as: 'powerManagementEventsEnabled'
property :software_info_enabled, as: 'softwareInfoEnabled'
property :system_properties_enabled, as: 'systemPropertiesEnabled'
end
end

View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/shopping-content
module ContentV2
VERSION = 'V2'
REVISION = '20190705'
REVISION = '20190805'
# Manage your product listings and accounts for Google Shopping
AUTH_CONTENT = 'https://www.googleapis.com/auth/content'

View File

@ -2100,7 +2100,7 @@ module Google
# The list of destinations to include for this target (corresponds to checked
# check boxes in Merchant Center). Default destinations are always included
# unless provided in the excluded_destination field.
# unless provided in excludedDestinations.
# Corresponds to the JSON property `includedDestinations`
# @return [Array<String>]
attr_accessor :included_destinations
@ -5187,6 +5187,9 @@ module Google
# - "gls"
# - "dpd"
# - "bpost"
# - "colis priv<69>"
# - "boxtal"
# - "geodis"
# Corresponds to the JSON property `carrier`
# @return [String]
attr_accessor :carrier
@ -10612,8 +10615,9 @@ module Google
attr_accessor :promotions
# The price of shipping for all items. Shipping tax is automatically calculated
# for MFL orders. For non-MFL orders, tax settings from Merchant Center are
# applied. Note that shipping is not taxed in certain states.
# for orders where marketplace facilitator tax laws are applicable. Otherwise,
# tax settings from Merchant Center are applied. Note that shipping is not taxed
# in certain states.
# Corresponds to the JSON property `shippingCost`
# @return [Google::Apis::ContentV2::Price]
attr_accessor :shipping_cost
@ -10810,8 +10814,9 @@ module Google
# @return [String]
attr_accessor :offer_id
# The price for the product. Tax is automatically calculated for MFL orders. For
# non-MFL orders, tax settings from Merchant Center are applied.
# The price for the product. Tax is automatically calculated for orders where
# marketplace facilitator tax laws are applicable. Otherwise, tax settings from
# Merchant Center are applied.
# Corresponds to the JSON property `price`
# @return [Google::Apis::ContentV2::Price]
attr_accessor :price

View File

@ -2623,8 +2623,9 @@ module Google
execute_or_queue_command(command, &block)
end
# Notifies that item return and refund was handled directly by merchant outside
# of Google payments processing (e.g. cash refund done in store).
# Deprecated. Notifies that item return and refund was handled directly by
# merchant outside of Google payments processing (e.g. cash refund done in store)
# .
# Note: We recommend calling the returnrefundlineitem method to refund in-store
# returns. We will issue the refund directly to the customer. This helps to
# prevent possible differences arising between merchant and Google transaction

View File

@ -26,7 +26,7 @@ module Google
# @see https://developers.google.com/shopping-content
module ContentV2_1
VERSION = 'V2_1'
REVISION = '20190705'
REVISION = '20190805'
# Manage your product listings and accounts for Google Shopping
AUTH_CONTENT = 'https://www.googleapis.com/auth/content'

View File

@ -1908,7 +1908,7 @@ module Google
# The list of destinations to include for this target (corresponds to checked
# check boxes in Merchant Center). Default destinations are always included
# unless provided in the excluded_destination field.
# unless provided in excludedDestinations.
# Corresponds to the JSON property `includedDestinations`
# @return [Array<String>]
attr_accessor :included_destinations
@ -3671,6 +3671,17 @@ module Google
# @return [String]
attr_accessor :full_name
# Email address for receiving merchant issued value-added tax or invoice
# documentation of this order.
# Corresponds to the JSON property `invoiceReceivingEmail`
# @return [String]
attr_accessor :invoice_receiving_email
# Loyalty program information.
# Corresponds to the JSON property `loyaltyInfo`
# @return [Google::Apis::ContentV2_1::OrderCustomerLoyaltyInfo]
attr_accessor :loyalty_info
# Customer's marketing preferences. Contains the marketing opt-in information
# that is current at the time that the merchant call. User preference selections
# can change from one order to the next so preferences must be checked with
@ -3686,10 +3697,37 @@ module Google
# Update properties of this object
def update!(**args)
@full_name = args[:full_name] if args.key?(:full_name)
@invoice_receiving_email = args[:invoice_receiving_email] if args.key?(:invoice_receiving_email)
@loyalty_info = args[:loyalty_info] if args.key?(:loyalty_info)
@marketing_rights_info = args[:marketing_rights_info] if args.key?(:marketing_rights_info)
end
end
#
class OrderCustomerLoyaltyInfo
include Google::Apis::Core::Hashable
# The loyalty card/membership number.
# Corresponds to the JSON property `loyaltyNumber`
# @return [String]
attr_accessor :loyalty_number
# Name of card/membership holder, this field will be populated when
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@loyalty_number = args[:loyalty_number] if args.key?(:loyalty_number)
@name = args[:name] if args.key?(:name)
end
end
#
class OrderCustomerMarketingRightsInfo
include Google::Apis::Core::Hashable
@ -4511,6 +4549,9 @@ module Google
# - "gls"
# - "dpd"
# - "bpost"
# - "colis priv<69>"
# - "boxtal"
# - "geodis"
# Corresponds to the JSON property `carrier`
# @return [String]
attr_accessor :carrier
@ -4536,6 +4577,11 @@ module Google
# @return [Array<Google::Apis::ContentV2_1::OrderShipmentLineItemShipment>]
attr_accessor :line_items
# The shipment group ID of the shipment. This is set in shiplineitems request.
# Corresponds to the JSON property `shipmentGroupId`
# @return [String]
attr_accessor :shipment_group_id
# The status of the shipment.
# Corresponds to the JSON property `status`
# @return [String]
@ -4557,6 +4603,7 @@ module Google
@delivery_date = args[:delivery_date] if args.key?(:delivery_date)
@id = args[:id] if args.key?(:id)
@line_items = args[:line_items] if args.key?(:line_items)
@shipment_group_id = args[:shipment_group_id] if args.key?(:shipment_group_id)
@status = args[:status] if args.key?(:status)
@tracking_id = args[:tracking_id] if args.key?(:tracking_id)
end
@ -6939,7 +6986,7 @@ module Google
# The list of destinations to include for this target (corresponds to checked
# check boxes in Merchant Center). Default destinations are always included
# unless provided in the excluded_destination field.
# unless provided in excludedDestinations.
# Corresponds to the JSON property `includedDestinations`
# @return [Array<String>]
attr_accessor :included_destinations
@ -8813,8 +8860,9 @@ module Google
attr_accessor :promotions
# The price of shipping for all items. Shipping tax is automatically calculated
# for MFL orders. For non-MFL orders, tax settings from Merchant Center are
# applied. Note that shipping is not taxed in certain states.
# for orders where marketplace facilitator tax laws are applicable. Otherwise,
# tax settings from Merchant Center are applied. Note that shipping is not taxed
# in certain states.
# Corresponds to the JSON property `shippingCost`
# @return [Google::Apis::ContentV2_1::Price]
attr_accessor :shipping_cost
@ -8929,8 +8977,9 @@ module Google
# @return [String]
attr_accessor :offer_id
# The price for the product. Tax is automatically calculated for MFL orders. For
# non-MFL orders, tax settings from Merchant Center are applied.
# The price for the product. Tax is automatically calculated for orders where
# marketplace facilitator tax laws are applicable. Otherwise, tax settings from
# Merchant Center are applied.
# Corresponds to the JSON property `price`
# @return [Google::Apis::ContentV2_1::Price]
attr_accessor :price

View File

@ -604,6 +604,12 @@ module Google
include Google::Apis::Core::JsonObjectSupport
end
class OrderCustomerLoyaltyInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class OrderCustomerMarketingRightsInfo
class Representation < Google::Apis::Core::JsonRepresentation; end
@ -2444,11 +2450,22 @@ module Google
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :full_name, as: 'fullName'
property :invoice_receiving_email, as: 'invoiceReceivingEmail'
property :loyalty_info, as: 'loyaltyInfo', class: Google::Apis::ContentV2_1::OrderCustomerLoyaltyInfo, decorator: Google::Apis::ContentV2_1::OrderCustomerLoyaltyInfo::Representation
property :marketing_rights_info, as: 'marketingRightsInfo', class: Google::Apis::ContentV2_1::OrderCustomerMarketingRightsInfo, decorator: Google::Apis::ContentV2_1::OrderCustomerMarketingRightsInfo::Representation
end
end
class OrderCustomerLoyaltyInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :loyalty_number, as: 'loyaltyNumber'
property :name, as: 'name'
end
end
class OrderCustomerMarketingRightsInfo
# @private
class Representation < Google::Apis::Core::JsonRepresentation
@ -2677,6 +2694,7 @@ module Google
property :id, as: 'id'
collection :line_items, as: 'lineItems', class: Google::Apis::ContentV2_1::OrderShipmentLineItemShipment, decorator: Google::Apis::ContentV2_1::OrderShipmentLineItemShipment::Representation
property :shipment_group_id, as: 'shipmentGroupId'
property :status, as: 'status'
property :tracking_id, as: 'trackingId'
end

View File

@ -2112,8 +2112,9 @@ module Google
execute_or_queue_command(command, &block)
end
# Notifies that item return and refund was handled directly by merchant outside
# of Google payments processing (e.g. cash refund done in store).
# Deprecated. Notifies that item return and refund was handled directly by
# merchant outside of Google payments processing (e.g. cash refund done in store)
# .
# Note: We recommend calling the returnrefundlineitem method to refund in-store
# returns. We will issue the refund directly to the customer. This helps to
# prevent possible differences arising between merchant and Google transaction

View File

@ -26,7 +26,7 @@ module Google
# @see https://firebase.google.com
module FirebaseV1beta1
VERSION = 'V1beta1'
REVISION = '20190730'
REVISION = '20190807'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -28,7 +28,7 @@ module Google
# Deprecated. Instead, to set your project's default GCP resource location,
# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)
# after you add Firebase services to your project.
# after you add Firebase resources to your project.
# <br>
# <br>The ID of the project's default GCP resource location. The location
# must be one of the available
@ -38,7 +38,11 @@ module Google
# @return [String]
attr_accessor :location_id
# The region code (CLDR) that the account will use for Firebase Analytics
# Deprecated. Instead, to link your Project with a Google Analytics account,
# call [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics)
# after you add Firebase resources to your Project.
# <br>
# <br>The region code (CLDR) that the account will use for Firebase Analytics
# data.
# <br>For example: US, GB, or DE
# <br>
@ -47,7 +51,11 @@ module Google
# @return [String]
attr_accessor :region_code
# The time zone that the account will use for Firebase Analytics data.
# Deprecated. Instead, to link your Project with a Google Analytics account,
# call [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics)
# after you add Firebase resources to your Project.
# <br>
# <br>The time zone that the account will use for Firebase Analytics data.
# <br>For example: America/Los_Angeles or Africa/Abidjan
# Corresponds to the JSON property `timeZone`
# @return [String]
@ -895,7 +903,7 @@ module Google
# means that the project does not yet have a default GCP resource location.
# To set your project's default GCP resource location, call
# [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you
# add Firebase services to your project.
# add Firebase resources to your project.
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id

View File

@ -156,8 +156,6 @@ module Google
# <br>This method does not modify any billing account information on the
# underlying GCP `Project`.
# <br>
# <br>All fields listed in the [request body](#request-body) are required.
# <br>
# <br>To call `AddFirebase`, a member must be an Editor or Owner for the
# existing GCP `Project`. Service accounts cannot call `AddFirebase`.
# @param [String] project

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/healthcare
module HealthcareV1alpha2
VERSION = 'V1alpha2'
REVISION = '20190723'
REVISION = '20190730'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -2857,12 +2857,6 @@ module Google
class TextConfig
include Google::Apis::Core::Hashable
# Experimental de-identification config to use. For internal use only.
# If not specified, it is ignored and standard DLP is used.
# Corresponds to the JSON property `experimentalConfig`
# @return [String]
attr_accessor :experimental_config
# The transformations to apply to the detected data.
# Corresponds to the JSON property `transformations`
# @return [Array<Google::Apis::HealthcareV1alpha2::InfoTypeTransformation>]
@ -2874,7 +2868,6 @@ module Google
# Update properties of this object
def update!(**args)
@experimental_config = args[:experimental_config] if args.key?(:experimental_config)
@transformations = args[:transformations] if args.key?(:transformations)
end
end

View File

@ -1313,7 +1313,6 @@ module Google
class TextConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :experimental_config, as: 'experimentalConfig'
collection :transformations, as: 'transformations', class: Google::Apis::HealthcareV1alpha2::InfoTypeTransformation, decorator: Google::Apis::HealthcareV1alpha2::InfoTypeTransformation::Representation
end

View File

@ -2295,19 +2295,66 @@ module Google
end
# Import resources to the FHIR store by loading data from the specified
# sources. Each resource must have a client-supplied ID, which is retained
# by the server.
# The import operation is idempotent. Upon retry, the most recent data
# (matching the client-supplied ID) is overwritten, without creating a new
# resource version. If partial failures occur during the import, successful
# changes are not rolled back.
# If history imports are enabled
# (enable_history_import is set in the
# FHIR store's configuration), you can import historical versions of a
# resource by supplying a bundle of type `history`. The historical versions
# in the bundle must have `lastUpdated` timestamps. If a current or
# historical version with the supplied resource ID already exists, the
# bundle is rejected.
# sources. This method is optimized to load large quantities of data using
# import semantics that ignore some FHIR store configuration options and are
# not suitable for all use cases. It is primarily intended to load data into
# an empty FHIR store that is not being used by other clients. In cases
# where this method is not appropriate, consider using ExecuteBundle to
# load data.
# Every resource in the input must contain a client-supplied ID, and will be
# stored using that ID regardless of the
# enable_update_create setting on the FHIR
# store.
# The import process does not enforce referential integrity, regardless of
# the
# disable_referential_integrity
# setting on the FHIR store. This allows the import of resources with
# arbitrary interdependencies without considering grouping or ordering, but
# if the input data contains invalid references or if some resources fail to
# be imported, the FHIR store might be left in a state that violates
# referential integrity.
# If a resource with the specified ID already exists, the most recent
# version of the resource is overwritten without creating a new historical
# version, regardless of the
# disable_resource_versioning
# setting on the FHIR store. If transient failures occur during the import,
# it is possible that successfully imported resources will be overwritten
# more than once.
# The import operation is idempotent unless the input data contains multiple
# valid resources with the same ID but different contents. In that case,
# after the import completes, the store will contain exactly one resource
# with that ID but there is no ordering guarantee on which version of the
# contents it will have. The operation result counters do not count
# duplicate IDs as an error and will count one success for each resource in
# the input, which might result in a success count larger than the number
# of resources in the FHIR store. This often occurs when importing data
# organized in bundles produced by Patient-everything
# where each bundle contains its own copy of a resource such as Practitioner
# that might be referred to by many patients.
# If some resources fail to import, for example due to parsing errors,
# successfully imported resources are not rolled back.
# The location and format of the input data is specified by the parameters
# below. Note that if no format is specified, this method assumes the
# `BUNDLE` format. When using the `BUNDLE` format this method ignores the
# `Bundle.type` field, except for the special case of `history`, and does
# not apply any of the bundle processing semantics for batch or transaction
# bundles. Unlike in ExecuteBundle, transaction bundles are not executed
# as a single transaction and bundle-internal references are not rewritten.
# The bundle is treated as a collection of resources to be written as
# provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As
# an example, this allows the import of `searchset` bundles produced by a
# FHIR search or
# Patient-everything operation.
# If history imports are enabled by setting
# enable_history_import in the FHIR
# store's configuration, this method can import historical versions
# of a resource by supplying a bundle of type `history` and using the
# `BUNDLE` format. The historical versions in the bundle must have
# `lastUpdated` timestamps, and the resulting resource history on the server
# will appear as if the versions had been created at those timestamps. If a
# current or historical version with the supplied resource ID already
# exists, the bundle is rejected to avoid creating an inconsistent sequence
# of resource versions.
# This method returns an Operation that can
# be used to track the status of the import by calling
# GetOperation.

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/healthcare
module HealthcareV1beta1
VERSION = 'V1beta1'
REVISION = '20190723'
REVISION = '20190730'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -1775,19 +1775,66 @@ module Google
end
# Import resources to the FHIR store by loading data from the specified
# sources. Each resource must have a client-supplied ID, which is retained
# by the server.
# The import operation is idempotent. Upon retry, the most recent data
# (matching the client-supplied ID) is overwritten, without creating a new
# resource version. If partial failures occur during the import, successful
# changes are not rolled back.
# If history imports are enabled
# (enable_history_import is set in the
# FHIR store's configuration), you can import historical versions of a
# resource by supplying a bundle of type `history`. The historical versions
# in the bundle must have `lastUpdated` timestamps. If a current or
# historical version with the supplied resource ID already exists, the
# bundle is rejected.
# sources. This method is optimized to load large quantities of data using
# import semantics that ignore some FHIR store configuration options and are
# not suitable for all use cases. It is primarily intended to load data into
# an empty FHIR store that is not being used by other clients. In cases
# where this method is not appropriate, consider using ExecuteBundle to
# load data.
# Every resource in the input must contain a client-supplied ID, and will be
# stored using that ID regardless of the
# enable_update_create setting on the FHIR
# store.
# The import process does not enforce referential integrity, regardless of
# the
# disable_referential_integrity
# setting on the FHIR store. This allows the import of resources with
# arbitrary interdependencies without considering grouping or ordering, but
# if the input data contains invalid references or if some resources fail to
# be imported, the FHIR store might be left in a state that violates
# referential integrity.
# If a resource with the specified ID already exists, the most recent
# version of the resource is overwritten without creating a new historical
# version, regardless of the
# disable_resource_versioning
# setting on the FHIR store. If transient failures occur during the import,
# it is possible that successfully imported resources will be overwritten
# more than once.
# The import operation is idempotent unless the input data contains multiple
# valid resources with the same ID but different contents. In that case,
# after the import completes, the store will contain exactly one resource
# with that ID but there is no ordering guarantee on which version of the
# contents it will have. The operation result counters do not count
# duplicate IDs as an error and will count one success for each resource in
# the input, which might result in a success count larger than the number
# of resources in the FHIR store. This often occurs when importing data
# organized in bundles produced by Patient-everything
# where each bundle contains its own copy of a resource such as Practitioner
# that might be referred to by many patients.
# If some resources fail to import, for example due to parsing errors,
# successfully imported resources are not rolled back.
# The location and format of the input data is specified by the parameters
# below. Note that if no format is specified, this method assumes the
# `BUNDLE` format. When using the `BUNDLE` format this method ignores the
# `Bundle.type` field, except for the special case of `history`, and does
# not apply any of the bundle processing semantics for batch or transaction
# bundles. Unlike in ExecuteBundle, transaction bundles are not executed
# as a single transaction and bundle-internal references are not rewritten.
# The bundle is treated as a collection of resources to be written as
# provided in `Bundle.entry.resource`, ignoring `Bundle.entry.request`. As
# an example, this allows the import of `searchset` bundles produced by a
# FHIR search or
# Patient-everything operation.
# If history imports are enabled by setting
# enable_history_import in the FHIR
# store's configuration, this method can import historical versions
# of a resource by supplying a bundle of type `history` and using the
# `BUNDLE` format. The historical versions in the bundle must have
# `lastUpdated` timestamps, and the resulting resource history on the server
# will appear as if the versions had been created at those timestamps. If a
# current or historical version with the supplied resource ID already
# exists, the bundle is rejected to avoid creating an inconsistent sequence
# of resource versions.
# This method returns an Operation that can
# be used to track the status of the import by calling
# GetOperation.

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/service-consumer-management/docs/overview
module ServiceconsumermanagementV1
VERSION = 'V1'
REVISION = '20190708'
REVISION = '20190806'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -394,6 +394,10 @@ module Google
end
# Creates a tenancy unit with no tenant resources.
# If tenancy unit already exists, it will be returned,
# however, in this case, returned TenancyUnit does not have tenant_resources
# field set and ListTenancyUnit has to be used to get a complete
# TenancyUnit with all fields populated.
# @param [String] parent
# services/`service`/`collection id`/`resource id`
# `collection id` is the cloud resource collection type representing the

View File

@ -27,7 +27,7 @@ module Google
# @see https://cloud.google.com/service-usage/
module ServiceusageV1
VERSION = 'V1'
REVISION = '20190708'
REVISION = '20190806'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -441,8 +441,6 @@ module Google
# serviceusage.googleapis.com
# Enabling services requires that each service is public or is shared with
# the user enabling the service.
# Two or more services must be specified. To enable a single service,
# use the `EnableService` method instead.
# A single request can enable a maximum of 20 services at a time. If more
# than 20 services are specified, the request will fail, and no state changes
# will occur.

View File

@ -205,6 +205,7 @@ module Google
# Enable multiple services on a project. The operation is atomic: if enabling
# any service fails, then the entire batch fails, and no state changes occur.
# To enable a single service, use the `EnableService` method instead.
# @param [String] parent
# Parent to enable services on.
# An example name would be:

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/speech-to-text/docs/quickstart-protocol
module SpeechV1
VERSION = 'V1'
REVISION = '20190627'
REVISION = '20190804'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -375,7 +375,8 @@ module Google
# *Optional* array of SpeechContext.
# A means to provide context to assist the speech recognition. For more
# information, see [Phrase Hints](/speech-to-text/docs/basics#phrase-hints).
# information, see
# [speech adaptation](/speech-to-text/docs/context-strength).
# Corresponds to the JSON property `speechContexts`
# @return [Array<Google::Apis::SpeechV1::SpeechContext>]
attr_accessor :speech_contexts

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/speech-to-text/docs/quickstart-protocol
module SpeechV1p1beta1
VERSION = 'V1p1beta1'
REVISION = '20190730'
REVISION = '20190804'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

View File

@ -421,7 +421,8 @@ module Google
# *Optional* array of SpeechContext.
# A means to provide context to assist the speech recognition. For more
# information, see [Phrase Hints](/speech-to-text/docs/basics#phrase-hints).
# information, see
# [speech adaptation](/speech-to-text/docs/context-strength).
# Corresponds to the JSON property `speechContexts`
# @return [Array<Google::Apis::SpeechV1p1beta1::SpeechContext>]
attr_accessor :speech_contexts

View File

@ -25,7 +25,10 @@ module Google
# @see https://cloud.google.com/security-scanner/
module WebsecurityscannerV1
VERSION = 'V1'
REVISION = '20190622'
REVISION = '20190805'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
end
end
end

View File

@ -21,6 +21,930 @@ require 'google/apis/errors'
module Google
module Apis
module WebsecurityscannerV1
# Scan authentication configuration.
class Authentication
include Google::Apis::Core::Hashable
# Describes authentication configuration that uses a custom account.
# Corresponds to the JSON property `customAccount`
# @return [Google::Apis::WebsecurityscannerV1::CustomAccount]
attr_accessor :custom_account
# Describes authentication configuration that uses a Google account.
# Corresponds to the JSON property `googleAccount`
# @return [Google::Apis::WebsecurityscannerV1::GoogleAccount]
attr_accessor :google_account
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@custom_account = args[:custom_account] if args.key?(:custom_account)
@google_account = args[:google_account] if args.key?(:google_account)
end
end
# A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web
# Security Scanner Service crawls the web applications, following all links
# within the scope of sites, to find the URLs to test against.
class CrawledUrl
include Google::Apis::Core::Hashable
# Output only. The body of the request that was used to visit the URL.
# Corresponds to the JSON property `body`
# @return [String]
attr_accessor :body
# Output only. The http method of the request that was used to visit the URL, in
# uppercase.
# Corresponds to the JSON property `httpMethod`
# @return [String]
attr_accessor :http_method
# Output only. The URL that was crawled.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@body = args[:body] if args.key?(:body)
@http_method = args[:http_method] if args.key?(:http_method)
@url = args[:url] if args.key?(:url)
end
end
# Describes authentication configuration that uses a custom account.
class CustomAccount
include Google::Apis::Core::Hashable
# Required. The login form URL of the website.
# Corresponds to the JSON property `loginUrl`
# @return [String]
attr_accessor :login_url
# Required. Input only. The password of the custom account. The credential is
# stored encrypted
# and not returned in any response nor included in audit logs.
# Corresponds to the JSON property `password`
# @return [String]
attr_accessor :password
# Required. The user name of the custom account.
# Corresponds to the JSON property `username`
# @return [String]
attr_accessor :username
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@login_url = args[:login_url] if args.key?(:login_url)
@password = args[:password] if args.key?(:password)
@username = args[:username] if args.key?(:username)
end
end
# A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
# service Foo `
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# `
# The JSON representation for `Empty` is empty JSON object ````.
class Empty
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# A Finding resource represents a vulnerability instance identified during a
# ScanRun.
class Finding
include Google::Apis::Core::Hashable
# Output only. The body of the request that triggered the vulnerability.
# Corresponds to the JSON property `body`
# @return [String]
attr_accessor :body
# Output only. The description of the vulnerability.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Output only. The URL where the browser lands when the vulnerability is
# detected.
# Corresponds to the JSON property `finalUrl`
# @return [String]
attr_accessor :final_url
# Output only. The type of the Finding.
# Detailed and up-to-date information on findings can be found here:
# https://cloud.google.com/security-scanner/docs/scan-result-details
# Corresponds to the JSON property `findingType`
# @return [String]
attr_accessor :finding_type
# ! Information about a vulnerability with an HTML.
# Corresponds to the JSON property `form`
# @return [Google::Apis::WebsecurityscannerV1::Form]
attr_accessor :form
# Output only. If the vulnerability was originated from nested IFrame, the
# immediate
# parent IFrame is reported.
# Corresponds to the JSON property `frameUrl`
# @return [String]
attr_accessor :frame_url
# Output only. The URL produced by the server-side fuzzer and used in the
# request that
# triggered the vulnerability.
# Corresponds to the JSON property `fuzzedUrl`
# @return [String]
attr_accessor :fuzzed_url
# Output only. The http method of the request that triggered the vulnerability,
# in
# uppercase.
# Corresponds to the JSON property `httpMethod`
# @return [String]
attr_accessor :http_method
# Output only. The resource name of the Finding. The name follows the format of
# 'projects/`projectId`/scanConfigs/`scanConfigId`/scanruns/`scanRunId`/findings/
# `findingId`'.
# The finding IDs are generated by the system.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Information reported for an outdated library.
# Corresponds to the JSON property `outdatedLibrary`
# @return [Google::Apis::WebsecurityscannerV1::OutdatedLibrary]
attr_accessor :outdated_library
# Output only. The URL containing human-readable payload that user can leverage
# to
# reproduce the vulnerability.
# Corresponds to the JSON property `reproductionUrl`
# @return [String]
attr_accessor :reproduction_url
# Output only. The tracking ID uniquely identifies a vulnerability instance
# across
# multiple ScanRuns.
# Corresponds to the JSON property `trackingId`
# @return [String]
attr_accessor :tracking_id
# Information regarding any resource causing the vulnerability such
# as JavaScript sources, image, audio files, etc.
# Corresponds to the JSON property `violatingResource`
# @return [Google::Apis::WebsecurityscannerV1::ViolatingResource]
attr_accessor :violating_resource
# Information about vulnerable or missing HTTP Headers.
# Corresponds to the JSON property `vulnerableHeaders`
# @return [Google::Apis::WebsecurityscannerV1::VulnerableHeaders]
attr_accessor :vulnerable_headers
# Information about vulnerable request parameters.
# Corresponds to the JSON property `vulnerableParameters`
# @return [Google::Apis::WebsecurityscannerV1::VulnerableParameters]
attr_accessor :vulnerable_parameters
# Information reported for an XSS.
# Corresponds to the JSON property `xss`
# @return [Google::Apis::WebsecurityscannerV1::Xss]
attr_accessor :xss
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@body = args[:body] if args.key?(:body)
@description = args[:description] if args.key?(:description)
@final_url = args[:final_url] if args.key?(:final_url)
@finding_type = args[:finding_type] if args.key?(:finding_type)
@form = args[:form] if args.key?(:form)
@frame_url = args[:frame_url] if args.key?(:frame_url)
@fuzzed_url = args[:fuzzed_url] if args.key?(:fuzzed_url)
@http_method = args[:http_method] if args.key?(:http_method)
@name = args[:name] if args.key?(:name)
@outdated_library = args[:outdated_library] if args.key?(:outdated_library)
@reproduction_url = args[:reproduction_url] if args.key?(:reproduction_url)
@tracking_id = args[:tracking_id] if args.key?(:tracking_id)
@violating_resource = args[:violating_resource] if args.key?(:violating_resource)
@vulnerable_headers = args[:vulnerable_headers] if args.key?(:vulnerable_headers)
@vulnerable_parameters = args[:vulnerable_parameters] if args.key?(:vulnerable_parameters)
@xss = args[:xss] if args.key?(:xss)
end
end
# A FindingTypeStats resource represents stats regarding a specific FindingType
# of Findings under a given ScanRun.
class FindingTypeStats
include Google::Apis::Core::Hashable
# Output only. The count of findings belonging to this finding type.
# Corresponds to the JSON property `findingCount`
# @return [Fixnum]
attr_accessor :finding_count
# Output only. The finding type associated with the stats.
# Corresponds to the JSON property `findingType`
# @return [String]
attr_accessor :finding_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@finding_count = args[:finding_count] if args.key?(:finding_count)
@finding_type = args[:finding_type] if args.key?(:finding_type)
end
end
# ! Information about a vulnerability with an HTML.
class Form
include Google::Apis::Core::Hashable
# ! The URI where to send the form when it's submitted.
# Corresponds to the JSON property `actionUri`
# @return [String]
attr_accessor :action_uri
# ! The names of form fields related to the vulnerability.
# Corresponds to the JSON property `fields`
# @return [Array<String>]
attr_accessor :fields
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@action_uri = args[:action_uri] if args.key?(:action_uri)
@fields = args[:fields] if args.key?(:fields)
end
end
# Describes authentication configuration that uses a Google account.
class GoogleAccount
include Google::Apis::Core::Hashable
# Required. Input only. The password of the Google account. The credential is
# stored encrypted
# and not returned in any response nor included in audit logs.
# Corresponds to the JSON property `password`
# @return [String]
attr_accessor :password
# Required. The user name of the Google account.
# Corresponds to the JSON property `username`
# @return [String]
attr_accessor :username
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@password = args[:password] if args.key?(:password)
@username = args[:username] if args.key?(:username)
end
end
# Describes a HTTP Header.
class Header
include Google::Apis::Core::Hashable
# Header name.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Header value.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
@value = args[:value] if args.key?(:value)
end
end
# Response for the `ListCrawledUrls` method.
class ListCrawledUrlsResponse
include Google::Apis::Core::Hashable
# The list of CrawledUrls returned.
# Corresponds to the JSON property `crawledUrls`
# @return [Array<Google::Apis::WebsecurityscannerV1::CrawledUrl>]
attr_accessor :crawled_urls
# Token to retrieve the next page of results, or empty if there are no
# more results in the list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@crawled_urls = args[:crawled_urls] if args.key?(:crawled_urls)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Response for the `ListFindingTypeStats` method.
class ListFindingTypeStatsResponse
include Google::Apis::Core::Hashable
# The list of FindingTypeStats returned.
# Corresponds to the JSON property `findingTypeStats`
# @return [Array<Google::Apis::WebsecurityscannerV1::FindingTypeStats>]
attr_accessor :finding_type_stats
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@finding_type_stats = args[:finding_type_stats] if args.key?(:finding_type_stats)
end
end
# Response for the `ListFindings` method.
class ListFindingsResponse
include Google::Apis::Core::Hashable
# The list of Findings returned.
# Corresponds to the JSON property `findings`
# @return [Array<Google::Apis::WebsecurityscannerV1::Finding>]
attr_accessor :findings
# Token to retrieve the next page of results, or empty if there are no
# more results in the list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@findings = args[:findings] if args.key?(:findings)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
# Response for the `ListScanConfigs` method.
class ListScanConfigsResponse
include Google::Apis::Core::Hashable
# Token to retrieve the next page of results, or empty if there are no
# more results in the list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The list of ScanConfigs returned.
# Corresponds to the JSON property `scanConfigs`
# @return [Array<Google::Apis::WebsecurityscannerV1::ScanConfig>]
attr_accessor :scan_configs
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@scan_configs = args[:scan_configs] if args.key?(:scan_configs)
end
end
# Response for the `ListScanRuns` method.
class ListScanRunsResponse
include Google::Apis::Core::Hashable
# Token to retrieve the next page of results, or empty if there are no
# more results in the list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The list of ScanRuns returned.
# Corresponds to the JSON property `scanRuns`
# @return [Array<Google::Apis::WebsecurityscannerV1::ScanRun>]
attr_accessor :scan_runs
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@scan_runs = args[:scan_runs] if args.key?(:scan_runs)
end
end
# Information reported for an outdated library.
class OutdatedLibrary
include Google::Apis::Core::Hashable
# URLs to learn more information about the vulnerabilities in the library.
# Corresponds to the JSON property `learnMoreUrls`
# @return [Array<String>]
attr_accessor :learn_more_urls
# The name of the outdated library.
# Corresponds to the JSON property `libraryName`
# @return [String]
attr_accessor :library_name
# The version number.
# Corresponds to the JSON property `version`
# @return [String]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@learn_more_urls = args[:learn_more_urls] if args.key?(:learn_more_urls)
@library_name = args[:library_name] if args.key?(:library_name)
@version = args[:version] if args.key?(:version)
end
end
# A ScanConfig resource contains the configurations to launch a scan.
class ScanConfig
include Google::Apis::Core::Hashable
# Scan authentication configuration.
# Corresponds to the JSON property `authentication`
# @return [Google::Apis::WebsecurityscannerV1::Authentication]
attr_accessor :authentication
# The blacklist URL patterns as described in
# https://cloud.google.com/security-scanner/docs/excluded-urls
# Corresponds to the JSON property `blacklistPatterns`
# @return [Array<String>]
attr_accessor :blacklist_patterns
# Required. The user provided display name of the ScanConfig.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# Controls export of scan configurations and results to Cloud Security
# Command Center.
# Corresponds to the JSON property `exportToSecurityCommandCenter`
# @return [String]
attr_accessor :export_to_security_command_center
# The maximum QPS during scanning. A valid value ranges from 5 to 20
# inclusively. If the field is unspecified or its value is set 0, server will
# default to 15. Other values outside of [5, 20] range will be rejected with
# INVALID_ARGUMENT error.
# Corresponds to the JSON property `maxQps`
# @return [Fixnum]
attr_accessor :max_qps
# The resource name of the ScanConfig. The name follows the format of
# 'projects/`projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are
# generated by the system.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The risk level selected for the scan
# Corresponds to the JSON property `riskLevel`
# @return [String]
attr_accessor :risk_level
# Scan schedule configuration.
# Corresponds to the JSON property `schedule`
# @return [Google::Apis::WebsecurityscannerV1::Schedule]
attr_accessor :schedule
# Required. The starting URLs from which the scanner finds site pages.
# Corresponds to the JSON property `startingUrls`
# @return [Array<String>]
attr_accessor :starting_urls
# The user agent used during scanning.
# Corresponds to the JSON property `userAgent`
# @return [String]
attr_accessor :user_agent
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@authentication = args[:authentication] if args.key?(:authentication)
@blacklist_patterns = args[:blacklist_patterns] if args.key?(:blacklist_patterns)
@display_name = args[:display_name] if args.key?(:display_name)
@export_to_security_command_center = args[:export_to_security_command_center] if args.key?(:export_to_security_command_center)
@max_qps = args[:max_qps] if args.key?(:max_qps)
@name = args[:name] if args.key?(:name)
@risk_level = args[:risk_level] if args.key?(:risk_level)
@schedule = args[:schedule] if args.key?(:schedule)
@starting_urls = args[:starting_urls] if args.key?(:starting_urls)
@user_agent = args[:user_agent] if args.key?(:user_agent)
end
end
# Defines a custom error message used by CreateScanConfig and UpdateScanConfig
# APIs when scan configuration validation fails. It is also reported as part of
# a ScanRunErrorTrace message if scan validation fails due to a scan
# configuration error.
class ScanConfigError
include Google::Apis::Core::Hashable
# Output only. Indicates the reason code for a configuration failure.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# Output only. Indicates the full name of the ScanConfig field that triggers
# this error,
# for example "scan_config.max_qps". This field is provided for
# troubleshooting purposes only and its actual value can change in the
# future.
# Corresponds to the JSON property `fieldName`
# @return [String]
attr_accessor :field_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@field_name = args[:field_name] if args.key?(:field_name)
end
end
# A ScanRun is a output-only resource representing an actual run of the scan.
# Next id: 12
class ScanRun
include Google::Apis::Core::Hashable
# Output only. The time at which the ScanRun reached termination state - that
# the ScanRun
# is either finished or stopped by user.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# Output only.
# Defines an error trace message for a ScanRun.
# Corresponds to the JSON property `errorTrace`
# @return [Google::Apis::WebsecurityscannerV1::ScanRunErrorTrace]
attr_accessor :error_trace
# Output only. The execution state of the ScanRun.
# Corresponds to the JSON property `executionState`
# @return [String]
attr_accessor :execution_state
# Output only. Whether the scan run has found any vulnerabilities.
# Corresponds to the JSON property `hasVulnerabilities`
# @return [Boolean]
attr_accessor :has_vulnerabilities
alias_method :has_vulnerabilities?, :has_vulnerabilities
# Output only. The resource name of the ScanRun. The name follows the format of
# 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'.
# The ScanRun IDs are generated by the system.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Output only. The percentage of total completion ranging from 0 to 100.
# If the scan is in queue, the value is 0.
# If the scan is running, the value ranges from 0 to 100.
# If the scan is finished, the value is 100.
# Corresponds to the JSON property `progressPercent`
# @return [Fixnum]
attr_accessor :progress_percent
# Output only. The result state of the ScanRun. This field is only available
# after the
# execution state reaches "FINISHED".
# Corresponds to the JSON property `resultState`
# @return [String]
attr_accessor :result_state
# Output only. The time at which the ScanRun started.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
# Output only. The number of URLs crawled during this ScanRun. If the scan is in
# progress,
# the value represents the number of URLs crawled up to now.
# Corresponds to the JSON property `urlsCrawledCount`
# @return [Fixnum]
attr_accessor :urls_crawled_count
# Output only. The number of URLs tested during this ScanRun. If the scan is in
# progress,
# the value represents the number of URLs tested up to now. The number of
# URLs tested is usually larger than the number URLS crawled because
# typically a crawled URL is tested with multiple test payloads.
# Corresponds to the JSON property `urlsTestedCount`
# @return [Fixnum]
attr_accessor :urls_tested_count
# Output only. A list of warnings, if such are encountered during this scan run.
# Corresponds to the JSON property `warningTraces`
# @return [Array<Google::Apis::WebsecurityscannerV1::ScanRunWarningTrace>]
attr_accessor :warning_traces
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@end_time = args[:end_time] if args.key?(:end_time)
@error_trace = args[:error_trace] if args.key?(:error_trace)
@execution_state = args[:execution_state] if args.key?(:execution_state)
@has_vulnerabilities = args[:has_vulnerabilities] if args.key?(:has_vulnerabilities)
@name = args[:name] if args.key?(:name)
@progress_percent = args[:progress_percent] if args.key?(:progress_percent)
@result_state = args[:result_state] if args.key?(:result_state)
@start_time = args[:start_time] if args.key?(:start_time)
@urls_crawled_count = args[:urls_crawled_count] if args.key?(:urls_crawled_count)
@urls_tested_count = args[:urls_tested_count] if args.key?(:urls_tested_count)
@warning_traces = args[:warning_traces] if args.key?(:warning_traces)
end
end
# Output only.
# Defines an error trace message for a ScanRun.
class ScanRunErrorTrace
include Google::Apis::Core::Hashable
# Output only. Indicates the error reason code.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# Output only. If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates
# the most
# common HTTP error code, if such is available. For example, if this code is
# 404, the scan has encountered too many NOT_FOUND responses.
# Corresponds to the JSON property `mostCommonHttpErrorCode`
# @return [Fixnum]
attr_accessor :most_common_http_error_code
# Defines a custom error message used by CreateScanConfig and UpdateScanConfig
# APIs when scan configuration validation fails. It is also reported as part of
# a ScanRunErrorTrace message if scan validation fails due to a scan
# configuration error.
# Corresponds to the JSON property `scanConfigError`
# @return [Google::Apis::WebsecurityscannerV1::ScanConfigError]
attr_accessor :scan_config_error
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@most_common_http_error_code = args[:most_common_http_error_code] if args.key?(:most_common_http_error_code)
@scan_config_error = args[:scan_config_error] if args.key?(:scan_config_error)
end
end
# Output only.
# Defines a warning trace message for ScanRun. Warning traces provide customers
# with useful information that helps make the scanning process more effective.
class ScanRunWarningTrace
include Google::Apis::Core::Hashable
# Output only. Indicates the warning code.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
end
end
# Scan schedule configuration.
class Schedule
include Google::Apis::Core::Hashable
# Required. The duration of time between executions in days.
# Corresponds to the JSON property `intervalDurationDays`
# @return [Fixnum]
attr_accessor :interval_duration_days
# A timestamp indicates when the next run will be scheduled. The value is
# refreshed by the server after each run. If unspecified, it will default
# to current server time, which means the scan will be scheduled to start
# immediately.
# Corresponds to the JSON property `scheduleTime`
# @return [String]
attr_accessor :schedule_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@interval_duration_days = args[:interval_duration_days] if args.key?(:interval_duration_days)
@schedule_time = args[:schedule_time] if args.key?(:schedule_time)
end
end
# Request for the `StartScanRun` method.
class StartScanRunRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Request for the `StopScanRun` method.
class StopScanRunRequest
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Information regarding any resource causing the vulnerability such
# as JavaScript sources, image, audio files, etc.
class ViolatingResource
include Google::Apis::Core::Hashable
# The MIME type of this resource.
# Corresponds to the JSON property `contentType`
# @return [String]
attr_accessor :content_type
# URL of this violating resource.
# Corresponds to the JSON property `resourceUrl`
# @return [String]
attr_accessor :resource_url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@content_type = args[:content_type] if args.key?(:content_type)
@resource_url = args[:resource_url] if args.key?(:resource_url)
end
end
# Information about vulnerable or missing HTTP Headers.
class VulnerableHeaders
include Google::Apis::Core::Hashable
# List of vulnerable headers.
# Corresponds to the JSON property `headers`
# @return [Array<Google::Apis::WebsecurityscannerV1::Header>]
attr_accessor :headers
# List of missing headers.
# Corresponds to the JSON property `missingHeaders`
# @return [Array<Google::Apis::WebsecurityscannerV1::Header>]
attr_accessor :missing_headers
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@headers = args[:headers] if args.key?(:headers)
@missing_headers = args[:missing_headers] if args.key?(:missing_headers)
end
end
# Information about vulnerable request parameters.
class VulnerableParameters
include Google::Apis::Core::Hashable
# The vulnerable parameter names.
# Corresponds to the JSON property `parameterNames`
# @return [Array<String>]
attr_accessor :parameter_names
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@parameter_names = args[:parameter_names] if args.key?(:parameter_names)
end
end
# Information reported for an XSS.
class Xss
include Google::Apis::Core::Hashable
# The attack vector of the payload triggering this XSS.
# Corresponds to the JSON property `attackVector`
# @return [String]
attr_accessor :attack_vector
# An error message generated by a javascript breakage.
# Corresponds to the JSON property `errorMessage`
# @return [String]
attr_accessor :error_message
# Stack traces leading to the point where the XSS occurred.
# Corresponds to the JSON property `stackTraces`
# @return [Array<String>]
attr_accessor :stack_traces
# The reproduction url for the seeding POST request of a Stored XSS.
# Corresponds to the JSON property `storedXssSeedingUrl`
# @return [String]
attr_accessor :stored_xss_seeding_url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@attack_vector = args[:attack_vector] if args.key?(:attack_vector)
@error_message = args[:error_message] if args.key?(:error_message)
@stack_traces = args[:stack_traces] if args.key?(:stack_traces)
@stored_xss_seeding_url = args[:stored_xss_seeding_url] if args.key?(:stored_xss_seeding_url)
end
end
end
end
end

View File

@ -21,6 +21,432 @@ require 'google/apis/errors'
module Google
module Apis
module WebsecurityscannerV1
class Authentication
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CrawledUrl
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class CustomAccount
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 Finding
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class FindingTypeStats
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Form
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class GoogleAccount
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Header
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListCrawledUrlsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListFindingTypeStatsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListFindingsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListScanConfigsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ListScanRunsResponse
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class OutdatedLibrary
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ScanConfig
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ScanConfigError
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ScanRun
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ScanRunErrorTrace
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ScanRunWarningTrace
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Schedule
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class StartScanRunRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class StopScanRunRequest
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class ViolatingResource
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class VulnerableHeaders
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class VulnerableParameters
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Xss
class Representation < Google::Apis::Core::JsonRepresentation; end
include Google::Apis::Core::JsonObjectSupport
end
class Authentication
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :custom_account, as: 'customAccount', class: Google::Apis::WebsecurityscannerV1::CustomAccount, decorator: Google::Apis::WebsecurityscannerV1::CustomAccount::Representation
property :google_account, as: 'googleAccount', class: Google::Apis::WebsecurityscannerV1::GoogleAccount, decorator: Google::Apis::WebsecurityscannerV1::GoogleAccount::Representation
end
end
class CrawledUrl
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :body, as: 'body'
property :http_method, as: 'httpMethod'
property :url, as: 'url'
end
end
class CustomAccount
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :login_url, as: 'loginUrl'
property :password, as: 'password'
property :username, as: 'username'
end
end
class Empty
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class Finding
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :body, as: 'body'
property :description, as: 'description'
property :final_url, as: 'finalUrl'
property :finding_type, as: 'findingType'
property :form, as: 'form', class: Google::Apis::WebsecurityscannerV1::Form, decorator: Google::Apis::WebsecurityscannerV1::Form::Representation
property :frame_url, as: 'frameUrl'
property :fuzzed_url, as: 'fuzzedUrl'
property :http_method, as: 'httpMethod'
property :name, as: 'name'
property :outdated_library, as: 'outdatedLibrary', class: Google::Apis::WebsecurityscannerV1::OutdatedLibrary, decorator: Google::Apis::WebsecurityscannerV1::OutdatedLibrary::Representation
property :reproduction_url, as: 'reproductionUrl'
property :tracking_id, as: 'trackingId'
property :violating_resource, as: 'violatingResource', class: Google::Apis::WebsecurityscannerV1::ViolatingResource, decorator: Google::Apis::WebsecurityscannerV1::ViolatingResource::Representation
property :vulnerable_headers, as: 'vulnerableHeaders', class: Google::Apis::WebsecurityscannerV1::VulnerableHeaders, decorator: Google::Apis::WebsecurityscannerV1::VulnerableHeaders::Representation
property :vulnerable_parameters, as: 'vulnerableParameters', class: Google::Apis::WebsecurityscannerV1::VulnerableParameters, decorator: Google::Apis::WebsecurityscannerV1::VulnerableParameters::Representation
property :xss, as: 'xss', class: Google::Apis::WebsecurityscannerV1::Xss, decorator: Google::Apis::WebsecurityscannerV1::Xss::Representation
end
end
class FindingTypeStats
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :finding_count, as: 'findingCount'
property :finding_type, as: 'findingType'
end
end
class Form
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :action_uri, as: 'actionUri'
collection :fields, as: 'fields'
end
end
class GoogleAccount
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :password, as: 'password'
property :username, as: 'username'
end
end
class Header
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :name, as: 'name'
property :value, as: 'value'
end
end
class ListCrawledUrlsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :crawled_urls, as: 'crawledUrls', class: Google::Apis::WebsecurityscannerV1::CrawledUrl, decorator: Google::Apis::WebsecurityscannerV1::CrawledUrl::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class ListFindingTypeStatsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :finding_type_stats, as: 'findingTypeStats', class: Google::Apis::WebsecurityscannerV1::FindingTypeStats, decorator: Google::Apis::WebsecurityscannerV1::FindingTypeStats::Representation
end
end
class ListFindingsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :findings, as: 'findings', class: Google::Apis::WebsecurityscannerV1::Finding, decorator: Google::Apis::WebsecurityscannerV1::Finding::Representation
property :next_page_token, as: 'nextPageToken'
end
end
class ListScanConfigsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :scan_configs, as: 'scanConfigs', class: Google::Apis::WebsecurityscannerV1::ScanConfig, decorator: Google::Apis::WebsecurityscannerV1::ScanConfig::Representation
end
end
class ListScanRunsResponse
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :next_page_token, as: 'nextPageToken'
collection :scan_runs, as: 'scanRuns', class: Google::Apis::WebsecurityscannerV1::ScanRun, decorator: Google::Apis::WebsecurityscannerV1::ScanRun::Representation
end
end
class OutdatedLibrary
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :learn_more_urls, as: 'learnMoreUrls'
property :library_name, as: 'libraryName'
property :version, as: 'version'
end
end
class ScanConfig
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :authentication, as: 'authentication', class: Google::Apis::WebsecurityscannerV1::Authentication, decorator: Google::Apis::WebsecurityscannerV1::Authentication::Representation
collection :blacklist_patterns, as: 'blacklistPatterns'
property :display_name, as: 'displayName'
property :export_to_security_command_center, as: 'exportToSecurityCommandCenter'
property :max_qps, as: 'maxQps'
property :name, as: 'name'
property :risk_level, as: 'riskLevel'
property :schedule, as: 'schedule', class: Google::Apis::WebsecurityscannerV1::Schedule, decorator: Google::Apis::WebsecurityscannerV1::Schedule::Representation
collection :starting_urls, as: 'startingUrls'
property :user_agent, as: 'userAgent'
end
end
class ScanConfigError
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
property :field_name, as: 'fieldName'
end
end
class ScanRun
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :end_time, as: 'endTime'
property :error_trace, as: 'errorTrace', class: Google::Apis::WebsecurityscannerV1::ScanRunErrorTrace, decorator: Google::Apis::WebsecurityscannerV1::ScanRunErrorTrace::Representation
property :execution_state, as: 'executionState'
property :has_vulnerabilities, as: 'hasVulnerabilities'
property :name, as: 'name'
property :progress_percent, as: 'progressPercent'
property :result_state, as: 'resultState'
property :start_time, as: 'startTime'
property :urls_crawled_count, :numeric_string => true, as: 'urlsCrawledCount'
property :urls_tested_count, :numeric_string => true, as: 'urlsTestedCount'
collection :warning_traces, as: 'warningTraces', class: Google::Apis::WebsecurityscannerV1::ScanRunWarningTrace, decorator: Google::Apis::WebsecurityscannerV1::ScanRunWarningTrace::Representation
end
end
class ScanRunErrorTrace
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
property :most_common_http_error_code, as: 'mostCommonHttpErrorCode'
property :scan_config_error, as: 'scanConfigError', class: Google::Apis::WebsecurityscannerV1::ScanConfigError, decorator: Google::Apis::WebsecurityscannerV1::ScanConfigError::Representation
end
end
class ScanRunWarningTrace
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :code, as: 'code'
end
end
class Schedule
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :interval_duration_days, as: 'intervalDurationDays'
property :schedule_time, as: 'scheduleTime'
end
end
class StartScanRunRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class StopScanRunRequest
# @private
class Representation < Google::Apis::Core::JsonRepresentation
end
end
class ViolatingResource
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :content_type, as: 'contentType'
property :resource_url, as: 'resourceUrl'
end
end
class VulnerableHeaders
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :headers, as: 'headers', class: Google::Apis::WebsecurityscannerV1::Header, decorator: Google::Apis::WebsecurityscannerV1::Header::Representation
collection :missing_headers, as: 'missingHeaders', class: Google::Apis::WebsecurityscannerV1::Header, decorator: Google::Apis::WebsecurityscannerV1::Header::Representation
end
end
class VulnerableParameters
# @private
class Representation < Google::Apis::Core::JsonRepresentation
collection :parameter_names, as: 'parameterNames'
end
end
class Xss
# @private
class Representation < Google::Apis::Core::JsonRepresentation
property :attack_vector, as: 'attackVector'
property :error_message, as: 'errorMessage'
collection :stack_traces, as: 'stackTraces'
property :stored_xss_seeding_url, as: 'storedXssSeedingUrl'
end
end
end
end
end

View File

@ -46,6 +46,493 @@ module Google
super('https://websecurityscanner.googleapis.com/', '')
@batch_path = 'batch'
end
# Creates a new ScanConfig.
# @param [String] parent
# Required. The parent resource name where the scan is created, which should be
# a
# project resource name in the format 'projects/`projectId`'.
# @param [Google::Apis::WebsecurityscannerV1::ScanConfig] scan_config_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::WebsecurityscannerV1::ScanConfig] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::WebsecurityscannerV1::ScanConfig]
#
# @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_scan_config(parent, scan_config_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+parent}/scanConfigs', options)
command.request_representation = Google::Apis::WebsecurityscannerV1::ScanConfig::Representation
command.request_object = scan_config_object
command.response_representation = Google::Apis::WebsecurityscannerV1::ScanConfig::Representation
command.response_class = Google::Apis::WebsecurityscannerV1::ScanConfig
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an existing ScanConfig and its child resources.
# @param [String] name
# Required. The resource name of the ScanConfig to be deleted. The name follows
# the
# format of 'projects/`projectId`/scanConfigs/`scanConfigId`'.
# @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::WebsecurityscannerV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::WebsecurityscannerV1::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_scan_config(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::WebsecurityscannerV1::Empty::Representation
command.response_class = Google::Apis::WebsecurityscannerV1::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a ScanConfig.
# @param [String] name
# Required. The resource name of the ScanConfig to be returned. The name follows
# the
# format of 'projects/`projectId`/scanConfigs/`scanConfigId`'.
# @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::WebsecurityscannerV1::ScanConfig] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::WebsecurityscannerV1::ScanConfig]
#
# @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_scan_config(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::WebsecurityscannerV1::ScanConfig::Representation
command.response_class = Google::Apis::WebsecurityscannerV1::ScanConfig
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 ScanConfigs under a given project.
# @param [String] parent
# Required. The parent resource name, which should be a project resource name in
# the
# format 'projects/`projectId`'.
# @param [Fixnum] page_size
# The maximum number of ScanConfigs to return, can be limited by server.
# If not specified or not positive, the implementation will select a
# reasonable value.
# @param [String] page_token
# A token identifying a page of results to be returned. This should be a
# `next_page_token` value returned from a previous List request.
# If unspecified, the first page of results is returned.
# @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::WebsecurityscannerV1::ListScanConfigsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::WebsecurityscannerV1::ListScanConfigsResponse]
#
# @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_scan_configs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/scanConfigs', options)
command.response_representation = Google::Apis::WebsecurityscannerV1::ListScanConfigsResponse::Representation
command.response_class = Google::Apis::WebsecurityscannerV1::ListScanConfigsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates a ScanConfig. This method support partial update of a ScanConfig.
# @param [String] name
# The resource name of the ScanConfig. The name follows the format of
# 'projects/`projectId`/scanConfigs/`scanConfigId`'. The ScanConfig IDs are
# generated by the system.
# @param [Google::Apis::WebsecurityscannerV1::ScanConfig] scan_config_object
# @param [String] update_mask
# Required. The update mask applies to the resource. For the `FieldMask`
# definition,
# see
# https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#
# fieldmask
# @param [String] fields
# 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::WebsecurityscannerV1::ScanConfig] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::WebsecurityscannerV1::ScanConfig]
#
# @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_scan_config(name, scan_config_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::WebsecurityscannerV1::ScanConfig::Representation
command.request_object = scan_config_object
command.response_representation = Google::Apis::WebsecurityscannerV1::ScanConfig::Representation
command.response_class = Google::Apis::WebsecurityscannerV1::ScanConfig
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
# Start a ScanRun according to the given ScanConfig.
# @param [String] name
# Required. The resource name of the ScanConfig to be used. The name follows the
# format of 'projects/`projectId`/scanConfigs/`scanConfigId`'.
# @param [Google::Apis::WebsecurityscannerV1::StartScanRunRequest] start_scan_run_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::WebsecurityscannerV1::ScanRun] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::WebsecurityscannerV1::ScanRun]
#
# @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 start_scan_config_scan_run(name, start_scan_run_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:start', options)
command.request_representation = Google::Apis::WebsecurityscannerV1::StartScanRunRequest::Representation
command.request_object = start_scan_run_request_object
command.response_representation = Google::Apis::WebsecurityscannerV1::ScanRun::Representation
command.response_class = Google::Apis::WebsecurityscannerV1::ScanRun
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a ScanRun.
# @param [String] name
# Required. The resource name of the ScanRun to be returned. The name follows
# the
# format of
# 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'.
# @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::WebsecurityscannerV1::ScanRun] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::WebsecurityscannerV1::ScanRun]
#
# @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_scan_config_scan_run(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::WebsecurityscannerV1::ScanRun::Representation
command.response_class = Google::Apis::WebsecurityscannerV1::ScanRun
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 ScanRuns under a given ScanConfig, in descending order of ScanRun
# stop time.
# @param [String] parent
# Required. The parent resource name, which should be a scan resource name in
# the
# format 'projects/`projectId`/scanConfigs/`scanConfigId`'.
# @param [Fixnum] page_size
# The maximum number of ScanRuns to return, can be limited by server.
# If not specified or not positive, the implementation will select a
# reasonable value.
# @param [String] page_token
# A token identifying a page of results to be returned. This should be a
# `next_page_token` value returned from a previous List request.
# If unspecified, the first page of results is returned.
# @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::WebsecurityscannerV1::ListScanRunsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::WebsecurityscannerV1::ListScanRunsResponse]
#
# @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_scan_config_scan_runs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/scanRuns', options)
command.response_representation = Google::Apis::WebsecurityscannerV1::ListScanRunsResponse::Representation
command.response_class = Google::Apis::WebsecurityscannerV1::ListScanRunsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Stops a ScanRun. The stopped ScanRun is returned.
# @param [String] name
# Required. The resource name of the ScanRun to be stopped. The name follows the
# format of
# 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'.
# @param [Google::Apis::WebsecurityscannerV1::StopScanRunRequest] stop_scan_run_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::WebsecurityscannerV1::ScanRun] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::WebsecurityscannerV1::ScanRun]
#
# @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 stop_scan_run(name, stop_scan_run_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:stop', options)
command.request_representation = Google::Apis::WebsecurityscannerV1::StopScanRunRequest::Representation
command.request_object = stop_scan_run_request_object
command.response_representation = Google::Apis::WebsecurityscannerV1::ScanRun::Representation
command.response_class = Google::Apis::WebsecurityscannerV1::ScanRun
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
# List CrawledUrls under a given ScanRun.
# @param [String] parent
# Required. The parent resource name, which should be a scan run resource name
# in the
# format
# 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'.
# @param [Fixnum] page_size
# The maximum number of CrawledUrls to return, can be limited by server.
# If not specified or not positive, the implementation will select a
# reasonable value.
# @param [String] page_token
# A token identifying a page of results to be returned. This should be a
# `next_page_token` value returned from a previous List request.
# If unspecified, the first page of results is returned.
# @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::WebsecurityscannerV1::ListCrawledUrlsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::WebsecurityscannerV1::ListCrawledUrlsResponse]
#
# @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_scan_config_scan_run_crawled_urls(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/crawledUrls', options)
command.response_representation = Google::Apis::WebsecurityscannerV1::ListCrawledUrlsResponse::Representation
command.response_class = Google::Apis::WebsecurityscannerV1::ListCrawledUrlsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# List all FindingTypeStats under a given ScanRun.
# @param [String] parent
# Required. The parent resource name, which should be a scan run resource name
# in the
# format
# 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'.
# @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::WebsecurityscannerV1::ListFindingTypeStatsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::WebsecurityscannerV1::ListFindingTypeStatsResponse]
#
# @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_scan_config_scan_run_finding_type_stats(parent, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/findingTypeStats', options)
command.response_representation = Google::Apis::WebsecurityscannerV1::ListFindingTypeStatsResponse::Representation
command.response_class = Google::Apis::WebsecurityscannerV1::ListFindingTypeStatsResponse
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a Finding.
# @param [String] name
# Required. The resource name of the Finding to be returned. The name follows
# the
# format of
# 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`/findings/
# `findingId`'.
# @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::WebsecurityscannerV1::Finding] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::WebsecurityscannerV1::Finding]
#
# @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_scan_config_scan_run_finding(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::WebsecurityscannerV1::Finding::Representation
command.response_class = Google::Apis::WebsecurityscannerV1::Finding
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
# List Findings under a given ScanRun.
# @param [String] parent
# Required. The parent resource name, which should be a scan run resource name
# in the
# format
# 'projects/`projectId`/scanConfigs/`scanConfigId`/scanRuns/`scanRunId`'.
# @param [String] filter
# The filter expression. The expression must be in the format: <field>
# <operator> <value>.
# Supported field: 'finding_type'.
# Supported operator: '='.
# @param [Fixnum] page_size
# The maximum number of Findings to return, can be limited by server.
# If not specified or not positive, the implementation will select a
# reasonable value.
# @param [String] page_token
# A token identifying a page of results to be returned. This should be a
# `next_page_token` value returned from a previous List request.
# If unspecified, the first page of results is returned.
# @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::WebsecurityscannerV1::ListFindingsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::WebsecurityscannerV1::ListFindingsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_scan_config_scan_run_findings(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/findings', options)
command.response_representation = Google::Apis::WebsecurityscannerV1::ListFindingsResponse::Representation
command.response_class = Google::Apis::WebsecurityscannerV1::ListFindingsResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected

View File

@ -25,7 +25,7 @@ module Google
# @see https://cloud.google.com/security-scanner/
module WebsecurityscannerV1beta
VERSION = 'V1beta'
REVISION = '20190629'
REVISION = '20190805'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'