blob: 7ad49ade4f0c825f354a48116084edf06e48c79e [file] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.globalFrontendSettings.html">globalFrontendSettings</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(project, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the Global Frontend Billing Bundle Settings for a project.</p>
<p class="toc_element">
<code><a href="#patch">patch(project, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the Global Frontend Billing Bundle Settings for a project.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, x__xgafv=None)</code>
<pre>Gets the Global Frontend Billing Bundle Settings for a project.
Args:
project: string, A parameter (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents the Global Frontend Bundle settings for a single project.
&quot;bundleType&quot;: &quot;A String&quot;, # Customer-settable bundle type.
&quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp in RFC3339 text format.
&quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional description of this resource.
&quot;etag&quot;: &quot;A String&quot;, # Output only. For optimistic locking
&quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
&quot;name&quot;: &quot;A String&quot;, # Output only. OUTPUT_ONLY fields
# [Output Only] Name of the resource. Must be 1-63 characters long and match
# the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
# character must be a lowercase letter, and all following characters must
# be a dash, lowercase letter, or digit, except the last character, which
# cannot be a dash.
&quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(project, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the Global Frontend Billing Bundle Settings for a project.
Args:
project: string, A parameter (required)
body: object, The request body.
The object takes the form of:
{ # Represents the Global Frontend Bundle settings for a single project.
&quot;bundleType&quot;: &quot;A String&quot;, # Customer-settable bundle type.
&quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp in RFC3339 text format.
&quot;description&quot;: &quot;A String&quot;, # Output only. [Output Only] An optional description of this resource.
&quot;etag&quot;: &quot;A String&quot;, # Output only. For optimistic locking
&quot;id&quot;: &quot;A String&quot;, # Output only. [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
&quot;name&quot;: &quot;A String&quot;, # Output only. OUTPUT_ONLY fields
# [Output Only] Name of the resource. Must be 1-63 characters long and match
# the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
# character must be a lowercase letter, and all following characters must
# be a dash, lowercase letter, or digit, except the last character, which
# cannot be a dash.
&quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for the resource.
}
requestId: string, A parameter
updateMask: string, e.g., &quot;type&quot;
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response to an UpdateGlobalFrontendSettingsRequest.
&quot;operation&quot;: { # Represents an Operation resource.
#
# Google Compute Engine has three Operation resources:
#
# * [Global](/compute/docs/reference/rest/alpha/globalOperations)
# * [Regional](/compute/docs/reference/rest/alpha/regionOperations)
# * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations)
#
# You can use an operation resource to manage asynchronous API requests.
# For more information, readHandling
# API responses.
#
# Operations can be global, regional or zonal.
#
# - For global operations, use the `globalOperations`
# resource.
# - For regional operations, use the
# `regionOperations` resource.
# - For zonal operations, use
# the `zoneOperations` resource.
#
#
#
# For more information, read
# Global, Regional, and Zonal Resources.
#
# Note that completed Operation resources have a limited
# retention period.
&quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The value of `requestId` if you provided it in the request.
# Not present otherwise.
&quot;creationTimestamp&quot;: &quot;A String&quot;, # [Deprecated] This field is deprecated.
&quot;description&quot;: &quot;A String&quot;, # [Output Only] A textual description of the operation, which is
# set when the operation is created.
&quot;endTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was completed. This value is inRFC3339
# text format.
&quot;error&quot;: { # [Output Only] If errors are generated during processing of the operation,
# this field will be populated.
&quot;errors&quot;: [ # [Output Only] The array of errors encountered while processing this
# operation.
{ # Represents a single error encountered during the processing of an
# operation.
&quot;code&quot;: &quot;A String&quot;, # [Output Only] The error type identifier for this error.
&quot;errorDetails&quot;: [ # [Output Only] An optional list of messages that contain the error
# details. There is a set of defined message types to use for providing
# details.The syntax depends on the error code. For example,
# QuotaExceededInfo will have details when the error code is
# QUOTA_EXCEEDED.
{ # Container for structured error details providing additional context
# specific to the encountered error code.
&quot;errorInfo&quot;: { # Describes the cause of the error with structured details. # Error information containing structured domain, reason, and metadata.
#
# Example of an error when contacting the &quot;pubsub.googleapis.com&quot; API when it
# is not enabled:
#
# { &quot;reason&quot;: &quot;API_DISABLED&quot;
# &quot;domain&quot;: &quot;googleapis.com&quot;
# &quot;metadata&quot;: {
# &quot;resource&quot;: &quot;projects/123&quot;,
# &quot;service&quot;: &quot;pubsub.googleapis.com&quot;
# }
# }
#
# This response indicates that the pubsub.googleapis.com API is not enabled.
#
# Example of an error that is returned when attempting to create a Spanner
# instance in a region that is out of stock:
#
# { &quot;reason&quot;: &quot;STOCKOUT&quot;
# &quot;domain&quot;: &quot;spanner.googleapis.com&quot;,
# &quot;metadata&quot;: {
# &quot;availableRegions&quot;: &quot;us-central1,us-east2&quot;
# }
# }
&quot;domain&quot;: &quot;A String&quot;, # The logical grouping to which the &quot;reason&quot; belongs. The error domain
# is typically the registered service name of the tool or product that
# generates the error. Example: &quot;pubsub.googleapis.com&quot;. If the error is
# generated by some common infrastructure, the error domain must be a
# globally unique value that identifies the infrastructure. For Google API
# infrastructure, the error domain is &quot;googleapis.com&quot;.
&quot;metadatas&quot;: { # Additional structured details about this error.
#
# Keys must match a regular expression of `a-z+` but should
# ideally be lowerCamelCase. Also, they must be limited to 64 characters in
# length. When identifying the current value of an exceeded limit, the units
# should be contained in the key, not the value. For example, rather than
# `{&quot;instanceLimit&quot;: &quot;100/request&quot;}`, should be returned as,
# `{&quot;instanceLimitPerRequest&quot;: &quot;100&quot;}`, if the client exceeds the number of
# instances that can be created in a single (batch) request.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;reason&quot;: &quot;A String&quot;, # The reason of the error. This is a constant value that identifies the
# proximate cause of the error. Error reasons are unique within a particular
# domain of errors. This should be at most 63 characters and match a
# regular expression of `A-Z+[A-Z0-9]`, which represents
# UPPER_SNAKE_CASE.
},
&quot;help&quot;: { # Provides links to documentation or for performing an out of band action. # Links and information to help the user resolve the error.
#
# For example, if a quota check failed with an error indicating the calling
# project hasn&#x27;t enabled the accessed service, this can contain a URL pointing
# directly to the right place in the developer console to flip the bit.
&quot;links&quot;: [ # URL(s) pointing to additional information on handling the current error.
{ # Describes a URL link.
&quot;description&quot;: &quot;A String&quot;, # Describes what the link offers.
&quot;url&quot;: &quot;A String&quot;, # The URL of the link.
},
],
},
&quot;localizedMessage&quot;: { # Provides a localized error message that is safe to return to the user # A localized human-readable error message intended for end users.
# which can be attached to an RPC error.
&quot;locale&quot;: &quot;A String&quot;, # The locale used following the specification defined at
# https://www.rfc-editor.org/rfc/bcp/bcp47.txt.
# Examples are: &quot;en-US&quot;, &quot;fr-CH&quot;, &quot;es-MX&quot;
&quot;message&quot;: &quot;A String&quot;, # The localized error message in the above locale.
},
&quot;quotaInfo&quot;: { # Additional details for quota exceeded error for resource quota. # Details about quota limits and metrics when a quota is exceeded.
&quot;dimensions&quot;: { # The map holding related quota dimensions.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;futureLimit&quot;: 3.14, # Future quota limit being rolled out. The limit&#x27;s unit depends on the quota
# type or metric.
&quot;limit&quot;: 3.14, # Current effective quota limit. The limit&#x27;s unit depends on the quota type
# or metric.
&quot;limitName&quot;: &quot;A String&quot;, # The name of the quota limit.
&quot;metricName&quot;: &quot;A String&quot;, # The Compute Engine quota metric name.
&quot;rolloutStatus&quot;: &quot;A String&quot;, # Rollout status of the future quota limit.
},
},
],
&quot;location&quot;: &quot;A String&quot;, # [Output Only] Indicates the field in the request that caused the error.
# This property is optional.
&quot;message&quot;: &quot;A String&quot;, # [Output Only] An optional, human-readable error message.
},
],
},
&quot;firewallPolicyRuleOperationMetadata&quot;: { # Metadata for FirewallPolicyRule operations. # Output only. [Output Only] Metadata containing the allocated priority from the
# networkFirewallPolicies.addRule and regionNetworkFirewallPolicies.addRule
# methods if not explicitly provided by the user.
&quot;allocatedPriority&quot;: 42, # Output only. [Output Only] The priority allocated for the firewall policy rule if query
# parameters specified minPriority/maxPriority.
},
&quot;getHealthOperationMetadata&quot;: { # Metadata for GetHealth operations. # Output only. Metadata for GetHealth operations.
&quot;healthInfo&quot;: { # Health information. # Output only. The health information.
&quot;availabilitySloStatus&quot;: &quot;A String&quot;, # Output only. The availability SLO status.
&quot;healthStatus&quot;: &quot;A String&quot;, # Output only. The health status.
&quot;repairCategory&quot;: &quot;A String&quot;, # Output only. The repair category.
&quot;unhealthyReason&quot;: &quot;A String&quot;, # Output only. The reason for unhealthy status.
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when health info was updated.
},
},
&quot;getVersionOperationMetadata&quot;: {
&quot;inlineSbomInfo&quot;: {
&quot;currentComponentVersions&quot;: { # A mapping of components to their currently-applied versions or other
# appropriate identifiers.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;targetComponentVersions&quot;: { # A mapping of components to their target versions or other appropriate
# identifiers.
&quot;a_key&quot;: &quot;A String&quot;,
},
},
},
&quot;httpErrorMessage&quot;: &quot;A String&quot;, # [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
&quot;httpErrorStatusCode&quot;: 42, # [Output Only] If the operation fails, this field contains the HTTP error
# status code that was returned. For example, a `404` means the
# resource was not found.
&quot;id&quot;: &quot;A String&quot;, # [Output Only] The unique identifier for the operation. This identifier is
# defined by the server.
&quot;insertTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was requested.
# This value is inRFC3339
# text format.
&quot;instancesBulkInsertOperationMetadata&quot;: {
&quot;perLocationStatus&quot;: { # Status information per location (location name is key).
# Example key: zones/us-central1-a
&quot;a_key&quot;: {
&quot;createdVmCount&quot;: 42, # [Output Only] Count of VMs successfully created so far.
&quot;deletedVmCount&quot;: 42, # [Output Only] Count of VMs that got deleted during rollback.
&quot;failedToCreateVmCount&quot;: 42, # [Output Only] Count of VMs that started creating but encountered an
# error.
&quot;status&quot;: &quot;A String&quot;, # [Output Only] Creation status of BulkInsert operation - information
# if the flow is rolling forward or rolling back.
&quot;targetVmCount&quot;: 42, # [Output Only] Count of VMs originally planned to be created.
},
},
},
&quot;kind&quot;: &quot;compute#operation&quot;, # Output only. [Output Only] Type of the resource. Always `compute#operation` for
# Operation resources.
&quot;name&quot;: &quot;A String&quot;, # [Output Only] Name of the operation.
&quot;operationGroupId&quot;: &quot;A String&quot;, # Output only. [Output Only] An ID that represents a group of operations, such as when a
# group of operations results from a `bulkInsert` API request.
&quot;operationType&quot;: &quot;A String&quot;, # [Output Only] The type of operation, such as `insert`,
# `update`, or `delete`, and so on.
&quot;progress&quot;: 42, # [Output Only] An optional progress indicator that ranges from 0 to 100.
# There is no requirement that this be linear or support any granularity of
# operations. This should not be used to guess when the operation will be
# complete. This number should monotonically increase as the operation
# progresses.
&quot;region&quot;: &quot;A String&quot;, # [Output Only] The URL of the region where the operation resides. Only
# applicable when performing regional operations.
&quot;selfLink&quot;: &quot;A String&quot;, # [Output Only] Server-defined URL for the resource.
&quot;selfLinkWithId&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined URL for this resource with the resource id.
&quot;setCommonInstanceMetadataOperationMetadata&quot;: { # Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,
# this field will contain information on all underlying zonal actions and
# their state.
&quot;clientOperationId&quot;: &quot;A String&quot;, # [Output Only] The client operation id.
&quot;perLocationOperations&quot;: { # [Output Only] Status information per location (location name is key).
# Example key: zones/us-central1-a
&quot;a_key&quot;: {
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # [Output Only] If state is `ABANDONED` or `FAILED`, this field is
# populated.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
},
&quot;state&quot;: &quot;A String&quot;, # [Output Only] Status of the action, which can be one of the following:
# `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
},
},
},
&quot;startTime&quot;: &quot;A String&quot;, # [Output Only] The time that this operation was started by the server.
# This value is inRFC3339
# text format.
&quot;status&quot;: &quot;A String&quot;, # [Output Only] The status of the operation, which can be one of the
# following:
# `PENDING`, `RUNNING`, or `DONE`.
&quot;statusMessage&quot;: &quot;A String&quot;, # [Output Only] An optional textual description of the current status of the
# operation.
&quot;targetId&quot;: &quot;A String&quot;, # [Output Only] The unique target ID, which identifies a specific incarnation
# of the target resource.
&quot;targetLink&quot;: &quot;A String&quot;, # [Output Only] The URL of the resource that the operation modifies. For
# operations related to creating a snapshot, this points to the disk
# that the snapshot was created from.
&quot;user&quot;: &quot;A String&quot;, # [Output Only] User who requested the operation, for example:
# `user@example.com` or
# `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
&quot;warnings&quot;: [ # [Output Only] If warning messages are generated during processing of the
# operation, this field will be populated.
{
&quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
# Engine returns NO_RESULTS_ON_PAGE if there
# are no results in the response.
&quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
# value format. For example:
#
# &quot;data&quot;: [
# {
# &quot;key&quot;: &quot;scope&quot;,
# &quot;value&quot;: &quot;zones/us-east1-d&quot;
# }]
{
&quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
# returned. For example, for warnings where there are no results in a list
# request for a particular zone, this key might be scope and
# the key value might be the zone name. Other examples might be a key
# indicating a deprecated resource and a suggested replacement, or a
# warning about invalid network settings (for example, if an instance
# attempts to perform IP forwarding but is not enabled for IP forwarding).
&quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
},
],
&quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
},
],
&quot;zone&quot;: &quot;A String&quot;, # [Output Only] The URL of the zone where the operation resides. Only
# applicable when performing per-zone operations.
},
}</pre>
</div>
</body></html>