blob: 5019b39cbe3465c8c5e231be7e146efe4dfaec67 [file] [log] [blame] [edit]
{
"version_module": true,
"mtlsRootUrl": "https://datafusion.mtls.googleapis.com/",
"resources": {
"projects": {
"resources": {
"locations": {
"resources": {
"operations": {
"methods": {
"cancel": {
"parameterOrder": [
"name"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"name": {
"location": "path",
"description": "The name of the operation resource to be cancelled.",
"required": true,
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$"
}
},
"id": "datafusion.projects.locations.operations.cancel",
"httpMethod": "POST",
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"request": {
"$ref": "CancelOperationRequest"
},
"path": "v1/{+name}:cancel"
},
"list": {
"path": "v1/{+name}/operations",
"parameters": {
"filter": {
"location": "query",
"type": "string",
"description": "The standard list filter."
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"name": {
"location": "path",
"required": true,
"type": "string",
"description": "The name of the operation's parent resource.",
"pattern": "^projects/[^/]+/locations/[^/]+$"
},
"pageSize": {
"format": "int32",
"location": "query",
"description": "The standard list page size.",
"type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"id": "datafusion.projects.locations.operations.list",
"httpMethod": "GET",
"response": {
"$ref": "ListOperationsResponse"
},
"parameterOrder": [
"name"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations"
},
"delete": {
"id": "datafusion.projects.locations.operations.delete",
"parameterOrder": [
"name"
],
"path": "v1/{+name}",
"parameters": {
"name": {
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"location": "path",
"description": "The name of the operation resource to be deleted.",
"type": "string"
}
},
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Empty"
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`."
},
"get": {
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"description": "The name of the operation resource.",
"location": "path",
"type": "string"
}
},
"parameterOrder": [
"name"
],
"id": "datafusion.projects.locations.operations.get",
"response": {
"$ref": "Operation"
},
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"path": "v1/{+name}",
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"versions": {
"methods": {
"list": {
"httpMethod": "GET",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/versions",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"description": "Required. The project and location for which to retrieve instance information in the format projects/{project}/locations/{location}.",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string",
"location": "path"
},
"pageToken": {
"description": "The next_page_token value to use if there are additional results to retrieve for this list request.",
"type": "string",
"location": "query"
},
"latestPatchOnly": {
"description": "Whether or not to return the latest patch of every available minor version. If true, only the latest patch will be returned. Ex. if allowed versions is [6.1.1, 6.1.2, 6.2.0] then response will be [6.1.2, 6.2.0]",
"type": "boolean",
"location": "query"
},
"pageSize": {
"description": "The maximum number of items to return.",
"format": "int32",
"type": "integer",
"location": "query"
}
},
"response": {
"$ref": "ListAvailableVersionsResponse"
},
"id": "datafusion.projects.locations.versions.list",
"path": "v1/{+parent}/versions",
"parameterOrder": [
"parent"
],
"description": "Lists possible versions for Data Fusion instances in the specified project and location."
}
}
},
"instances": {
"methods": {
"create": {
"parameters": {
"instanceId": {
"description": "The name of the instance to create.",
"type": "string",
"location": "query"
},
"parent": {
"pattern": "^projects/[^/]+/locations/[^/]+$",
"type": "string",
"location": "path",
"description": "The instance's project and location in the format projects/{project}/locations/{location}.",
"required": true
}
},
"parameterOrder": [
"parent"
],
"description": "Creates a new Data Fusion instance in the specified project and location.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"request": {
"$ref": "Instance"
},
"id": "datafusion.projects.locations.instances.create",
"httpMethod": "POST",
"response": {
"$ref": "Operation"
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances",
"path": "v1/{+parent}/instances"
},
"get": {
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}",
"description": "Gets details of a single Data Fusion instance.",
"id": "datafusion.projects.locations.instances.get",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"response": {
"$ref": "Instance"
},
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"type": "string",
"location": "path",
"required": true,
"description": "The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}."
}
},
"path": "v1/{+name}"
},
"testIamPermissions": {
"httpMethod": "POST",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions",
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "datafusion.projects.locations.instances.testIamPermissions",
"parameters": {
"resource": {
"location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$"
}
},
"parameterOrder": [
"resource"
],
"description": "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.",
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
}
},
"list": {
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances",
"path": "v1/{+parent}/instances",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "ListInstancesResponse"
},
"httpMethod": "GET",
"id": "datafusion.projects.locations.instances.list",
"parameters": {
"filter": {
"description": "List filter.",
"type": "string",
"location": "query"
},
"parent": {
"required": true,
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"description": "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.",
"type": "string"
},
"pageSize": {
"type": "integer",
"location": "query",
"description": "The maximum number of items to return.",
"format": "int32"
},
"pageToken": {
"description": "The next_page_token value to use if there are additional results to retrieve for this list request.",
"type": "string",
"location": "query"
},
"orderBy": {
"location": "query",
"type": "string",
"description": "Sort results. Supported values are \"name\", \"name desc\", or \"\" (unsorted)."
}
},
"description": "Lists Data Fusion instances in the specified project and location.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"parameters": {
"name": {
"description": "The instance resource name in the format projects/{project}/locations/{location}/instances/{instance}",
"required": true,
"type": "string",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$"
}
},
"response": {
"$ref": "Operation"
},
"description": "Deletes a single Date Fusion instance.",
"path": "v1/{+name}",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}",
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"id": "datafusion.projects.locations.instances.delete",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"response": {
"$ref": "Policy"
},
"httpMethod": "POST",
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
"request": {
"$ref": "SetIamPolicyRequest"
},
"parameterOrder": [
"resource"
],
"path": "v1/{+resource}:setIamPolicy",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"id": "datafusion.projects.locations.instances.setIamPolicy",
"parameters": {
"resource": {
"location": "path",
"required": true,
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"type": "string"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:setIamPolicy"
},
"patch": {
"path": "v1/{+name}",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Operation"
},
"description": "Updates a single Data Fusion instance.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"type": "string",
"description": "Field mask is used to specify the fields that the update will overwrite in an instance resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask, all the supported fields (labels, options, and version currently) will be overwritten."
},
"name": {
"required": true,
"type": "string",
"location": "path",
"description": "Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$"
}
},
"request": {
"$ref": "Instance"
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}",
"id": "datafusion.projects.locations.instances.patch",
"httpMethod": "PATCH"
},
"getIamPolicy": {
"id": "datafusion.projects.locations.instances.getIamPolicy",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:getIamPolicy",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "GET",
"parameters": {
"options.requestedPolicyVersion": {
"location": "query",
"description": "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).",
"format": "int32",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"type": "string",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$",
"required": true
}
},
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"path": "v1/{+resource}:getIamPolicy",
"response": {
"$ref": "Policy"
},
"parameterOrder": [
"resource"
]
},
"restart": {
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:restart",
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"request": {
"$ref": "RestartInstanceRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "Name of the Data Fusion instance which need to be restarted in the form of projects/{project}/locations/{location}/instances/{instance}",
"required": true,
"location": "path",
"type": "string",
"pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$"
}
},
"id": "datafusion.projects.locations.instances.restart",
"path": "v1/{+name}:restart",
"response": {
"$ref": "Operation"
},
"description": "Restart a single Data Fusion instance. At the end of an operation instance is fully restarted."
}
}
}
},
"methods": {
"list": {
"httpMethod": "GET",
"response": {
"$ref": "ListLocationsResponse"
},
"parameters": {
"includeUnrevealedLocations": {
"location": "query",
"type": "boolean",
"description": "If true, the returned list will include locations which are not yet revealed."
},
"pageSize": {
"location": "query",
"type": "integer",
"description": "The standard list page size.",
"format": "int32"
},
"filter": {
"description": "The standard list filter.",
"type": "string",
"location": "query"
},
"name": {
"location": "path",
"pattern": "^projects/[^/]+$",
"type": "string",
"description": "The resource that owns the locations collection, if applicable.",
"required": true
},
"pageToken": {
"type": "string",
"location": "query",
"description": "The standard list page token."
}
},
"parameterOrder": [
"name"
],
"description": "Lists information about the supported locations for this service.",
"path": "v1/{+name}/locations",
"flatPath": "v1/projects/{projectsId}/locations",
"id": "datafusion.projects.locations.list",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"response": {
"$ref": "Location"
},
"path": "v1/{+name}",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
"id": "datafusion.projects.locations.get",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"httpMethod": "GET",
"description": "Gets information about a location.",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"type": "string",
"description": "Resource name for the location.",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"location": "path"
}
}
}
}
}
}
}
},
"documentationLink": "https://cloud.google.com/data-fusion/docs",
"description": "Cloud Data Fusion is a fully-managed, cloud native, enterprise data integration service for quickly building and managing data pipelines. It provides a graphical interface to increase time efficiency and reduce complexity, and allows business users, developers, and data scientists to easily and reliably build scalable data integration solutions to cleanse, prepare, blend, transfer and transform data without having to wrestle with infrastructure.",
"baseUrl": "https://datafusion.googleapis.com/",
"protocol": "rest",
"id": "datafusion:v1",
"batchPath": "batch",
"revision": "20200928",
"schemas": {
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "ListLocationsResponse",
"properties": {
"nextPageToken": {
"type": "string",
"description": "The standard List next-page token."
},
"locations": {
"type": "array",
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
}
}
},
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"type": "object",
"properties": {
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
},
"members": {
"items": {
"type": "string"
},
"type": "array",
"description": "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, `[email protected]` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `[email protected]`. * `group:{emailid}`: An email address that represents a Google group. For example, `[email protected]`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `[email protected]?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, `[email protected]?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, `[email protected]?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`. "
},
"condition": {
"description": "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).",
"$ref": "Expr"
},
"bindingId": {
"description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.",
"type": "string"
}
},
"id": "Binding"
},
"Location": {
"type": "object",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
},
"metadata": {
"description": "Service-specific metadata. For example the available capacity at the given location.",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
}
},
"description": "A resource that represents Google Cloud Platform location.",
"id": "Location"
},
"ListAvailableVersionsResponse": {
"id": "ListAvailableVersionsResponse",
"description": "Response message for the list available versions request.",
"properties": {
"nextPageToken": {
"type": "string",
"description": "Token to retrieve the next page of results or empty if there are no more results in the list."
},
"availableVersions": {
"items": {
"$ref": "Version"
},
"description": "Represents a list of versions that are supported.",
"type": "array"
}
},
"type": "object"
},
"AuditLogConfig": {
"type": "object",
"id": "AuditLogConfig",
"properties": {
"logType": {
"description": "The log type that this config enables.",
"type": "string",
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
],
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
]
},
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:[email protected]\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging."
},
"Policy": {
"description": "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:[email protected]\", \"group:[email protected]\", \"domain:google.com\", \"serviceAccount:[email protected]\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:[email protected]\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } **YAML example:** bindings: - members: - user:[email protected] - group:[email protected] - domain:google.com - serviceAccount:[email protected] role: roles/resourcemanager.organizationAdmin - members: - user:[email protected] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c 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/).",
"id": "Policy",
"properties": {
"auditConfigs": {
"type": "array",
"items": {
"$ref": "AuditConfig"
},
"description": "Specifies cloud audit logging configuration for this policy."
},
"etag": {
"description": "`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.",
"type": "string",
"format": "byte"
},
"version": {
"description": "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).",
"format": "int32",
"type": "integer"
},
"bindings": {
"description": "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.",
"type": "array",
"items": {
"$ref": "Binding"
}
}
},
"type": "object"
},
"Accelerator": {
"description": "Identifies Data Fusion accelerators for an instance.",
"properties": {
"acceleratorType": {
"enumDescriptions": [
"Default value, if unspecified.",
"Change Data Capture accelerator for CDF.",
"Cloud Healthcare accelerator for CDF. This accelerator is to enable Cloud Healthcare specific CDF plugins developed by Healthcare team."
],
"type": "string",
"enum": [
"ACCELERATOR_TYPE_UNSPECIFIED",
"CDC",
"HEALTHCARE"
],
"description": "The type of an accelator for a CDF instance."
}
},
"id": "Accelerator",
"type": "object"
},
"OperationMetadata": {
"description": "Represents the metadata of a long-running operation.",
"properties": {
"apiVersion": {
"type": "string",
"description": "API version used to start the operation."
},
"requestedCancellation": {
"type": "boolean",
"description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`."
},
"endTime": {
"type": "string",
"format": "google-datetime",
"description": "The time the operation finished running."
},
"statusDetail": {
"type": "string",
"description": "Human-readable status of the operation if any."
},
"verb": {
"description": "Name of the verb executed by the operation.",
"type": "string"
},
"createTime": {
"description": "The time the operation was created.",
"type": "string",
"format": "google-datetime"
},
"target": {
"type": "string",
"description": "Server-defined resource path for the target of the operation."
}
},
"id": "OperationMetadata",
"type": "object"
},
"Expr": {
"description": "Represents a textual expression in the Common Expression Language (CEL) 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() \u003c 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.",
"id": "Expr",
"properties": {
"description": {
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"title": {
"type": "string",
"description": "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."
},
"expression": {
"type": "string",
"description": "Textual representation of an expression in Common Expression Language syntax."
},
"location": {
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
"type": "string"
}
},
"type": "object"
},
"CancelOperationRequest": {
"id": "CancelOperationRequest",
"description": "The request message for Operations.CancelOperation.",
"type": "object",
"properties": {}
},
"Empty": {
"id": "Empty",
"properties": {},
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object"
},
"ListInstancesResponse": {
"properties": {
"unreachable": {
"type": "array",
"description": "Locations that could not be reached.",
"items": {
"type": "string"
}
},
"instances": {
"items": {
"$ref": "Instance"
},
"description": "Represents a list of Data Fusion instances.",
"type": "array"
},
"nextPageToken": {
"type": "string",
"description": "Token to retrieve the next page of results or empty if there are no more results in the list."
}
},
"id": "ListInstancesResponse",
"type": "object",
"description": "Response message for the list instance request."
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"properties": {
"metadata": {
"description": "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.",
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
},
"type": "object"
},
"error": {
"description": "The error result of the operation in case of failure or cancellation.",
"$ref": "Status"
},
"name": {
"type": "string",
"description": "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}`."
},
"response": {
"description": "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`.",
"type": "object",
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
}
},
"done": {
"type": "boolean",
"description": "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."
}
},
"id": "Operation",
"type": "object"
},
"Version": {
"id": "Version",
"type": "object",
"description": "The Data Fusion version. This proto message stores information about certain Data Fusion version, which is used for Data Fusion version upgrade.",
"properties": {
"defaultVersion": {
"type": "boolean",
"description": "Whether this is currently the default version for Cloud Data Fusion"
},
"versionNumber": {
"type": "string",
"description": "The version number of the Data Fusion instance, such as '6.0.1.0'."
},
"availableFeatures": {
"type": "array",
"items": {
"type": "string"
},
"description": "Represents a list of available feature names for a given version."
}
}
},
"Instance": {
"type": "object",
"properties": {
"serviceAccount": {
"readOnly": true,
"description": "Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.",
"type": "string"
},
"accelerators": {
"type": "array",
"description": "List of accelerators enabled for this CDF instance.",
"items": {
"$ref": "Accelerator"
}
},
"networkConfig": {
"$ref": "NetworkConfig",
"description": "Network configuration options. These are required when a private Data Fusion instance is to be created."
},
"enableStackdriverLogging": {
"type": "boolean",
"description": "Option to enable Stackdriver Logging."
},
"version": {
"type": "string",
"description": "Current version of the Data Fusion. Only specifiable in Update."
},
"description": {
"type": "string",
"description": "A description of this instance."
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "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."
},
"dataprocServiceAccount": {
"type": "string",
"description": "User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources."
},
"enableStackdriverMonitoring": {
"type": "boolean",
"description": "Option to enable Stackdriver Monitoring."
},
"gcsBucket": {
"type": "string",
"description": "Output only. Cloud Storage bucket generated by Data Fusion in the customer project.",
"readOnly": true
},
"availableVersion": {
"type": "array",
"description": "Available versions that the instance can be upgraded to using UpdateInstanceRequest.",
"items": {
"$ref": "Version"
}
},
"options": {
"description": "Map of additional options used to configure the behavior of Data Fusion instance.",
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"zone": {
"description": "Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field.",
"type": "string"
},
"createTime": {
"type": "string",
"readOnly": true,
"description": "Output only. The time the instance was created.",
"format": "google-datetime"
},
"apiEndpoint": {
"type": "string",
"readOnly": true,
"description": "Output only. Endpoint on which the REST APIs is accessible."
},
"privateInstance": {
"type": "boolean",
"description": "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."
},
"name": {
"description": "Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.",
"type": "string",
"readOnly": true
},
"state": {
"description": "Output only. The current state of this Data Fusion instance.",
"enumDescriptions": [
"Instance does not have a state yet",
"Instance is being created",
"Instance is active and ready for requests. This corresponds to 'RUNNING' in datafusion.v1beta1.",
"Instance creation failed",
"Instance is being deleted",
"Instance is being upgraded",
"Instance is being restarted",
"Instance is being updated on customer request",
"Instance is being auto-updated",
"Instance is being auto-upgraded"
],
"enum": [
"STATE_UNSPECIFIED",
"CREATING",
"ACTIVE",
"FAILED",
"DELETING",
"UPGRADING",
"RESTARTING",
"UPDATING",
"AUTO_UPDATING",
"AUTO_UPGRADING"
],
"readOnly": true,
"type": "string"
},
"tenantProjectId": {
"readOnly": true,
"type": "string",
"description": "Output only. The name of the tenant project."
},
"updateTime": {
"type": "string",
"description": "Output only. The time the instance was last updated.",
"format": "google-datetime",
"readOnly": true
},
"type": {
"enumDescriptions": [
"No type specified. The instance creation will fail.",
"Basic Data Fusion instance. In Basic type, the user will be able to create data pipelines using point and click UI. However, there are certain limitations, such as fewer number of concurrent pipelines, no support for streaming pipelines, etc.",
"Enterprise Data Fusion instance. In Enterprise type, the user will have all features available, such as support for streaming pipelines, higher number of concurrent pipelines, etc.",
"Developer Data Fusion instance. In Developer type, the user will have all features available but with restrictive capabilities. This is to help enterprises design and develop their data ingestion and integration pipelines at low cost."
],
"enum": [
"TYPE_UNSPECIFIED",
"BASIC",
"ENTERPRISE",
"DEVELOPER"
],
"type": "string",
"description": "Required. Instance type."
},
"displayName": {
"description": "Display name for an instance.",
"type": "string"
},
"stateMessage": {
"description": "Output only. Additional information about the current state of this Data Fusion instance if available.",
"readOnly": true,
"type": "string"
},
"p4ServiceAccount": {
"description": "Output only. P4 service account for the customer project.",
"type": "string",
"readOnly": true
},
"serviceEndpoint": {
"type": "string",
"description": "Output only. Endpoint on which the Data Fusion UI is accessible.",
"readOnly": true
}
},
"description": "Represents a Data Fusion instance.",
"id": "Instance"
},
"NetworkConfig": {
"description": "Network configuration for a Data Fusion instance. These configurations 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.",
"id": "NetworkConfig",
"properties": {
"network": {
"type": "string",
"description": "Name of the network in the customer project with which the Tenant Project will be peered for executing pipelines. In case of shared VPC where the network resides in another host project the network should specified in the form of projects/{host-project-id}/global/networks/{network}"
},
"ipAllocation": {
"type": "string",
"description": "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 customer network."
}
},
"type": "object"
},
"RestartInstanceRequest": {
"description": "Request message for restarting a Data Fusion instance.",
"properties": {},
"id": "RestartInstanceRequest",
"type": "object"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"type": "object",
"id": "TestIamPermissionsResponse",
"properties": {
"permissions": {
"items": {
"type": "string"
},
"type": "array",
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed."
}
}
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"type": "string",
"description": "The standard List next-page token."
},
"operations": {
"type": "array",
"items": {
"$ref": "Operation"
},
"description": "A list of operations that matches the specified filter in the request."
}
},
"type": "object"
},
"TestIamPermissionsRequest": {
"id": "TestIamPermissionsRequest",
"type": "object",
"description": "Request message for `TestIamPermissions` method.",
"properties": {
"permissions": {
"type": "array",
"description": "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).",
"items": {
"type": "string"
}
}
}
},
"AuditConfig": {
"id": "AuditConfig",
"description": "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:[email protected]\" ] }, { \"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:[email protected]\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging.",
"type": "object",
"properties": {
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.",
"items": {
"$ref": "AuditLogConfig"
},
"type": "array"
},
"service": {
"type": "string",
"description": "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."
}
}
},
"Status": {
"properties": {
"message": {
"type": "string",
"description": "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": {
"type": "integer",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32"
},
"details": {
"type": "array",
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"type": "object",
"additionalProperties": {
"type": "any",
"description": "Properties of the object. Contains field @type with type URL."
}
}
}
},
"type": "object",
"id": "Status",
"description": "The `Status` type defines a logical error model that is suitable for 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)."
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"properties": {
"policy": {
"description": "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.",
"$ref": "Policy"
},
"updateMask": {
"format": "google-fieldmask",
"description": "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\"`",
"type": "string"
}
},
"type": "object",
"id": "SetIamPolicyRequest"
}
},
"title": "Cloud Data Fusion API",
"discoveryVersion": "v1",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"name": "datafusion",
"version": "v1",
"rootUrl": "https://datafusion.googleapis.com/",
"servicePath": "",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"canonicalName": "Data Fusion",
"parameters": {
"uploadType": {
"type": "string",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query"
},
"callback": {
"location": "query",
"type": "string",
"description": "JSONP"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"type": "string",
"location": "query"
},
"fields": {
"location": "query",
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"$.xgafv": {
"location": "query",
"type": "string",
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"enum": [
"1",
"2"
],
"description": "V1 error format."
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"access_token": {
"type": "string",
"location": "query",
"description": "OAuth access token."
},
"prettyPrint": {
"location": "query",
"type": "boolean",
"default": "true",
"description": "Returns response with indentations and line breaks."
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"alt": {
"default": "json",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"description": "Data format for response.",
"type": "string",
"enum": [
"json",
"media",
"proto"
]
},
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
}
},
"kind": "discovery#restDescription",
"basePath": "",
"ownerDomain": "google.com",
"fullyEncodeReservedExpansion": true,
"ownerName": "Google"
}