1628 lines
79 KiB
HTML
1628 lines
79 KiB
HTML
<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="datafusion_v1beta1.html">Cloud Data Fusion API</a> . <a href="datafusion_v1beta1.projects.html">projects</a> . <a href="datafusion_v1beta1.projects.locations.html">locations</a> . <a href="datafusion_v1beta1.projects.locations.instances.html">instances</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="#create">create(parent, body, instanceId=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Creates a new Data Fusion instance in the specified 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 Date Fusion instance.</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 Data Fusion instance.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#getIamPolicy">getIamPolicy(resource, 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="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
|
|
<p class="firstline">Lists Data Fusion instances in the specified 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, updateMask=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Updates a single Data Fusion instance.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#restart">restart(name, body=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Restart a single Data Fusion instance.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#setIamPolicy">setIamPolicy(resource, body, 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, 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="#upgrade">upgrade(name, body=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Upgrade a single Data Fusion instance.</p>
|
|
<h3>Method Details</h3>
|
|
<div class="method">
|
|
<code class="details" id="create">create(parent, body, instanceId=None, x__xgafv=None)</code>
|
|
<pre>Creates a new Data Fusion instance in the specified project and location.
|
|
|
|
Args:
|
|
parent: string, The instance's project and location in the format
|
|
projects/{project}/locations/{location}. (required)
|
|
body: object, The request body. (required)
|
|
The object takes the form of:
|
|
|
|
{ # Represents a Data Fusion instance.
|
|
"updateTime": "A String", # Output only. The time the instance was last updated.
|
|
"displayName": "A String", # Display name for an instance.
|
|
"description": "A String", # An optional description of this instance.
|
|
"zone": "A String", # Name of the zone in which the Data Fusion instance will be created.
|
|
"privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to
|
|
# true, all Data Fusion nodes will have private IP addresses and will not be
|
|
# able to access the public internet.
|
|
"enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring.
|
|
"options": { # Map of additional options used to configure the behavior of
|
|
# Data Fusion instance.
|
|
"a_key": "A String",
|
|
},
|
|
"labels": { # The resource labels for instance to use to annotate any related underlying
|
|
# resources such as GCE VMs. The character '=' is not allowed to be used
|
|
# within the labels.
|
|
"a_key": "A String",
|
|
},
|
|
"enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging.
|
|
"networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data
|
|
# Fusion instance is to be created.
|
|
# are used for peering with the customer network. Configurations are optional
|
|
# when a public Data Fusion instance is to be created. However, providing
|
|
# these configurations allows several benefits, such as reduced network latency
|
|
# while accessing the customer resources from managed Data Fusion instance
|
|
# nodes, as well as access to the customer on-prem resources.
|
|
"network": "A String", # Name of the network in the customer project with which the Tenant Project
|
|
# will be peered for executing pipelines.
|
|
"ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance
|
|
# nodes. This range must not overlap with any other ranges used in the Data
|
|
# Fusion instance network.
|
|
},
|
|
"serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI and REST APIs are
|
|
# accessible.
|
|
"stateMessage": "A String", # Output only. Additional information about the current state of this Data
|
|
# Fusion instance if available.
|
|
"state": "A String", # Output only. The current state of this Data Fusion instance.
|
|
"version": "A String", # Output only. Current version of the Data Fusion.
|
|
"type": "A String", # Required. Instance type.
|
|
"createTime": "A String", # Output only. The time the instance was created.
|
|
"serviceAccount": "A String", # Output only. Service account which will be used to access resources in
|
|
# the customer project."
|
|
"name": "A String", # Output only. The name of this instance is in the form of
|
|
# projects/{project}/locations/{location}/instances/{instance}.
|
|
}
|
|
|
|
instanceId: string, The name of the instance to create.
|
|
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.
|
|
"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.
|
|
},
|
|
"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}`.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
|
|
<pre>Deletes a single Date Fusion instance.
|
|
|
|
Args:
|
|
name: string, The instance resource name in the format
|
|
projects/{project}/locations/{location}/instances/{instance} (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.
|
|
"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.
|
|
},
|
|
"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}`.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="get">get(name, x__xgafv=None)</code>
|
|
<pre>Gets details of a single Data Fusion instance.
|
|
|
|
Args:
|
|
name: string, The instance resource name in the format
|
|
projects/{project}/locations/{location}/instances/{instance}. (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Represents a Data Fusion instance.
|
|
"updateTime": "A String", # Output only. The time the instance was last updated.
|
|
"displayName": "A String", # Display name for an instance.
|
|
"description": "A String", # An optional description of this instance.
|
|
"zone": "A String", # Name of the zone in which the Data Fusion instance will be created.
|
|
"privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to
|
|
# true, all Data Fusion nodes will have private IP addresses and will not be
|
|
# able to access the public internet.
|
|
"enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring.
|
|
"options": { # Map of additional options used to configure the behavior of
|
|
# Data Fusion instance.
|
|
"a_key": "A String",
|
|
},
|
|
"labels": { # The resource labels for instance to use to annotate any related underlying
|
|
# resources such as GCE VMs. The character '=' is not allowed to be used
|
|
# within the labels.
|
|
"a_key": "A String",
|
|
},
|
|
"enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging.
|
|
"networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data
|
|
# Fusion instance is to be created.
|
|
# are used for peering with the customer network. Configurations are optional
|
|
# when a public Data Fusion instance is to be created. However, providing
|
|
# these configurations allows several benefits, such as reduced network latency
|
|
# while accessing the customer resources from managed Data Fusion instance
|
|
# nodes, as well as access to the customer on-prem resources.
|
|
"network": "A String", # Name of the network in the customer project with which the Tenant Project
|
|
# will be peered for executing pipelines.
|
|
"ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance
|
|
# nodes. This range must not overlap with any other ranges used in the Data
|
|
# Fusion instance network.
|
|
},
|
|
"serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI and REST APIs are
|
|
# accessible.
|
|
"stateMessage": "A String", # Output only. Additional information about the current state of this Data
|
|
# Fusion instance if available.
|
|
"state": "A String", # Output only. The current state of this Data Fusion instance.
|
|
"version": "A String", # Output only. Current version of the Data Fusion.
|
|
"type": "A String", # Required. Instance type.
|
|
"createTime": "A String", # Output only. The time the instance was created.
|
|
"serviceAccount": "A String", # Output only. Service account which will be used to access resources in
|
|
# the customer project."
|
|
"name": "A String", # Output only. The name of this instance is in the form of
|
|
# projects/{project}/locations/{location}/instances/{instance}.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="getIamPolicy">getIamPolicy(resource, 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)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Defines an Identity and Access Management (IAM) policy. It is used to
|
|
# specify access control policies for Cloud Platform resources.
|
|
#
|
|
#
|
|
# A `Policy` consists of a list of `bindings`. A `binding` binds a list of
|
|
# `members` to a `role`, where the members can be user accounts, Google groups,
|
|
# Google domains, and service accounts. A `role` is a named list of permissions
|
|
# defined by IAM.
|
|
#
|
|
# **JSON Example**
|
|
#
|
|
# {
|
|
# "bindings": [
|
|
# {
|
|
# "role": "roles/owner",
|
|
# "members": [
|
|
# "user:mike@example.com",
|
|
# "group:admins@example.com",
|
|
# "domain:google.com",
|
|
# "serviceAccount:my-other-app@appspot.gserviceaccount.com"
|
|
# ]
|
|
# },
|
|
# {
|
|
# "role": "roles/viewer",
|
|
# "members": ["user:sean@example.com"]
|
|
# }
|
|
# ]
|
|
# }
|
|
#
|
|
# **YAML Example**
|
|
#
|
|
# bindings:
|
|
# - members:
|
|
# - user:mike@example.com
|
|
# - group:admins@example.com
|
|
# - domain:google.com
|
|
# - serviceAccount:my-other-app@appspot.gserviceaccount.com
|
|
# role: roles/owner
|
|
# - members:
|
|
# - user:sean@example.com
|
|
# role: roles/viewer
|
|
#
|
|
#
|
|
# For a description of IAM and its features, see the
|
|
# [IAM developer's guide](https://cloud.google.com/iam/docs).
|
|
"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:foo@gmail.com"
|
|
# ]
|
|
# },
|
|
# {
|
|
# "log_type": "DATA_WRITE",
|
|
# },
|
|
# {
|
|
# "log_type": "ADMIN_READ",
|
|
# }
|
|
# ]
|
|
# },
|
|
# {
|
|
# "service": "fooservice.googleapis.com"
|
|
# "audit_log_configs": [
|
|
# {
|
|
# "log_type": "DATA_READ",
|
|
# },
|
|
# {
|
|
# "log_type": "DATA_WRITE",
|
|
# "exempted_members": [
|
|
# "user:bar@gmail.com"
|
|
# ]
|
|
# }
|
|
# ]
|
|
# }
|
|
# ]
|
|
# }
|
|
#
|
|
# For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
|
|
# logging. It also exempts foo@gmail.com from DATA_READ logging, and
|
|
# bar@gmail.com from DATA_WRITE logging.
|
|
"exemptedMembers": [
|
|
"A String",
|
|
],
|
|
"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:foo@gmail.com"
|
|
# ]
|
|
# },
|
|
# {
|
|
# "log_type": "DATA_WRITE",
|
|
# }
|
|
# ]
|
|
# }
|
|
#
|
|
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
|
|
# foo@gmail.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.
|
|
},
|
|
],
|
|
"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.
|
|
},
|
|
],
|
|
"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.
|
|
"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",
|
|
],
|
|
"description": "A String", # Human-readable description of the rule.
|
|
"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",
|
|
],
|
|
"action": "A String", # Required
|
|
"conditions": [ # Additional restrictions that must be met. All conditions must pass for the
|
|
# rule to match.
|
|
{ # A condition to be met.
|
|
"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
|
|
# the IAM system for access control.
|
|
"iam": "A String", # Trusted attributes supplied by the IAM system.
|
|
"values": [ # The objects of the condition.
|
|
"A String",
|
|
],
|
|
"svc": "A String", # Trusted attributes discharged by the service.
|
|
"op": "A String", # An operator to apply the subject with.
|
|
},
|
|
],
|
|
"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
|
|
"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/backend_debug_access_count
|
|
# {iam_principal=[value of IAMContext.principal]}
|
|
#
|
|
# At this time we do not support multiple field names (though this may be
|
|
# supported in the future).
|
|
"field": "A String", # The field value to attribute.
|
|
"metric": "A String", # The metric to update.
|
|
},
|
|
"dataAccess": { # Write a Data Access (Gin) log # Data access options.
|
|
"logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller.
|
|
# This is relevant only in the LocalIAM implementation, for now.
|
|
},
|
|
"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
|
|
"logName": "A String", # The log_name to populate in the Cloud Audit Record.
|
|
"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.
|
|
},
|
|
},
|
|
},
|
|
],
|
|
"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",
|
|
],
|
|
},
|
|
],
|
|
"version": 42, # Deprecated.
|
|
"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.
|
|
#
|
|
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
|
|
# policy is overwritten blindly.
|
|
"bindings": [ # Associates a list of `members` to a `role`.
|
|
# `bindings` with no members will result in an error.
|
|
{ # Associates `members` with a `role`.
|
|
"role": "A String", # Role that is assigned to `members`.
|
|
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
|
|
"condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
|
|
# NOTE: An unsatisfied condition will not allow user access via current
|
|
# binding. Different bindings, including their conditions, are examined
|
|
# independently.
|
|
#
|
|
# title: "User account presence"
|
|
# description: "Determines whether the request has a user account"
|
|
# expression: "size(request.user) > 0"
|
|
"description": "A String", # An 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.
|
|
#
|
|
# The application context of the containing message determines which
|
|
# well-known feature set of CEL is supported.
|
|
"location": "A String", # An optional string indicating the location of the expression for error
|
|
# reporting, e.g. a file name and a position in the file.
|
|
"title": "A String", # An 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.
|
|
},
|
|
"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@gmail.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`.
|
|
#
|
|
#
|
|
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
|
|
# users of that domain. For example, `google.com` or `example.com`.
|
|
#
|
|
"A String",
|
|
],
|
|
},
|
|
],
|
|
"iamOwned": True or False,
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
|
|
<pre>Lists Data Fusion instances in the specified project and location.
|
|
|
|
Args:
|
|
parent: string, The project and location for which to retrieve instance information
|
|
in the format projects/{project}/locations/{location}. If the location is
|
|
specified as '-' (wildcard), then all regions available to the project
|
|
are queried, and the results are aggregated. (required)
|
|
orderBy: string, Sort results. Supported values are "name", "name desc", or "" (unsorted).
|
|
pageSize: integer, The maximum number of items to return.
|
|
pageToken: string, The next_page_token value to use if there are additional
|
|
results to retrieve for this list request.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
filter: string, List filter.
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Response message for the list instance request.
|
|
"nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more
|
|
# results in the list.
|
|
"unreachable": [ # Locations that could not be reached.
|
|
"A String",
|
|
],
|
|
"instances": [ # Represents a list of Data Fusion instances.
|
|
{ # Represents a Data Fusion instance.
|
|
"updateTime": "A String", # Output only. The time the instance was last updated.
|
|
"displayName": "A String", # Display name for an instance.
|
|
"description": "A String", # An optional description of this instance.
|
|
"zone": "A String", # Name of the zone in which the Data Fusion instance will be created.
|
|
"privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to
|
|
# true, all Data Fusion nodes will have private IP addresses and will not be
|
|
# able to access the public internet.
|
|
"enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring.
|
|
"options": { # Map of additional options used to configure the behavior of
|
|
# Data Fusion instance.
|
|
"a_key": "A String",
|
|
},
|
|
"labels": { # The resource labels for instance to use to annotate any related underlying
|
|
# resources such as GCE VMs. The character '=' is not allowed to be used
|
|
# within the labels.
|
|
"a_key": "A String",
|
|
},
|
|
"enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging.
|
|
"networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data
|
|
# Fusion instance is to be created.
|
|
# are used for peering with the customer network. Configurations are optional
|
|
# when a public Data Fusion instance is to be created. However, providing
|
|
# these configurations allows several benefits, such as reduced network latency
|
|
# while accessing the customer resources from managed Data Fusion instance
|
|
# nodes, as well as access to the customer on-prem resources.
|
|
"network": "A String", # Name of the network in the customer project with which the Tenant Project
|
|
# will be peered for executing pipelines.
|
|
"ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance
|
|
# nodes. This range must not overlap with any other ranges used in the Data
|
|
# Fusion instance network.
|
|
},
|
|
"serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI and REST APIs are
|
|
# accessible.
|
|
"stateMessage": "A String", # Output only. Additional information about the current state of this Data
|
|
# Fusion instance if available.
|
|
"state": "A String", # Output only. The current state of this Data Fusion instance.
|
|
"version": "A String", # Output only. Current version of the Data Fusion.
|
|
"type": "A String", # Required. Instance type.
|
|
"createTime": "A String", # Output only. The time the instance was created.
|
|
"serviceAccount": "A String", # Output only. Service account which will be used to access resources in
|
|
# the customer project."
|
|
"name": "A String", # Output only. The name of this instance is in the form of
|
|
# projects/{project}/locations/{location}/instances/{instance}.
|
|
},
|
|
],
|
|
}</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, updateMask=None, x__xgafv=None)</code>
|
|
<pre>Updates a single Data Fusion instance.
|
|
|
|
Args:
|
|
name: string, Output only. The name of this instance is in the form of
|
|
projects/{project}/locations/{location}/instances/{instance}. (required)
|
|
body: object, The request body. (required)
|
|
The object takes the form of:
|
|
|
|
{ # Represents a Data Fusion instance.
|
|
"updateTime": "A String", # Output only. The time the instance was last updated.
|
|
"displayName": "A String", # Display name for an instance.
|
|
"description": "A String", # An optional description of this instance.
|
|
"zone": "A String", # Name of the zone in which the Data Fusion instance will be created.
|
|
"privateInstance": True or False, # Specifies whether the Data Fusion instance should be private. If set to
|
|
# true, all Data Fusion nodes will have private IP addresses and will not be
|
|
# able to access the public internet.
|
|
"enableStackdriverMonitoring": True or False, # Option to enable Stackdriver Monitoring.
|
|
"options": { # Map of additional options used to configure the behavior of
|
|
# Data Fusion instance.
|
|
"a_key": "A String",
|
|
},
|
|
"labels": { # The resource labels for instance to use to annotate any related underlying
|
|
# resources such as GCE VMs. The character '=' is not allowed to be used
|
|
# within the labels.
|
|
"a_key": "A String",
|
|
},
|
|
"enableStackdriverLogging": True or False, # Option to enable Stackdriver Logging.
|
|
"networkConfig": { # Network configuration for a Data Fusion instance. These configurations # Network configuration options. These are required when a private Data
|
|
# Fusion instance is to be created.
|
|
# are used for peering with the customer network. Configurations are optional
|
|
# when a public Data Fusion instance is to be created. However, providing
|
|
# these configurations allows several benefits, such as reduced network latency
|
|
# while accessing the customer resources from managed Data Fusion instance
|
|
# nodes, as well as access to the customer on-prem resources.
|
|
"network": "A String", # Name of the network in the customer project with which the Tenant Project
|
|
# will be peered for executing pipelines.
|
|
"ipAllocation": "A String", # The IP range in CIDR notation to use for the managed Data Fusion instance
|
|
# nodes. This range must not overlap with any other ranges used in the Data
|
|
# Fusion instance network.
|
|
},
|
|
"serviceEndpoint": "A String", # Output only. Endpoint on which the Data Fusion UI and REST APIs are
|
|
# accessible.
|
|
"stateMessage": "A String", # Output only. Additional information about the current state of this Data
|
|
# Fusion instance if available.
|
|
"state": "A String", # Output only. The current state of this Data Fusion instance.
|
|
"version": "A String", # Output only. Current version of the Data Fusion.
|
|
"type": "A String", # Required. Instance type.
|
|
"createTime": "A String", # Output only. The time the instance was created.
|
|
"serviceAccount": "A String", # Output only. Service account which will be used to access resources in
|
|
# the customer project."
|
|
"name": "A String", # Output only. The name of this instance is in the form of
|
|
# projects/{project}/locations/{location}/instances/{instance}.
|
|
}
|
|
|
|
updateMask: string, Field mask is used to specify the fields that the update will overwrite
|
|
in an instance resource. The fields specified in the update_mask are
|
|
relative to the resource, not the full request.
|
|
A field will be overwritten if it is in the mask.
|
|
If the user does not provide a mask, all the supported fields (labels and
|
|
options currently) will be overwritten.
|
|
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.
|
|
"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.
|
|
},
|
|
"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}`.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="restart">restart(name, body=None, x__xgafv=None)</code>
|
|
<pre>Restart a single Data Fusion instance.
|
|
At the end of an operation instance is fully restarted.
|
|
|
|
Args:
|
|
name: string, Name of the Data Fusion instance which need to be restarted in the form of
|
|
projects/{project}/locations/{location}/instances/{instance} (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{ # Request message for restarting a Data Fusion instance.
|
|
}
|
|
|
|
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.
|
|
"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.
|
|
},
|
|
"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}`.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
|
|
<pre>Sets the access control policy on the specified resource. Replaces any
|
|
existing policy.
|
|
|
|
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. (required)
|
|
The object takes the form of:
|
|
|
|
{ # Request message for `SetIamPolicy` method.
|
|
"policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # 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.
|
|
# specify access control policies for Cloud Platform resources.
|
|
#
|
|
#
|
|
# A `Policy` consists of a list of `bindings`. A `binding` binds a list of
|
|
# `members` to a `role`, where the members can be user accounts, Google groups,
|
|
# Google domains, and service accounts. A `role` is a named list of permissions
|
|
# defined by IAM.
|
|
#
|
|
# **JSON Example**
|
|
#
|
|
# {
|
|
# "bindings": [
|
|
# {
|
|
# "role": "roles/owner",
|
|
# "members": [
|
|
# "user:mike@example.com",
|
|
# "group:admins@example.com",
|
|
# "domain:google.com",
|
|
# "serviceAccount:my-other-app@appspot.gserviceaccount.com"
|
|
# ]
|
|
# },
|
|
# {
|
|
# "role": "roles/viewer",
|
|
# "members": ["user:sean@example.com"]
|
|
# }
|
|
# ]
|
|
# }
|
|
#
|
|
# **YAML Example**
|
|
#
|
|
# bindings:
|
|
# - members:
|
|
# - user:mike@example.com
|
|
# - group:admins@example.com
|
|
# - domain:google.com
|
|
# - serviceAccount:my-other-app@appspot.gserviceaccount.com
|
|
# role: roles/owner
|
|
# - members:
|
|
# - user:sean@example.com
|
|
# role: roles/viewer
|
|
#
|
|
#
|
|
# For a description of IAM and its features, see the
|
|
# [IAM developer's guide](https://cloud.google.com/iam/docs).
|
|
"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:foo@gmail.com"
|
|
# ]
|
|
# },
|
|
# {
|
|
# "log_type": "DATA_WRITE",
|
|
# },
|
|
# {
|
|
# "log_type": "ADMIN_READ",
|
|
# }
|
|
# ]
|
|
# },
|
|
# {
|
|
# "service": "fooservice.googleapis.com"
|
|
# "audit_log_configs": [
|
|
# {
|
|
# "log_type": "DATA_READ",
|
|
# },
|
|
# {
|
|
# "log_type": "DATA_WRITE",
|
|
# "exempted_members": [
|
|
# "user:bar@gmail.com"
|
|
# ]
|
|
# }
|
|
# ]
|
|
# }
|
|
# ]
|
|
# }
|
|
#
|
|
# For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
|
|
# logging. It also exempts foo@gmail.com from DATA_READ logging, and
|
|
# bar@gmail.com from DATA_WRITE logging.
|
|
"exemptedMembers": [
|
|
"A String",
|
|
],
|
|
"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:foo@gmail.com"
|
|
# ]
|
|
# },
|
|
# {
|
|
# "log_type": "DATA_WRITE",
|
|
# }
|
|
# ]
|
|
# }
|
|
#
|
|
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
|
|
# foo@gmail.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.
|
|
},
|
|
],
|
|
"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.
|
|
},
|
|
],
|
|
"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.
|
|
"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",
|
|
],
|
|
"description": "A String", # Human-readable description of the rule.
|
|
"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",
|
|
],
|
|
"action": "A String", # Required
|
|
"conditions": [ # Additional restrictions that must be met. All conditions must pass for the
|
|
# rule to match.
|
|
{ # A condition to be met.
|
|
"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
|
|
# the IAM system for access control.
|
|
"iam": "A String", # Trusted attributes supplied by the IAM system.
|
|
"values": [ # The objects of the condition.
|
|
"A String",
|
|
],
|
|
"svc": "A String", # Trusted attributes discharged by the service.
|
|
"op": "A String", # An operator to apply the subject with.
|
|
},
|
|
],
|
|
"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
|
|
"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/backend_debug_access_count
|
|
# {iam_principal=[value of IAMContext.principal]}
|
|
#
|
|
# At this time we do not support multiple field names (though this may be
|
|
# supported in the future).
|
|
"field": "A String", # The field value to attribute.
|
|
"metric": "A String", # The metric to update.
|
|
},
|
|
"dataAccess": { # Write a Data Access (Gin) log # Data access options.
|
|
"logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller.
|
|
# This is relevant only in the LocalIAM implementation, for now.
|
|
},
|
|
"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
|
|
"logName": "A String", # The log_name to populate in the Cloud Audit Record.
|
|
"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.
|
|
},
|
|
},
|
|
},
|
|
],
|
|
"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",
|
|
],
|
|
},
|
|
],
|
|
"version": 42, # Deprecated.
|
|
"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.
|
|
#
|
|
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
|
|
# policy is overwritten blindly.
|
|
"bindings": [ # Associates a list of `members` to a `role`.
|
|
# `bindings` with no members will result in an error.
|
|
{ # Associates `members` with a `role`.
|
|
"role": "A String", # Role that is assigned to `members`.
|
|
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
|
|
"condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
|
|
# NOTE: An unsatisfied condition will not allow user access via current
|
|
# binding. Different bindings, including their conditions, are examined
|
|
# independently.
|
|
#
|
|
# title: "User account presence"
|
|
# description: "Determines whether the request has a user account"
|
|
# expression: "size(request.user) > 0"
|
|
"description": "A String", # An 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.
|
|
#
|
|
# The application context of the containing message determines which
|
|
# well-known feature set of CEL is supported.
|
|
"location": "A String", # An optional string indicating the location of the expression for error
|
|
# reporting, e.g. a file name and a position in the file.
|
|
"title": "A String", # An 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.
|
|
},
|
|
"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@gmail.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`.
|
|
#
|
|
#
|
|
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
|
|
# users of that domain. For example, `google.com` or `example.com`.
|
|
#
|
|
"A String",
|
|
],
|
|
},
|
|
],
|
|
"iamOwned": True or False,
|
|
},
|
|
"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"
|
|
# This field is only used by Cloud IAM.
|
|
}
|
|
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Defines an Identity and Access Management (IAM) policy. It is used to
|
|
# specify access control policies for Cloud Platform resources.
|
|
#
|
|
#
|
|
# A `Policy` consists of a list of `bindings`. A `binding` binds a list of
|
|
# `members` to a `role`, where the members can be user accounts, Google groups,
|
|
# Google domains, and service accounts. A `role` is a named list of permissions
|
|
# defined by IAM.
|
|
#
|
|
# **JSON Example**
|
|
#
|
|
# {
|
|
# "bindings": [
|
|
# {
|
|
# "role": "roles/owner",
|
|
# "members": [
|
|
# "user:mike@example.com",
|
|
# "group:admins@example.com",
|
|
# "domain:google.com",
|
|
# "serviceAccount:my-other-app@appspot.gserviceaccount.com"
|
|
# ]
|
|
# },
|
|
# {
|
|
# "role": "roles/viewer",
|
|
# "members": ["user:sean@example.com"]
|
|
# }
|
|
# ]
|
|
# }
|
|
#
|
|
# **YAML Example**
|
|
#
|
|
# bindings:
|
|
# - members:
|
|
# - user:mike@example.com
|
|
# - group:admins@example.com
|
|
# - domain:google.com
|
|
# - serviceAccount:my-other-app@appspot.gserviceaccount.com
|
|
# role: roles/owner
|
|
# - members:
|
|
# - user:sean@example.com
|
|
# role: roles/viewer
|
|
#
|
|
#
|
|
# For a description of IAM and its features, see the
|
|
# [IAM developer's guide](https://cloud.google.com/iam/docs).
|
|
"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:foo@gmail.com"
|
|
# ]
|
|
# },
|
|
# {
|
|
# "log_type": "DATA_WRITE",
|
|
# },
|
|
# {
|
|
# "log_type": "ADMIN_READ",
|
|
# }
|
|
# ]
|
|
# },
|
|
# {
|
|
# "service": "fooservice.googleapis.com"
|
|
# "audit_log_configs": [
|
|
# {
|
|
# "log_type": "DATA_READ",
|
|
# },
|
|
# {
|
|
# "log_type": "DATA_WRITE",
|
|
# "exempted_members": [
|
|
# "user:bar@gmail.com"
|
|
# ]
|
|
# }
|
|
# ]
|
|
# }
|
|
# ]
|
|
# }
|
|
#
|
|
# For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
|
|
# logging. It also exempts foo@gmail.com from DATA_READ logging, and
|
|
# bar@gmail.com from DATA_WRITE logging.
|
|
"exemptedMembers": [
|
|
"A String",
|
|
],
|
|
"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:foo@gmail.com"
|
|
# ]
|
|
# },
|
|
# {
|
|
# "log_type": "DATA_WRITE",
|
|
# }
|
|
# ]
|
|
# }
|
|
#
|
|
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
|
|
# foo@gmail.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.
|
|
},
|
|
],
|
|
"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.
|
|
},
|
|
],
|
|
"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.
|
|
"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",
|
|
],
|
|
"description": "A String", # Human-readable description of the rule.
|
|
"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",
|
|
],
|
|
"action": "A String", # Required
|
|
"conditions": [ # Additional restrictions that must be met. All conditions must pass for the
|
|
# rule to match.
|
|
{ # A condition to be met.
|
|
"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses
|
|
# the IAM system for access control.
|
|
"iam": "A String", # Trusted attributes supplied by the IAM system.
|
|
"values": [ # The objects of the condition.
|
|
"A String",
|
|
],
|
|
"svc": "A String", # Trusted attributes discharged by the service.
|
|
"op": "A String", # An operator to apply the subject with.
|
|
},
|
|
],
|
|
"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
|
|
"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/backend_debug_access_count
|
|
# {iam_principal=[value of IAMContext.principal]}
|
|
#
|
|
# At this time we do not support multiple field names (though this may be
|
|
# supported in the future).
|
|
"field": "A String", # The field value to attribute.
|
|
"metric": "A String", # The metric to update.
|
|
},
|
|
"dataAccess": { # Write a Data Access (Gin) log # Data access options.
|
|
"logMode": "A String", # Whether Gin logging should happen in a fail-closed manner at the caller.
|
|
# This is relevant only in the LocalIAM implementation, for now.
|
|
},
|
|
"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
|
|
"logName": "A String", # The log_name to populate in the Cloud Audit Record.
|
|
"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.
|
|
},
|
|
},
|
|
},
|
|
],
|
|
"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",
|
|
],
|
|
},
|
|
],
|
|
"version": 42, # Deprecated.
|
|
"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.
|
|
#
|
|
# If no `etag` is provided in the call to `setIamPolicy`, then the existing
|
|
# policy is overwritten blindly.
|
|
"bindings": [ # Associates a list of `members` to a `role`.
|
|
# `bindings` with no members will result in an error.
|
|
{ # Associates `members` with a `role`.
|
|
"role": "A String", # Role that is assigned to `members`.
|
|
# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
|
|
"condition": { # Represents an expression text. Example: # The condition that is associated with this binding.
|
|
# NOTE: An unsatisfied condition will not allow user access via current
|
|
# binding. Different bindings, including their conditions, are examined
|
|
# independently.
|
|
#
|
|
# title: "User account presence"
|
|
# description: "Determines whether the request has a user account"
|
|
# expression: "size(request.user) > 0"
|
|
"description": "A String", # An 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.
|
|
#
|
|
# The application context of the containing message determines which
|
|
# well-known feature set of CEL is supported.
|
|
"location": "A String", # An optional string indicating the location of the expression for error
|
|
# reporting, e.g. a file name and a position in the file.
|
|
"title": "A String", # An 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.
|
|
},
|
|
"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@gmail.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`.
|
|
#
|
|
#
|
|
# * `domain:{domain}`: The G Suite domain (primary) that represents all the
|
|
# users of that domain. For example, `google.com` or `example.com`.
|
|
#
|
|
"A String",
|
|
],
|
|
},
|
|
],
|
|
"iamOwned": True or False,
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="testIamPermissions">testIamPermissions(resource, body, 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. (required)
|
|
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="upgrade">upgrade(name, body=None, x__xgafv=None)</code>
|
|
<pre>Upgrade a single Data Fusion instance.
|
|
At the end of an operation instance is fully upgraded.
|
|
|
|
Args:
|
|
name: string, Name of the Data Fusion instance which need to be upgraded in the form of
|
|
projects/{project}/locations/{location}/instances/{instance}
|
|
Instance will be upgraded with the latest stable version of the Data
|
|
Fusion. (required)
|
|
body: object, The request body.
|
|
The object takes the form of:
|
|
|
|
{ # Request message for upgrading a Data Fusion instance.
|
|
# To change the instance properties, instance update should be used.
|
|
}
|
|
|
|
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.
|
|
"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.
|
|
},
|
|
"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}`.
|
|
}</pre>
|
|
</div>
|
|
|
|
</body></html> |