docs: update generated docs (#981)
diff --git a/docs/dyn/gameservices_v1.projects.locations.gameServerDeployments.html b/docs/dyn/gameservices_v1.projects.locations.gameServerDeployments.html
new file mode 100644
index 0000000..60b13fd
--- /dev/null
+++ b/docs/dyn/gameservices_v1.projects.locations.gameServerDeployments.html
@@ -0,0 +1,2065 @@
+<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="gameservices_v1.html">Game Services API</a> . <a href="gameservices_v1.projects.html">projects</a> . <a href="gameservices_v1.projects.locations.html">locations</a> . <a href="gameservices_v1.projects.locations.gameServerDeployments.html">gameServerDeployments</a></h1>
+<h2>Instance Methods</h2>
+<p class="toc_element">
+ <code><a href="gameservices_v1.projects.locations.gameServerDeployments.configs.html">configs()</a></code>
+</p>
+<p class="firstline">Returns the configs Resource.</p>
+
+<p class="toc_element">
+ <code><a href="#create">create(parent, body=None, deploymentId=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Creates a new game server deployment in a given project and location.</p>
+<p class="toc_element">
+ <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Deletes a single game server deployment.</p>
+<p class="toc_element">
+ <code><a href="#fetchDeploymentState">fetchDeploymentState(name, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Retrieves information about the current state of the game server</p>
+<p class="toc_element">
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets details of a single game server deployment.</p>
+<p class="toc_element">
+ <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets the access control policy for a resource.</p>
+<p class="toc_element">
+ <code><a href="#getRollout">getRollout(name, x__xgafv=None)</a></code></p>
+<p class="firstline">Gets details a single game server deployment rollout.</p>
+<p class="toc_element">
+ <code><a href="#list">list(parent, filter=None, orderBy=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists game server deployments in a given project and location.</p>
+<p class="toc_element">
+ <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
+<p class="firstline">Retrieves the next page of results.</p>
+<p class="toc_element">
+ <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Patches a game server deployment.</p>
+<p class="toc_element">
+ <code><a href="#previewRollout">previewRollout(name, body=None, updateMask=None, previewTime=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Previews the game server deployment rollout. This API does not mutate the</p>
+<p class="toc_element">
+ <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Sets the access control policy on the specified resource. Replaces any</p>
+<p class="toc_element">
+ <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
+<p class="toc_element">
+ <code><a href="#updateRollout">updateRollout(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Patches a single game server deployment rollout.</p>
+<h3>Method Details</h3>
+<div class="method">
+ <code class="details" id="create">create(parent, body=None, deploymentId=None, x__xgafv=None)</code>
+ <pre>Creates a new game server deployment in a given project and location.
+
+Args:
+ parent: string, Required. The parent resource name. Uses the form:
+`projects/{project}/locations/{location}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A game server deployment resource.
+ "description": "A String", # Human readable description of the game server delpoyment.
+ "name": "A String", # The resource name of the game server deployment. Uses the form:
+ #
+ # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.
+ # For example,
+ #
+ # `projects/my-project/locations/{location}/gameServerDeployments/my-deployment`.
+ "createTime": "A String", # Output only. The creation time.
+ "updateTime": "A String", # Output only. The last-modified time.
+ "etag": "A String", # ETag of the resource.
+ "labels": { # The labels associated with this game server deployment. Each label is a
+ # key-value pair.
+ "a_key": "A String",
+ },
+}
+
+ deploymentId: string, Required. The ID of the game server delpoyment resource to be created.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "message": "A String", # 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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="delete">delete(name, x__xgafv=None)</code>
+ <pre>Deletes a single game server deployment.
+
+Args:
+ name: string, Required. The name of the game server delpoyment to delete. Uses the form:
+
+`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "message": "A String", # 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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="fetchDeploymentState">fetchDeploymentState(name, body=None, x__xgafv=None)</code>
+ <pre>Retrieves information about the current state of the game server
+deployment. Gathers all the Agones fleets and Agones autoscalers,
+including fleets running an older version of the game server deployment.
+
+Args:
+ name: string, Required. The name of the game server delpoyment. Uses the form:
+
+`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for GameServerDeploymentsService.FetchDeploymentState.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for GameServerDeploymentsService.FetchDeploymentState.
+ "unavailable": [ # List of locations that could not be reached.
+ "A String",
+ ],
+ "clusterState": [ # The state of the game server deployment in each game server cluster.
+ { # The game server cluster changes made by the game server deployment.
+ "cluster": "A String", # The name of the cluster.
+ "fleetDetails": [ # The details about the Agones fleets and autoscalers created in the
+ # game server cluster.
+ { # Details of the deployed Agones fleet.
+ "deployedFleet": { # Agones fleet specification and details. # Information about the Agones fleet.
+ "fleet": "A String", # The name of the Agones fleet.
+ "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # The source spec that is used to create the Agones fleet.
+ # The GameServerConfig resource may no longer exist in the system.
+ "gameServerConfigName": "A String", # The game server config resource. Uses the form:
+ #
+ # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
+ "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
+ # the Agones fleet or Agones autoscaler spec.
+ },
+ "fleetSpec": "A String", # The fleet spec retrieved from the Agones fleet.
+ "status": { # DeployedFleetStatus has details about the Agones fleets such as how many # The current status of the Agones fleet.
+ # Includes count of game servers in various states.
+ # are running, how many allocated, and so on.
+ "readyReplicas": "A String", # The number of GameServer replicas in the READY state in this fleet.
+ "reservedReplicas": "A String", # The number of GameServer replicas in the RESERVED state in this fleet.
+ # Reserved instances won't be deleted on scale down, but won't cause
+ # an autoscaler to scale up.
+ "replicas": "A String", # The total number of current GameServer replicas in this fleet.
+ "allocatedReplicas": "A String", # The number of GameServer replicas in the ALLOCATED state in this fleet.
+ },
+ },
+ "deployedAutoscaler": { # Details about the Agones autoscaler. # Information about the Agones autoscaler for that fleet.
+ "autoscaler": "A String", # The name of the Agones autoscaler.
+ "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # The source spec that is used to create the autoscaler.
+ # The GameServerConfig resource may no longer exist in the system.
+ "gameServerConfigName": "A String", # The game server config resource. Uses the form:
+ #
+ # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
+ "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
+ # the Agones fleet or Agones autoscaler spec.
+ },
+ "fleetAutoscalerSpec": "A String", # The autoscaler spec retrieved from Agones.
+ },
+ },
+ ],
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
+ <pre>Gets details of a single game server deployment.
+
+Args:
+ name: string, Required. The name of the game server delpoyment to retrieve. Uses the form:
+
+`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A game server deployment resource.
+ "description": "A String", # Human readable description of the game server delpoyment.
+ "name": "A String", # The resource name of the game server deployment. Uses the form:
+ #
+ # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.
+ # For example,
+ #
+ # `projects/my-project/locations/{location}/gameServerDeployments/my-deployment`.
+ "createTime": "A String", # Output only. The creation time.
+ "updateTime": "A String", # Output only. The last-modified time.
+ "etag": "A String", # ETag of the resource.
+ "labels": { # The labels associated with this game server deployment. Each label is a
+ # key-value pair.
+ "a_key": "A String",
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
+ <pre>Gets the access control policy for a resource.
+Returns an empty policy if the resource exists and does not have a policy
+set.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested.
+See the operation documentation for the appropriate value for this field. (required)
+ options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.
+
+Valid values are 0, 1, and 3. Requests specifying an invalid value will be
+rejected.
+
+Requests for policies with any conditional bindings must specify version 3.
+Policies without any conditional bindings may specify any valid value or
+leave the field unset.
+
+To learn which resources support conditions in their IAM policies, see the
+[IAM
+documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access
+ # controls for Google Cloud resources.
+ #
+ #
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members` to a single `role`. Members can be user accounts, service accounts,
+ # Google groups, and domains (such as G Suite). A `role` is a named list of
+ # permissions; each `role` can be an IAM predefined role or a user-created
+ # custom role.
+ #
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # **JSON example:**
+ #
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # ]
+ # },
+ # {
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
+ # }
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
+ # }
+ #
+ # **YAML example:**
+ #
+ # bindings:
+ # - members:
+ # - user:mike@example.com
+ # - group:admins@example.com
+ # - domain:google.com
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
+ # - members:
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # - etag: BwWWja0YfJA=
+ # - version: 3
+ #
+ # For a description of IAM and its features, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "rules": [ # If more than one rule is specified, the rules are applied in the following
+ # manner:
+ # - All matching LOG rules are always applied.
+ # - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
+ # Logging will be applied if one or more matching rule requires logging.
+ # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
+ # granted.
+ # Logging will be applied if one or more matching rule requires logging.
+ # - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'
+ # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
+ # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches
+ # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ # The format for in and not_in entries can be found at in the Local IAM
+ # documentation (see go/local-iam#features).
+ "A String",
+ ],
+ "in": [ # If one or more 'in' clauses are specified, the rule matches if
+ # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met. All conditions must pass for the
+ # rule to match.
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
+ # the IAM system for access control.
+ "values": [ # The objects of the condition.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "action": "A String", # Required
+ "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
+ # that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "dataAccess": { # Write a Data Access (Gin) log # Data access options.
+ "logMode": "A String",
+ },
+ "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.
+ #
+ # Metric names should start with a '/', generally be lowercase-only,
+ # and end in "_count". Field names should not contain an initial slash.
+ # The actual exported metric names will have "/iam/policy" prepended.
+ #
+ # Field names correspond to IAM request parameters and field values are
+ # their respective values.
+ #
+ # Supported field names:
+ # - "authority", which is "[token]" if IAMContext.token is present,
+ # otherwise the value of IAMContext.authority_selector if present, and
+ # otherwise a representation of IAMContext.principal; or
+ # - "iam_principal", a representation of IAMContext.principal even if a
+ # token or authority selector is present; or
+ # - "" (empty string), resulting in a counter with no fields.
+ #
+ # Examples:
+ # counter { metric: "/debug_access_count" field: "iam_principal" }
+ # ==> increment counter /iam/policy/debug_access_count
+ # {iam_principal=[value of IAMContext.principal]}
+ "customFields": [ # Custom fields.
+ { # Custom fields.
+ # These can be used to create a counter with arbitrary field/value
+ # pairs.
+ # See: go/rpcsp-custom-fields.
+ "name": "A String", # Name is the field name.
+ "value": "A String", # Value is the field value. It is important that in contrast to the
+ # CounterOptions.field, the value here is a constant that is not
+ # derived from the IAMContext.
+ },
+ ],
+ "metric": "A String", # The metric to update.
+ "field": "A String", # The field value to attribute.
+ },
+ "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
+ "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
+ "permissionType": "A String", # The type of the permission that was checked.
+ },
+ "logName": "A String", # The log_name to populate in the Cloud Audit Record.
+ },
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # },
+ # {
+ # "log_type": "ADMIN_READ"
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ"
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts jose@example.com from DATA_READ logging, and
+ # aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ "ignoreChildExemptions": True or False,
+ },
+ ],
+ "exemptedMembers": [
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ # `condition` that determines how and when the `bindings` are applied. Each
+ # of the `bindings` must contain at least one member.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service
+ # account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ "A String",
+ ],
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ },
+ },
+ ],
+ "iamOwned": True or False,
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="getRollout">getRollout(name, x__xgafv=None)</code>
+ <pre>Gets details a single game server deployment rollout.
+
+Args:
+ name: string, Required. The name of the game server delpoyment to retrieve. Uses the form:
+
+`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The game server deployment rollout which represents the desired rollout
+ # state.
+ "defaultGameServerConfig": "A String", # The default game server config is applied to all realms unless overridden
+ # in the rollout. For example,
+ #
+ # `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`.
+ "name": "A String", # The resource name of the game server deployment rollout. Uses the form:
+ #
+ # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.
+ # For example,
+ #
+ # `projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`.
+ "updateTime": "A String", # Output only. The last-modified time.
+ "gameServerConfigOverrides": [ # Contains the game server config rollout overrides. Overrides are processed
+ # in the order they are listed. Once a match is found for a realm, the rest
+ # of the list is not processed.
+ { # A game server config override.
+ "realmsSelector": { # The realm selector, used to match realm resources. # Selector for choosing applicable realms.
+ "realms": [ # List of realms to match.
+ "A String",
+ ],
+ },
+ "configVersion": "A String", # The game server config for this override.
+ },
+ ],
+ "createTime": "A String", # Output only. The creation time.
+ "etag": "A String", # ETag of the resource.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list">list(parent, filter=None, orderBy=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <pre>Lists game server deployments in a given project and location.
+
+Args:
+ parent: string, Required. The parent resource name. Uses the form:
+`projects/{project}/locations/{location}`. (required)
+ filter: string, Optional. The filter to apply to list results.
+ orderBy: string, Optional. Specifies the ordering of results following syntax at
+https://cloud.google.com/apis/design/design_patterns#sorting_order.
+ pageToken: string, Optional. The next_page_token value returned from a previous List request,
+if any.
+ pageSize: integer, Optional. The maximum number of items to return. If unspecified, the server
+will pick an appropriate default. The server may return fewer items than
+requested. A caller should only rely on response's
+next_page_token to
+determine if there are more GameServerDeployments left to be queried.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for GameServerDeploymentsService.ListGameServerDeployments.
+ "unreachable": [ # List of locations that could not be reached.
+ "A String",
+ ],
+ "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more
+ # results in the list.
+ "gameServerDeployments": [ # The list of game server deployments.
+ { # A game server deployment resource.
+ "description": "A String", # Human readable description of the game server delpoyment.
+ "name": "A String", # The resource name of the game server deployment. Uses the form:
+ #
+ # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.
+ # For example,
+ #
+ # `projects/my-project/locations/{location}/gameServerDeployments/my-deployment`.
+ "createTime": "A String", # Output only. The creation time.
+ "updateTime": "A String", # Output only. The last-modified time.
+ "etag": "A String", # ETag of the resource.
+ "labels": { # The labels associated with this game server deployment. Each label is a
+ # key-value pair.
+ "a_key": "A String",
+ },
+ },
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
+ <pre>Retrieves the next page of results.
+
+Args:
+ previous_request: The request for the previous page. (required)
+ previous_response: The response from the request for the previous page. (required)
+
+Returns:
+ A request object that you can call 'execute()' on to request the next
+ page. Returns None if there are no more items in the collection.
+ </pre>
+</div>
+
+<div class="method">
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
+ <pre>Patches a game server deployment.
+
+Args:
+ name: string, The resource name of the game server deployment. Uses the form:
+
+`projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.
+For example,
+
+`projects/my-project/locations/{location}/gameServerDeployments/my-deployment`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A game server deployment resource.
+ "description": "A String", # Human readable description of the game server delpoyment.
+ "name": "A String", # The resource name of the game server deployment. Uses the form:
+ #
+ # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.
+ # For example,
+ #
+ # `projects/my-project/locations/{location}/gameServerDeployments/my-deployment`.
+ "createTime": "A String", # Output only. The creation time.
+ "updateTime": "A String", # Output only. The last-modified time.
+ "etag": "A String", # ETag of the resource.
+ "labels": { # The labels associated with this game server deployment. Each label is a
+ # key-value pair.
+ "a_key": "A String",
+ },
+}
+
+ updateMask: string, Required. Mask of fields to update. At least one path must be supplied in
+this field. For the `FieldMask` definition, see
+
+https:
+//developers.google.com/protocol-buffers
+// /docs/reference/google.protobuf#fieldmask
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "message": "A String", # 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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="previewRollout">previewRollout(name, body=None, updateMask=None, previewTime=None, x__xgafv=None)</code>
+ <pre>Previews the game server deployment rollout. This API does not mutate the
+rollout resource.
+
+Args:
+ name: string, The resource name of the game server deployment rollout. Uses the form:
+
+`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.
+For example,
+
+`projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The game server deployment rollout which represents the desired rollout
+ # state.
+ "defaultGameServerConfig": "A String", # The default game server config is applied to all realms unless overridden
+ # in the rollout. For example,
+ #
+ # `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`.
+ "name": "A String", # The resource name of the game server deployment rollout. Uses the form:
+ #
+ # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.
+ # For example,
+ #
+ # `projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`.
+ "updateTime": "A String", # Output only. The last-modified time.
+ "gameServerConfigOverrides": [ # Contains the game server config rollout overrides. Overrides are processed
+ # in the order they are listed. Once a match is found for a realm, the rest
+ # of the list is not processed.
+ { # A game server config override.
+ "realmsSelector": { # The realm selector, used to match realm resources. # Selector for choosing applicable realms.
+ "realms": [ # List of realms to match.
+ "A String",
+ ],
+ },
+ "configVersion": "A String", # The game server config for this override.
+ },
+ ],
+ "createTime": "A String", # Output only. The creation time.
+ "etag": "A String", # ETag of the resource.
+ }
+
+ updateMask: string, Optional. Mask of fields to update. At least one path must be supplied in
+this field. For the `FieldMask` definition, see
+
+https:
+//developers.google.com/protocol-buffers
+// /docs/reference/google.protobuf#fieldmask
+ previewTime: string, Optional. The target timestamp to compute the preview. Defaults to the immediately
+after the proposed rollout completes.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for PreviewGameServerDeploymentRollout.
+ # This has details about the Agones fleet and autoscaler to be actuated.
+ "targetState": { # Encapsulates the Target state. # The target state.
+ "details": [ # Details about Agones fleets.
+ { # Details about the Agones resources.
+ "gameServerDeploymentName": "A String", # The game server deployment name. Uses the form:
+ #
+ # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
+ "gameServerClusterName": "A String", # The game server cluster name. Uses the form:
+ #
+ # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
+ "fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.
+ { # Details of the target Agones fleet.
+ "autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
+ "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
+ # Details about the Agones autoscaler spec.
+ "gameServerConfigName": "A String", # The game server config resource. Uses the form:
+ #
+ # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
+ "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
+ # the Agones fleet or Agones autoscaler spec.
+ },
+ "name": "A String", # The name of the Agones autoscaler.
+ },
+ "fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.
+ "name": "A String", # The name of the Agones fleet.
+ "specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
+ # The Agones fleet spec source.
+ "gameServerConfigName": "A String", # The game server config resource. Uses the form:
+ #
+ # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
+ "name": "A String", # The name of the Agones leet config or Agones scaling config used to derive
+ # the Agones fleet or Agones autoscaler spec.
+ },
+ },
+ },
+ ],
+ },
+ ],
+ },
+ "unavailable": [ # Locations that could not be reached on this request.
+ "A String",
+ ],
+ "etag": "A String", # ETag of the game server deployment.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
+ <pre>Sets the access control policy on the specified resource. Replaces any
+existing policy.
+
+Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being specified.
+See the operation documentation for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `SetIamPolicy` method.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
+ # the policy is limited to a few 10s of KB. An empty policy is a
+ # valid policy but certain Cloud Platform services (such as Projects)
+ # might reject them.
+ # controls for Google Cloud resources.
+ #
+ #
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members` to a single `role`. Members can be user accounts, service accounts,
+ # Google groups, and domains (such as G Suite). A `role` is a named list of
+ # permissions; each `role` can be an IAM predefined role or a user-created
+ # custom role.
+ #
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # **JSON example:**
+ #
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # ]
+ # },
+ # {
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
+ # }
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
+ # }
+ #
+ # **YAML example:**
+ #
+ # bindings:
+ # - members:
+ # - user:mike@example.com
+ # - group:admins@example.com
+ # - domain:google.com
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
+ # - members:
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # - etag: BwWWja0YfJA=
+ # - version: 3
+ #
+ # For a description of IAM and its features, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "rules": [ # If more than one rule is specified, the rules are applied in the following
+ # manner:
+ # - All matching LOG rules are always applied.
+ # - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
+ # Logging will be applied if one or more matching rule requires logging.
+ # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
+ # granted.
+ # Logging will be applied if one or more matching rule requires logging.
+ # - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'
+ # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
+ # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches
+ # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ # The format for in and not_in entries can be found at in the Local IAM
+ # documentation (see go/local-iam#features).
+ "A String",
+ ],
+ "in": [ # If one or more 'in' clauses are specified, the rule matches if
+ # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met. All conditions must pass for the
+ # rule to match.
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
+ # the IAM system for access control.
+ "values": [ # The objects of the condition.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "action": "A String", # Required
+ "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
+ # that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "dataAccess": { # Write a Data Access (Gin) log # Data access options.
+ "logMode": "A String",
+ },
+ "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.
+ #
+ # Metric names should start with a '/', generally be lowercase-only,
+ # and end in "_count". Field names should not contain an initial slash.
+ # The actual exported metric names will have "/iam/policy" prepended.
+ #
+ # Field names correspond to IAM request parameters and field values are
+ # their respective values.
+ #
+ # Supported field names:
+ # - "authority", which is "[token]" if IAMContext.token is present,
+ # otherwise the value of IAMContext.authority_selector if present, and
+ # otherwise a representation of IAMContext.principal; or
+ # - "iam_principal", a representation of IAMContext.principal even if a
+ # token or authority selector is present; or
+ # - "" (empty string), resulting in a counter with no fields.
+ #
+ # Examples:
+ # counter { metric: "/debug_access_count" field: "iam_principal" }
+ # ==> increment counter /iam/policy/debug_access_count
+ # {iam_principal=[value of IAMContext.principal]}
+ "customFields": [ # Custom fields.
+ { # Custom fields.
+ # These can be used to create a counter with arbitrary field/value
+ # pairs.
+ # See: go/rpcsp-custom-fields.
+ "name": "A String", # Name is the field name.
+ "value": "A String", # Value is the field value. It is important that in contrast to the
+ # CounterOptions.field, the value here is a constant that is not
+ # derived from the IAMContext.
+ },
+ ],
+ "metric": "A String", # The metric to update.
+ "field": "A String", # The field value to attribute.
+ },
+ "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
+ "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
+ "permissionType": "A String", # The type of the permission that was checked.
+ },
+ "logName": "A String", # The log_name to populate in the Cloud Audit Record.
+ },
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # },
+ # {
+ # "log_type": "ADMIN_READ"
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ"
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts jose@example.com from DATA_READ logging, and
+ # aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ "ignoreChildExemptions": True or False,
+ },
+ ],
+ "exemptedMembers": [
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ # `condition` that determines how and when the `bindings` are applied. Each
+ # of the `bindings` must contain at least one member.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service
+ # account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ "A String",
+ ],
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ },
+ },
+ ],
+ "iamOwned": True or False,
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ },
+ "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
+ # the fields in the mask will be modified. If no mask is provided, the
+ # following default mask is used:
+ #
+ # `paths: "bindings, etag"`
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access
+ # controls for Google Cloud resources.
+ #
+ #
+ # A `Policy` is a collection of `bindings`. A `binding` binds one or more
+ # `members` to a single `role`. Members can be user accounts, service accounts,
+ # Google groups, and domains (such as G Suite). A `role` is a named list of
+ # permissions; each `role` can be an IAM predefined role or a user-created
+ # custom role.
+ #
+ # For some types of Google Cloud resources, a `binding` can also specify a
+ # `condition`, which is a logical expression that allows access to a resource
+ # only if the expression evaluates to `true`. A condition can add constraints
+ # based on attributes of the request, the resource, or both. To learn which
+ # resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ #
+ # **JSON example:**
+ #
+ # {
+ # "bindings": [
+ # {
+ # "role": "roles/resourcemanager.organizationAdmin",
+ # "members": [
+ # "user:mike@example.com",
+ # "group:admins@example.com",
+ # "domain:google.com",
+ # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
+ # ]
+ # },
+ # {
+ # "role": "roles/resourcemanager.organizationViewer",
+ # "members": [
+ # "user:eve@example.com"
+ # ],
+ # "condition": {
+ # "title": "expirable access",
+ # "description": "Does not grant access after Sep 2020",
+ # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",
+ # }
+ # }
+ # ],
+ # "etag": "BwWWja0YfJA=",
+ # "version": 3
+ # }
+ #
+ # **YAML example:**
+ #
+ # bindings:
+ # - members:
+ # - user:mike@example.com
+ # - group:admins@example.com
+ # - domain:google.com
+ # - serviceAccount:my-project-id@appspot.gserviceaccount.com
+ # role: roles/resourcemanager.organizationAdmin
+ # - members:
+ # - user:eve@example.com
+ # role: roles/resourcemanager.organizationViewer
+ # condition:
+ # title: expirable access
+ # description: Does not grant access after Sep 2020
+ # expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
+ # - etag: BwWWja0YfJA=
+ # - version: 3
+ #
+ # For a description of IAM and its features, see the
+ # [IAM documentation](https://cloud.google.com/iam/docs/).
+ "rules": [ # If more than one rule is specified, the rules are applied in the following
+ # manner:
+ # - All matching LOG rules are always applied.
+ # - If any DENY/DENY_WITH_LOG rule matches, permission is denied.
+ # Logging will be applied if one or more matching rule requires logging.
+ # - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is
+ # granted.
+ # Logging will be applied if one or more matching rule requires logging.
+ # - Otherwise, if no rule applies, permission is denied.
+ { # A rule to be applied in a Policy.
+ "permissions": [ # A permission is a string of form '<service>.<resource type>.<verb>'
+ # (e.g., 'storage.buckets.list'). A value of '*' matches all permissions,
+ # and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
+ "A String",
+ ],
+ "notIn": [ # If one or more 'not_in' clauses are specified, the rule matches
+ # if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
+ # The format for in and not_in entries can be found at in the Local IAM
+ # documentation (see go/local-iam#features).
+ "A String",
+ ],
+ "in": [ # If one or more 'in' clauses are specified, the rule matches if
+ # the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
+ "A String",
+ ],
+ "conditions": [ # Additional restrictions that must be met. All conditions must pass for the
+ # rule to match.
+ { # A condition to be met.
+ "iam": "A String", # Trusted attributes supplied by the IAM system.
+ "svc": "A String", # Trusted attributes discharged by the service.
+ "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
+ # the IAM system for access control.
+ "values": [ # The objects of the condition.
+ "A String",
+ ],
+ "op": "A String", # An operator to apply the subject with.
+ },
+ ],
+ "action": "A String", # Required
+ "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
+ # that match the LOG action.
+ { # Specifies what kind of log the caller must write
+ "dataAccess": { # Write a Data Access (Gin) log # Data access options.
+ "logMode": "A String",
+ },
+ "counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.
+ #
+ # Metric names should start with a '/', generally be lowercase-only,
+ # and end in "_count". Field names should not contain an initial slash.
+ # The actual exported metric names will have "/iam/policy" prepended.
+ #
+ # Field names correspond to IAM request parameters and field values are
+ # their respective values.
+ #
+ # Supported field names:
+ # - "authority", which is "[token]" if IAMContext.token is present,
+ # otherwise the value of IAMContext.authority_selector if present, and
+ # otherwise a representation of IAMContext.principal; or
+ # - "iam_principal", a representation of IAMContext.principal even if a
+ # token or authority selector is present; or
+ # - "" (empty string), resulting in a counter with no fields.
+ #
+ # Examples:
+ # counter { metric: "/debug_access_count" field: "iam_principal" }
+ # ==> increment counter /iam/policy/debug_access_count
+ # {iam_principal=[value of IAMContext.principal]}
+ "customFields": [ # Custom fields.
+ { # Custom fields.
+ # These can be used to create a counter with arbitrary field/value
+ # pairs.
+ # See: go/rpcsp-custom-fields.
+ "name": "A String", # Name is the field name.
+ "value": "A String", # Value is the field value. It is important that in contrast to the
+ # CounterOptions.field, the value here is a constant that is not
+ # derived from the IAMContext.
+ },
+ ],
+ "metric": "A String", # The metric to update.
+ "field": "A String", # The field value to attribute.
+ },
+ "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
+ "authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
+ "permissionType": "A String", # The type of the permission that was checked.
+ },
+ "logName": "A String", # The log_name to populate in the Cloud Audit Record.
+ },
+ },
+ ],
+ "description": "A String", # Human-readable description of the rule.
+ },
+ ],
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service.
+ # The configuration determines which permission types are logged, and what
+ # identities, if any, are exempted from logging.
+ # An AuditConfig must have one or more AuditLogConfigs.
+ #
+ # If there are AuditConfigs for both `allServices` and a specific service,
+ # the union of the two AuditConfigs is used for that service: the log_types
+ # specified in each AuditConfig are enabled, and the exempted_members in each
+ # AuditLogConfig are exempted.
+ #
+ # Example Policy with multiple AuditConfigs:
+ #
+ # {
+ # "audit_configs": [
+ # {
+ # "service": "allServices",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # },
+ # {
+ # "log_type": "ADMIN_READ"
+ # }
+ # ]
+ # },
+ # {
+ # "service": "sampleservice.googleapis.com",
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ"
+ # },
+ # {
+ # "log_type": "DATA_WRITE",
+ # "exempted_members": [
+ # "user:aliya@example.com"
+ # ]
+ # }
+ # ]
+ # }
+ # ]
+ # }
+ #
+ # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
+ # logging. It also exempts jose@example.com from DATA_READ logging, and
+ # aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions.
+ # Example:
+ #
+ # {
+ # "audit_log_configs": [
+ # {
+ # "log_type": "DATA_READ",
+ # "exempted_members": [
+ # "user:jose@example.com"
+ # ]
+ # },
+ # {
+ # "log_type": "DATA_WRITE"
+ # }
+ # ]
+ # }
+ #
+ # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
+ # jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
+ # permission.
+ # Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ "ignoreChildExemptions": True or False,
+ },
+ ],
+ "exemptedMembers": [
+ "A String",
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging.
+ # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
+ # `allServices` is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
+ # `condition` that determines how and when the `bindings` are applied. Each
+ # of the `bindings` must contain at least one member.
+ { # Associates `members` with a `role`.
+ "role": "A String", # Role that is assigned to `members`.
+ # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
+ "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
+ # `members` can have the following values:
+ #
+ # * `allUsers`: A special identifier that represents anyone who is
+ # on the internet; with or without a Google account.
+ #
+ # * `allAuthenticatedUsers`: A special identifier that represents anyone
+ # who is authenticated with a Google account or a service account.
+ #
+ # * `user:{emailid}`: An email address that represents a specific Google
+ # account. For example, `alice@example.com` .
+ #
+ #
+ # * `serviceAccount:{emailid}`: An email address that represents a service
+ # account. For example, `my-other-app@appspot.gserviceaccount.com`.
+ #
+ # * `group:{emailid}`: An email address that represents a Google group.
+ # For example, `admins@example.com`.
+ #
+ # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a user that has been recently deleted. For
+ # example, `alice@example.com?uid=123456789012345678901`. If the user is
+ # recovered, this value reverts to `user:{emailid}` and the recovered user
+ # retains the role in the binding.
+ #
+ # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
+ # unique identifier) representing a service account that has been recently
+ # deleted. For example,
+ # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
+ # If the service account is undeleted, this value reverts to
+ # `serviceAccount:{emailid}` and the undeleted service account retains the
+ # role in the binding.
+ #
+ # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
+ # identifier) representing a Google group that has been recently
+ # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
+ # the group is recovered, this value reverts to `group:{emailid}` and the
+ # recovered group retains the role in the binding.
+ #
+ #
+ # * `domain:{domain}`: The G Suite domain (primary) that represents all the
+ # users of that domain. For example, `google.com` or `example.com`.
+ #
+ "A String",
+ ],
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
+ #
+ # If the condition evaluates to `true`, then this binding applies to the
+ # current request.
+ #
+ # If the condition evaluates to `false`, then this binding does not apply to
+ # the current request. However, a different role binding might grant the same
+ # role to one or more of the members in this binding.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM
+ # documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+ # are documented at https://github.com/google/cel-spec.
+ #
+ # Example (Comparison):
+ #
+ # title: "Summary size limit"
+ # description: "Determines if a summary is less than 100 chars"
+ # expression: "document.summary.size() < 100"
+ #
+ # Example (Equality):
+ #
+ # title: "Requestor is owner"
+ # description: "Determines if requestor is the document owner"
+ # expression: "document.owner == request.auth.claims.email"
+ #
+ # Example (Logic):
+ #
+ # title: "Public documents"
+ # description: "Determine whether the document should be publicly visible"
+ # expression: "document.type != 'private' && document.type != 'internal'"
+ #
+ # Example (Data Manipulation):
+ #
+ # title: "Notification string"
+ # description: "Create a notification string with a timestamp."
+ # expression: "'New message received at ' + string(document.create_time)"
+ #
+ # The exact variables and functions that may be referenced within an expression
+ # are determined by the service that evaluates it. See the service
+ # documentation for additional information.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing
+ # its purpose. This can be used e.g. in UIs which allow to enter the
+ # expression.
+ "location": "A String", # Optional. String indicating the location of the expression for error
+ # reporting, e.g. a file name and a position in the file.
+ "description": "A String", # Optional. Description of the expression. This is a longer text which
+ # describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language
+ # syntax.
+ },
+ },
+ ],
+ "iamOwned": True or False,
+ "version": 42, # Specifies the format of the policy.
+ #
+ # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
+ # are rejected.
+ #
+ # Any operation that affects conditional role bindings must specify version
+ # `3`. This requirement applies to the following operations:
+ #
+ # * Getting a policy that includes a conditional role binding
+ # * Adding a conditional role binding to a policy
+ # * Changing a conditional role binding in a policy
+ # * Removing any role binding, with or without a condition, from a policy
+ # that includes conditions
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ #
+ # If a policy does not include any conditions, operations on that policy may
+ # specify any valid version or leave the field unset.
+ #
+ # To learn which resources support conditions in their IAM policies, see the
+ # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
+ "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
+ # prevent simultaneous updates of a policy from overwriting each other.
+ # It is strongly suggested that systems make use of the `etag` in the
+ # read-modify-write cycle to perform policy updates in order to avoid race
+ # conditions: An `etag` is returned in the response to `getIamPolicy`, and
+ # systems are expected to put that etag in the request to `setIamPolicy` to
+ # ensure that their change will be applied to the same version of the policy.
+ #
+ # **Important:** If you use IAM Conditions, you must include the `etag` field
+ # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
+ # you to overwrite a version `3` policy with a version `1` policy, and all of
+ # the conditions in the version `3` policy are lost.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
+ <pre>Returns permissions that a caller has on the specified resource.
+If the resource does not exist, this will return an empty set of
+permissions, not a `NOT_FOUND` error.
+
+Note: This operation is designed to be used for building permission-aware
+UIs and command-line tools, not for authorization checking. This operation
+may "fail open" without warning.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy detail is being requested.
+See the operation documentation for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+ "permissions": [ # The set of permissions to check for the `resource`. Permissions with
+ # wildcards (such as '*' or 'storage.*') are not allowed. For more
+ # information see
+ # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
+ "A String",
+ ],
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for `TestIamPermissions` method.
+ "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
+ # allowed.
+ "A String",
+ ],
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="updateRollout">updateRollout(name, body=None, updateMask=None, x__xgafv=None)</code>
+ <pre>Patches a single game server deployment rollout.
+The method will not return an error if the update does not affect any
+existing realms. For example - if the default_game_server_config is changed
+but all existing realms use the override, that is valid. Similarly, if a
+non existing realm is explicitly called out in game_server_config_overrides
+field, that will also not result in an error.
+
+Args:
+ name: string, The resource name of the game server deployment rollout. Uses the form:
+
+`projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.
+For example,
+
+`projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The game server deployment rollout which represents the desired rollout
+ # state.
+ "defaultGameServerConfig": "A String", # The default game server config is applied to all realms unless overridden
+ # in the rollout. For example,
+ #
+ # `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`.
+ "name": "A String", # The resource name of the game server deployment rollout. Uses the form:
+ #
+ # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.
+ # For example,
+ #
+ # `projects/my-project/locations/{location}/gameServerDeployments/my-deployment/rollout`.
+ "updateTime": "A String", # Output only. The last-modified time.
+ "gameServerConfigOverrides": [ # Contains the game server config rollout overrides. Overrides are processed
+ # in the order they are listed. Once a match is found for a realm, the rest
+ # of the list is not processed.
+ { # A game server config override.
+ "realmsSelector": { # The realm selector, used to match realm resources. # Selector for choosing applicable realms.
+ "realms": [ # List of realms to match.
+ "A String",
+ ],
+ },
+ "configVersion": "A String", # The game server config for this override.
+ },
+ ],
+ "createTime": "A String", # Output only. The creation time.
+ "etag": "A String", # ETag of the resource.
+ }
+
+ updateMask: string, Required. Mask of fields to update. At least one path must be supplied in
+this field. For the `FieldMask` definition, see
+
+https:
+//developers.google.com/protocol-buffers
+// /docs/reference/google.protobuf#fieldmask
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a
+ # network API call.
+ "name": "A String", # The server-assigned name, which is only unique within the same service that
+ # originally returns it. If you use the default HTTP mapping, the
+ # `name` should be a resource name ending with `operations/{unique_id}`.
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
+ # 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).
+ "message": "A String", # 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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of
+ # message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If `true`, the operation is completed, and either `error` or `response` is
+ # available.
+ "response": { # The normal response of the operation in case of success. If the original
+ # method returns no data on success, such as `Delete`, the response is
+ # `google.protobuf.Empty`. If the original method is standard
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ }</pre>
+</div>
+
+</body></html>
\ No newline at end of file