+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. The name of this `AuthorizedOrgsDesc` will be assigned during creation.
+ +Deletes a authorized orgs desc based on the resource name. The long-running operation from this RPC has a successful status after the authorized orgs desc is removed from long-lasting storage.
+ +Gets a authorized orgs desc based on the resource name.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all authorized orgs descs for an access policy.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. Only the organization list in `AuthorizedOrgsDesc` can be updated. The name, authorization_type, asset_type and authorization_direction cannot be updated.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates a authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. The name of this `AuthorizedOrgsDesc` will be assigned during creation.
+
+Args:
+ parent: string, Required. Resource name for the access policy which owns this Authorized Orgs Desc. Format: `accessPolicies/{policy_id}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # `AuthorizedOrgsDesc` is a resource that contains a list of organizations for a authorization type and asset type and its authorization direction.
+ "assetType": "A String", # The asset type of this authorized orgs desc. e.g. device, credential strength.
+ "authorizationDirection": "A String", # Authorization direction of this authorization relationship. i.e. Whether to allow specified orgs to evaluate this org's traffic, or allow specified orgs' traffic to be evaluated by this org. Orgs specified as `AUTHORIZATION_DIRECTION_TO` in this AuthorizedOrgsDesc[com.google.identity.accesscontextmanager.v1.AuthorizedOrgsDesc] must also specify this org as the `AUTHORIZATION_DIRECTION_FROM` in their own AuthorizedOrgsDesc in order for this relationship to take effect. Orgs specified as `AUTHORIZATION_DIRECTION_FROM` in this AuthorizedOrgsDesc[com.google.identity.accesscontextmanager.v1.AuthorizedOrgsDesc] must also specify this org as the `AUTHORIZATION_DIRECTION_TO` in their own AuthorizedOrgsDesc in order for this relationship to take effect.
+ "authorizationType": "A String", # The authorization type of this authorized orgs desc. e.g.authorization, troubleshooting or logging.
+ "name": "A String", # Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "accessPolicies/122256/authorizedOrgs/b3-BhcX_Ud5N"
+ "orgs": [ # The list of organization ids in this AuthorizedOrgsDesc.
+ "A String",
+ ],
+}
+
+ 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.
+ "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.
+ "error": { # 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). # The error result of the operation in case of failure or cancellation.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "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.
+ },
+ "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}`.
+ "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.
+ },
+}
+delete(name, x__xgafv=None)
+ Deletes a authorized orgs desc based on the resource name. The long-running operation from this RPC has a successful status after the authorized orgs desc is removed from long-lasting storage.
+
+Args:
+ name: string, Required. Resource name for the Authorized Orgs Desc. Format: `accessPolicies/{policy_id}/authorizedOrgsDesc/{authorized_orgs_desc_id}` (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.
+ "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.
+ "error": { # 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). # The error result of the operation in case of failure or cancellation.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "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.
+ },
+ "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}`.
+ "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.
+ },
+}
+get(name, x__xgafv=None)
+ Gets a authorized orgs desc based on the resource name.
+
+Args:
+ name: string, Required. Resource name for the Authorized Orgs Desc. Format: `accessPolicies/{policy_id}/authorizedOrgsDescs/{authorized_orgs_descs_id}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `AuthorizedOrgsDesc` is a resource that contains a list of organizations for a authorization type and asset type and its authorization direction.
+ "assetType": "A String", # The asset type of this authorized orgs desc. e.g. device, credential strength.
+ "authorizationDirection": "A String", # Authorization direction of this authorization relationship. i.e. Whether to allow specified orgs to evaluate this org's traffic, or allow specified orgs' traffic to be evaluated by this org. Orgs specified as `AUTHORIZATION_DIRECTION_TO` in this AuthorizedOrgsDesc[com.google.identity.accesscontextmanager.v1.AuthorizedOrgsDesc] must also specify this org as the `AUTHORIZATION_DIRECTION_FROM` in their own AuthorizedOrgsDesc in order for this relationship to take effect. Orgs specified as `AUTHORIZATION_DIRECTION_FROM` in this AuthorizedOrgsDesc[com.google.identity.accesscontextmanager.v1.AuthorizedOrgsDesc] must also specify this org as the `AUTHORIZATION_DIRECTION_TO` in their own AuthorizedOrgsDesc in order for this relationship to take effect.
+ "authorizationType": "A String", # The authorization type of this authorized orgs desc. e.g.authorization, troubleshooting or logging.
+ "name": "A String", # Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "accessPolicies/122256/authorizedOrgs/b3-BhcX_Ud5N"
+ "orgs": [ # The list of organization ids in this AuthorizedOrgsDesc.
+ "A String",
+ ],
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all authorized orgs descs for an access policy.
+
+Args:
+ parent: string, Required. Resource name for the access policy to list Authorized Orgs Desc from. Format: `accessPolicies/{policy_id}` (required)
+ pageSize: integer, Number of Authorized Orgs Descs to include in the list. Default 100.
+ pageToken: string, Next page token for the next batch of Authorized Orgs Desc instances. Defaults to the first page of results.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A response to `ListAuthorizedOrgsDescsRequest`.
+ "authorizedOrgsDescs": [ # List of the Authorized Orgs Desc instances.
+ { # `AuthorizedOrgsDesc` is a resource that contains a list of organizations for a authorization type and asset type and its authorization direction.
+ "assetType": "A String", # The asset type of this authorized orgs desc. e.g. device, credential strength.
+ "authorizationDirection": "A String", # Authorization direction of this authorization relationship. i.e. Whether to allow specified orgs to evaluate this org's traffic, or allow specified orgs' traffic to be evaluated by this org. Orgs specified as `AUTHORIZATION_DIRECTION_TO` in this AuthorizedOrgsDesc[com.google.identity.accesscontextmanager.v1.AuthorizedOrgsDesc] must also specify this org as the `AUTHORIZATION_DIRECTION_FROM` in their own AuthorizedOrgsDesc in order for this relationship to take effect. Orgs specified as `AUTHORIZATION_DIRECTION_FROM` in this AuthorizedOrgsDesc[com.google.identity.accesscontextmanager.v1.AuthorizedOrgsDesc] must also specify this org as the `AUTHORIZATION_DIRECTION_TO` in their own AuthorizedOrgsDesc in order for this relationship to take effect.
+ "authorizationType": "A String", # The authorization type of this authorized orgs desc. e.g.authorization, troubleshooting or logging.
+ "name": "A String", # Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "accessPolicies/122256/authorizedOrgs/b3-BhcX_Ud5N"
+ "orgs": [ # The list of organization ids in this AuthorizedOrgsDesc.
+ "A String",
+ ],
+ },
+ ],
+ "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
+}
+list_next()
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates a authorized orgs desc. The long-running operation from this RPC has a successful status after the authorized orgs desc propagates to long-lasting storage. If a authorized orgs desc contains errors, an error response is returned for the first error encountered. Only the organization list in `AuthorizedOrgsDesc` can be updated. The name, authorization_type, asset_type and authorization_direction cannot be updated.
+
+Args:
+ name: string, Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "accessPolicies/122256/authorizedOrgs/b3-BhcX_Ud5N" (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # `AuthorizedOrgsDesc` is a resource that contains a list of organizations for a authorization type and asset type and its authorization direction.
+ "assetType": "A String", # The asset type of this authorized orgs desc. e.g. device, credential strength.
+ "authorizationDirection": "A String", # Authorization direction of this authorization relationship. i.e. Whether to allow specified orgs to evaluate this org's traffic, or allow specified orgs' traffic to be evaluated by this org. Orgs specified as `AUTHORIZATION_DIRECTION_TO` in this AuthorizedOrgsDesc[com.google.identity.accesscontextmanager.v1.AuthorizedOrgsDesc] must also specify this org as the `AUTHORIZATION_DIRECTION_FROM` in their own AuthorizedOrgsDesc in order for this relationship to take effect. Orgs specified as `AUTHORIZATION_DIRECTION_FROM` in this AuthorizedOrgsDesc[com.google.identity.accesscontextmanager.v1.AuthorizedOrgsDesc] must also specify this org as the `AUTHORIZATION_DIRECTION_TO` in their own AuthorizedOrgsDesc in order for this relationship to take effect.
+ "authorizationType": "A String", # The authorization type of this authorized orgs desc. e.g.authorization, troubleshooting or logging.
+ "name": "A String", # Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "accessPolicies/122256/authorizedOrgs/b3-BhcX_Ud5N"
+ "orgs": [ # The list of organization ids in this AuthorizedOrgsDesc.
+ "A String",
+ ],
+}
+
+ updateMask: string, Required. Mask to control which fields get updated. Must be non-empty.
+ 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.
+ "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.
+ "error": { # 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). # The error result of the operation in case of failure or cancellation.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "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.
+ },
+ "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}`.
+ "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.
+ },
+}
+Returns the accessLevels Resource.
+ +Returns the authorizedOrgsDescs Resource.
+ diff --git a/docs/dyn/androidenterprise_v1.enterprises.html b/docs/dyn/androidenterprise_v1.enterprises.html index 4e62b7b21b6..691d98f9ecc 100644 --- a/docs/dyn/androidenterprise_v1.enterprises.html +++ b/docs/dyn/androidenterprise_v1.enterprises.html @@ -83,6 +83,9 @@
completeSignup(completionToken=None, enterpriseToken=None, x__xgafv=None)
Completes the signup flow, by specifying the Completion token and Enterprise token. This request must not be called multiple times for a given Enterprise Token.
+
+ createEnrollmentToken(enterpriseId, deviceType=None, x__xgafv=None)
Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.
createWebToken(enterpriseId, body=None, x__xgafv=None)
Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information.
@@ -165,6 +168,30 @@createEnrollmentToken(enterpriseId, deviceType=None, x__xgafv=None)
+ Returns a token for device enrollment. The DPC can encode this token within the QR/NFC/zero-touch enrollment payload or fetch it before calling the on-device API to authenticate the user. The token can be generated for each device or reused across multiple devices.
+
+Args:
+ enterpriseId: string, The ID of the enterprise. (required)
+ deviceType: string, Whether it’s a dedicated device or a knowledge worker device.
+ Allowed values
+ unknown - This value is unused
+ dedicatedDevice - This device is a dedicated device.
+ knowledgeWorker - This device is required to have an authenticated user.
+ 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 create enrollment token.
+ "enrollmentToken": "A String", # Enrollment token.
+}
+createWebToken(enterpriseId, body=None, x__xgafv=None)
Returns a unique token to access an embeddable UI. To generate a web UI, pass the generated token into the managed Google Play javascript API. Each token may only be used to start one UI session. See the javascript API documentation for further information. @@ -384,7 +411,7 @@Method Details
Pulls and returns a notification set for the enterprises associated with the service account authenticated for the request. The notification set may be empty if no notification are pending. A notification set returned needs to be acknowledged within 20 seconds by calling Enterprises.AcknowledgeNotificationSet, unless the notification set is empty. Notifications that are not acknowledged within the 20 seconds will eventually be included again in the response to another PullNotificationSet request, and those that are never acknowledged will ultimately be deleted according to the Google Cloud Platform Pub/Sub system policy. Multiple requests might be performed concurrently to retrieve notifications, in which case the pending notifications (if any) will be split among each caller, if any are pending. If no notifications are present, an empty notification list is returned. Subsequent requests may return more notifications once they become available. Args: - requestMode: string, The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Speciying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications. + requestMode: string, The request mode for pulling notifications. Specifying waitForNotifications will cause the request to block and wait until one or more notifications are present, or return an empty notification list if no notifications are present after some time. Specifying returnImmediately will cause the request to immediately return the pending notifications, or an empty list if no notifications are present. If omitted, defaults to waitForNotifications. Allowed values waitForNotifications - Wait until one or more notifications are present. returnImmediately - Returns immediately whether notifications are present or not. diff --git a/docs/dyn/apigee_v1.organizations.envgroups.html b/docs/dyn/apigee_v1.organizations.envgroups.html index 14ca097997e..fff371980a3 100644 --- a/docs/dyn/apigee_v1.organizations.envgroups.html +++ b/docs/dyn/apigee_v1.organizations.envgroups.html @@ -91,6 +91,9 @@Instance Methods
Gets an environment group.
++
+getDeployedIngressConfig(name, view=None, x__xgafv=None)Gets the deployed ingress configuration for an environment group.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)Lists all environment groups.
@@ -215,6 +218,57 @@Method Details
}
getDeployedIngressConfig(name, view=None, x__xgafv=None)
+ Gets the deployed ingress configuration for an environment group.
+
+Args:
+ name: string, Required. Name of the deployed configuration for the environment group in the following format: 'organizations/{org}/envgroups/{envgroup}/deployedIngressConfig'. (required)
+ view: string, When set to FULL, additional details about the specific deployments receiving traffic will be included in the IngressConfig response's RoutingRules.
+ Allowed values
+ INGRESS_CONFIG_VIEW_UNSPECIFIED - The default/unset value. The API will default to the BASIC view.
+ BASIC - Include all ingress config data necessary for the runtime to configure ingress, but no more. Routing rules will include only basepath and destination environment. This the default value.
+ FULL - Include all ingress config data, including internal debug info for each routing rule such as the proxy claiming a particular basepath and when the routing rule first appeared in the env group.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its associated routing rules.
+ "endpointChainingRules": [ # A list of proxies in each deployment group for proxy chaining calls.
+ { # EndpointChainingRule specifies the proxies contained in a particular deployment group, so that other deployment groups can find them in chaining calls.
+ "deploymentGroup": "A String", # The deployment group to target for cross-shard chaining calls to these proxies.
+ "proxyIds": [ # List of proxy ids which may be found in the given deployment group.
+ "A String",
+ ],
+ },
+ ],
+ "hostnames": [ # Host names for the environment group.
+ "A String",
+ ],
+ "location": "A String", # When this message appears in the top-level IngressConfig, this field will be populated in lieu of the inlined routing_rules and hostnames fields. Some URL for downloading the full EnvironmentGroupConfig for this group.
+ "name": "A String", # Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`.
+ "revisionId": "A String", # Revision id that defines the ordering of the EnvironmentGroupConfig resource. The higher the revision, the more recently the configuration was deployed.
+ "routingRules": [ # Ordered list of routing rules defining how traffic to this environment group's hostnames should be routed to different environments.
+ {
+ "basepath": "A String", # URI path prefix used to route to the specified environment. May contain one or more wildcards. For example, path segments consisting of a single `*` character will match any string.
+ "deploymentGroup": "A String", # Name of a deployment group in an environment bound to the environment group in the following format: `organizations/{org}/environment/{env}/deploymentGroups/{group}` Only one of environment or deployment_group will be set.
+ "envGroupRevision": "A String", # The env group config revision_id when this rule was added or last updated. This value is set when the rule is created and will only update if the the environment_id changes. It is used to determine if the runtime is up to date with respect to this rule. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL.
+ "environment": "A String", # Name of an environment bound to the environment group in the following format: `organizations/{org}/environments/{env}`. Only one of environment or deployment_group will be set.
+ "otherTargets": [ # Conflicting targets, which will be resource names specifying either deployment groups or environments.
+ "A String",
+ ],
+ "receiver": "A String", # The resource name of the proxy revision that is receiving this basepath in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL.
+ "updateTime": "A String", # The unix timestamp when this rule was updated. This is updated whenever env_group_revision is updated. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL.
+ },
+ ],
+ "uid": "A String", # A unique id for the environment group config that will only change if the environment group is deleted and recreated.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all environment groups. diff --git a/docs/dyn/apigee_v1.organizations.environments.html b/docs/dyn/apigee_v1.organizations.environments.html index fdea44d1e02..935be578fe9 100644 --- a/docs/dyn/apigee_v1.organizations.environments.html +++ b/docs/dyn/apigee_v1.organizations.environments.html @@ -481,12 +481,25 @@Method Details
"A String", ], }, + "deploymentGroups": [ # List of deployment groups in the environment. + { # DeploymentGroupConfig represents a deployment group that should be present in a particular environment. + "name": "A String", # Name of the deployment group in the following format: `organizations/{org}/environments/{env}/deploymentGroups/{group}`. + "revisionId": "A String", # Revision number which can be used by the runtime to detect if the deployment group has changed between two versions. + "uid": "A String", # Unique ID. The ID will only change if the deployment group is deleted and recreated. + }, + ], "deployments": [ # List of deployments in the environment. - { # NEXT ID: 9 + { # NEXT ID: 11 "attributes": { # Additional key-value metadata for the deployment. "a_key": "A String", }, "basePath": "A String", # Base path where the application will be hosted. Defaults to "/". + "deploymentGroups": [ # The list of deployment groups in which this proxy should be deployed. Not currently populated for shared flows. + "A String", + ], + "endpoints": { # A mapping from basepaths to proxy endpoint names in this proxy. Not populated for shared flows. + "a_key": "A String", + }, "location": "A String", # Location of the API proxy bundle as a URI. "name": "A String", # Name of the API or shared flow revision to be deployed in the following format: `organizations/{org}/apis/{api}/revisions/{rev}` or `organizations/{org}/sharedflows/{sharedflow}/revisions/{rev}` "proxyUid": "A String", # Unique ID of the API proxy revision. @@ -494,6 +507,7 @@Method Details
"uid": "A String", # Unique ID. The ID will only change if the deployment is deleted and recreated. }, ], + "envScopedRevisionId": "A String", # Revision ID for environment-scoped resources (e.g. target servers, keystores) in this config. This ID will increment any time a resource not scoped to a deployment group changes. "featureFlags": { # Feature flags inherited from the organization and environment. "a_key": "A String", }, diff --git a/docs/dyn/apigee_v1.organizations.environments.targetservers.html b/docs/dyn/apigee_v1.organizations.environments.targetservers.html index 9b4683d0094..6e4b7c11ead 100644 --- a/docs/dyn/apigee_v1.organizations.environments.targetservers.html +++ b/docs/dyn/apigee_v1.organizations.environments.targetservers.html @@ -104,7 +104,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. +{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. "description": "A String", # Optional. A human-readable description of this TargetServer. "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. @@ -140,7 +140,7 @@Method Details
Returns: An object of the form: - { # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. + { # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. "description": "A String", # Optional. A human-readable description of this TargetServer. "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. @@ -182,7 +182,7 @@Method Details
Returns: An object of the form: - { # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. + { # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. "description": "A String", # Optional. A human-readable description of this TargetServer. "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. @@ -224,7 +224,7 @@Method Details
Returns: An object of the form: - { # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. + { # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. "description": "A String", # Optional. A human-readable description of this TargetServer. "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. @@ -261,7 +261,7 @@Method Details
body: object, The request body. The object takes the form of: -{ # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. +{ # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. "description": "A String", # Optional. A human-readable description of this TargetServer. "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. @@ -296,7 +296,7 @@Method Details
Returns: An object of the form: - { # TargetServer configuration. TargetServers are used to decouple a proxy's TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. + { # TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services. "description": "A String", # Optional. A human-readable description of this TargetServer. "host": "A String", # Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. "isEnabled": True or False, # Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. diff --git a/docs/dyn/apigee_v1.organizations.html b/docs/dyn/apigee_v1.organizations.html index 982f5a15f24..568cf9c701a 100644 --- a/docs/dyn/apigee_v1.organizations.html +++ b/docs/dyn/apigee_v1.organizations.html @@ -445,16 +445,29 @@Method Details
{ "environmentGroups": [ # List of environment groups in the organization. { # EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its associated routing rules. + "endpointChainingRules": [ # A list of proxies in each deployment group for proxy chaining calls. + { # EndpointChainingRule specifies the proxies contained in a particular deployment group, so that other deployment groups can find them in chaining calls. + "deploymentGroup": "A String", # The deployment group to target for cross-shard chaining calls to these proxies. + "proxyIds": [ # List of proxy ids which may be found in the given deployment group. + "A String", + ], + }, + ], "hostnames": [ # Host names for the environment group. "A String", ], + "location": "A String", # When this message appears in the top-level IngressConfig, this field will be populated in lieu of the inlined routing_rules and hostnames fields. Some URL for downloading the full EnvironmentGroupConfig for this group. "name": "A String", # Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`. "revisionId": "A String", # Revision id that defines the ordering of the EnvironmentGroupConfig resource. The higher the revision, the more recently the configuration was deployed. "routingRules": [ # Ordered list of routing rules defining how traffic to this environment group's hostnames should be routed to different environments. { "basepath": "A String", # URI path prefix used to route to the specified environment. May contain one or more wildcards. For example, path segments consisting of a single `*` character will match any string. + "deploymentGroup": "A String", # Name of a deployment group in an environment bound to the environment group in the following format: `organizations/{org}/environment/{env}/deploymentGroups/{group}` Only one of environment or deployment_group will be set. "envGroupRevision": "A String", # The env group config revision_id when this rule was added or last updated. This value is set when the rule is created and will only update if the the environment_id changes. It is used to determine if the runtime is up to date with respect to this rule. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL. - "environment": "A String", # Name of an environment bound to the environment group in the following format: `organizations/{org}/environments/{env}`. + "environment": "A String", # Name of an environment bound to the environment group in the following format: `organizations/{org}/environments/{env}`. Only one of environment or deployment_group will be set. + "otherTargets": [ # Conflicting targets, which will be resource names specifying either deployment groups or environments. + "A String", + ], "receiver": "A String", # The resource name of the proxy revision that is receiving this basepath in the following format: `organizations/{org}/apis/{api}/revisions/{rev}`. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL. "updateTime": "A String", # The unix timestamp when this rule was updated. This is updated whenever env_group_revision is updated. This field is omitted from the IngressConfig unless the GetDeployedIngressConfig API is called with view=FULL. }, diff --git a/docs/dyn/batch_v1.projects.locations.jobs.html b/docs/dyn/batch_v1.projects.locations.jobs.html index 0333a32407f..3a3b04988f1 100644 --- a/docs/dyn/batch_v1.projects.locations.jobs.html +++ b/docs/dyn/batch_v1.projects.locations.jobs.html @@ -233,6 +233,13 @@Method Details
"taskCountPerNode": "A String", # Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements. "taskEnvironments": [ # An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). task_environments supports up to 200 entries. { # An Environment describes a collection of environment variables to set when executing Tasks. + "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. + "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text. + }, + "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. + "a_key": "A String", + }, "variables": { # A map of environment variable names to values. "a_key": "A String", }, @@ -245,6 +252,13 @@Method Details
"memoryMib": "A String", # Memory in MiB. }, "environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables to set before running the Task. + "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. + "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text. + }, + "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. + "a_key": "A String", + }, "variables": { # A map of environment variable names to values. "a_key": "A String", }, @@ -286,6 +300,13 @@Method Details
], }, "environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup). + "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. + "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text. + }, + "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. + "a_key": "A String", + }, "variables": { # A map of environment variable names to values. "a_key": "A String", }, @@ -443,6 +464,13 @@Method Details
"taskCountPerNode": "A String", # Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements. "taskEnvironments": [ # An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). task_environments supports up to 200 entries. { # An Environment describes a collection of environment variables to set when executing Tasks. + "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. + "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text. + }, + "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. + "a_key": "A String", + }, "variables": { # A map of environment variable names to values. "a_key": "A String", }, @@ -455,6 +483,13 @@Method Details
"memoryMib": "A String", # Memory in MiB. }, "environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables to set before running the Task. + "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. + "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text. + }, + "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. + "a_key": "A String", + }, "variables": { # A map of environment variable names to values. "a_key": "A String", }, @@ -496,6 +531,13 @@Method Details
], }, "environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup). + "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. + "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text. + }, + "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. + "a_key": "A String", + }, "variables": { # A map of environment variable names to values. "a_key": "A String", }, @@ -695,6 +737,13 @@Method Details
"taskCountPerNode": "A String", # Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements. "taskEnvironments": [ # An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). task_environments supports up to 200 entries. { # An Environment describes a collection of environment variables to set when executing Tasks. + "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. + "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text. + }, + "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. + "a_key": "A String", + }, "variables": { # A map of environment variable names to values. "a_key": "A String", }, @@ -707,6 +756,13 @@Method Details
"memoryMib": "A String", # Memory in MiB. }, "environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables to set before running the Task. + "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. + "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text. + }, + "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. + "a_key": "A String", + }, "variables": { # A map of environment variable names to values. "a_key": "A String", }, @@ -748,6 +804,13 @@Method Details
], }, "environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup). + "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. + "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text. + }, + "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. + "a_key": "A String", + }, "variables": { # A map of environment variable names to values. "a_key": "A String", }, @@ -963,6 +1026,13 @@Method Details
"taskCountPerNode": "A String", # Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements. "taskEnvironments": [ # An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1). task_environments supports up to 200 entries. { # An Environment describes a collection of environment variables to set when executing Tasks. + "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. + "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text. + }, + "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. + "a_key": "A String", + }, "variables": { # A map of environment variable names to values. "a_key": "A String", }, @@ -975,6 +1045,13 @@Method Details
"memoryMib": "A String", # Memory in MiB. }, "environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables to set before running the Task. + "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. + "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text. + }, + "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. + "a_key": "A String", + }, "variables": { # A map of environment variable names to values. "a_key": "A String", }, @@ -1016,6 +1093,13 @@Method Details
], }, "environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup). + "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. + "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text. + }, + "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. + "a_key": "A String", + }, "variables": { # A map of environment variable names to values. "a_key": "A String", }, diff --git a/docs/dyn/batch_v1.projects.locations.state.html b/docs/dyn/batch_v1.projects.locations.state.html index 9ef5bdd3d43..e1d676d0ed5 100644 --- a/docs/dyn/batch_v1.projects.locations.state.html +++ b/docs/dyn/batch_v1.projects.locations.state.html @@ -126,12 +126,13 @@Method Details
"bootTime": "A String", # Boot timestamp of the VM OS "scriptStartupTime": "A String", # Startup time of the Batch VM script. }, - "metadata": { # AgentMetadata never changes for a single instance of VM agent. # Agent metadata. + "metadata": { # VM Agent Metadata. # Agent metadata. "creationTime": "A String", # When the VM agent started. Use agent_startup_time instead. "creator": "A String", # Full name of the entity that created this vm. For MIG, this path is: projects/{project}/regions/{region}/InstanceGroupManagers/{igm} The value is retrieved from the vm metadata key of "created-by". "imageVersion": "A String", # image version for the VM that this agent is installed on. "instance": "A String", # GCP instance name (go/instance-name). "instanceId": "A String", # GCP instance ID (go/instance-id). + "instancePreemptionNoticeReceived": True or False, # If the GCP instance has received preemption notice. "osRelease": { # parsed contents of /etc/os-release "a_key": "A String", }, @@ -149,6 +150,7 @@Method Details
An object of the form: { # Response to ReportAgentStateRequest. + "defaultReportInterval": "A String", # Default report interval override "minReportInterval": "A String", # Minimum report interval override "tasks": [ # Tasks assigned to the agent { # TODO(b/182501497) The message needs to be redefined when the Agent API server updates data in storage per the backend design. @@ -161,6 +163,13 @@Method Details
"memoryMib": "A String", # Memory in MiB. }, "environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables to set before running the Task. + "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. + "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text. + }, + "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. + "a_key": "A String", + }, "variables": { # A map of environment variable names to values. "a_key": "A String", }, @@ -202,6 +211,13 @@Method Details
], }, "environment": { # An Environment describes a collection of environment variables to set when executing Tasks. # Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup). + "encryptedVariables": { # An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. + "cipherText": "A String", # The value of the cipherText response from the `encrypt` method. + "keyName": "A String", # The name of the KMS key that will be used to decrypt the cipher text. + }, + "secretVariables": { # A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. + "a_key": "A String", + }, "variables": { # A map of environment variable names to values. "a_key": "A String", }, diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index 53119092f55..516da4a4923 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -84,7 +84,7 @@Instance Methods
Close httplib2 connections.
-Creates a message. For example usage, see [Create a message](https://developers.google.com/chat/api/guides/crudl/messages#create_a_message). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Supports [user authentication](https://developers.google.com/chat/api/guides/auth/users) as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` or `chat.messages.create` authorization scope.
+Creates a message. For example usage, see [Create a message](https://developers.google.com/chat/api/guides/crudl/messages#create_a_message). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Supports [user authentication](https://developers.google.com/chat/api/guides/auth/users) as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` or `chat.messages.create` authorization scope. Because Chat provides authentication for [webhooks](https://developers.google.com/chat/how-tos/webhooks) as part of the URL that's generated when a webhook is registered, webhooks can create messages without a service account or user authentication.
Deletes a message. For example usage, see [Delete a message](https://developers.google.com/chat/api/guides/crudl/messages#delete_a_message). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Supports [user authentication](https://developers.google.com/chat/api/guides/auth/users) as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` authorization scope.
@@ -105,7 +105,7 @@Method Details
@@ -350,7 +347,7 @@create(parent, body=None, messageId=None, messageReplyOption=None, requestId=None, threadKey=None, x__xgafv=None)-Creates a message. For example usage, see [Create a message](https://developers.google.com/chat/api/guides/crudl/messages#create_a_message). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Supports [user authentication](https://developers.google.com/chat/api/guides/auth/users) as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` or `chat.messages.create` authorization scope. +Creates a message. For example usage, see [Create a message](https://developers.google.com/chat/api/guides/crudl/messages#create_a_message). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts). Supports [user authentication](https://developers.google.com/chat/api/guides/auth/users) as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. [User authentication](https://developers.google.com/chat/api/guides/auth/users) requires the `chat.messages` or `chat.messages.create` authorization scope. Because Chat provides authentication for [webhooks](https://developers.google.com/chat/how-tos/webhooks) as part of the URL that's generated when a webhook is registered, webhooks can create messages without a service account or user authentication. Args: parent: string, Required. The resource name of the space in which to create a message. Format: spaces/{space} (required) diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html index 63ae5ed6dfe..ea6c9a5e35c 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.html @@ -133,13 +133,17 @@Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline. "updateTime": "A String", # Last time the condition was updated. }, - "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Detalis around targets enumerated in the pipeline. - "missingTargets": [ # The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}. + "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline. + "missingTargets": [ # The list of Target names that do not exist. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}. "A String", ], "status": True or False, # True if there aren't any missing Targets. "updateTime": "A String", # Last time the condition was updated. }, + "targetsTypeCondition": { # TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type. # Details on the whether the targets enumerated in the pipeline are of the same type. + "errorDetails": "A String", # Human readable error message. + "status": True or False, # True if the targets are all a comparable type. For example this is true if all targets are GKE clusters. This is false if some targets are Cloud Run targets and others are GKE clusters. + }, }, "createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Description of the `DeliveryPipeline`. Max length is 255 characters. @@ -263,13 +267,17 @@Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline. "updateTime": "A String", # Last time the condition was updated. }, - "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Detalis around targets enumerated in the pipeline. - "missingTargets": [ # The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}. + "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline. + "missingTargets": [ # The list of Target names that do not exist. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}. "A String", ], "status": True or False, # True if there aren't any missing Targets. "updateTime": "A String", # Last time the condition was updated. }, + "targetsTypeCondition": { # TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type. # Details on the whether the targets enumerated in the pipeline are of the same type. + "errorDetails": "A String", # Human readable error message. + "status": True or False, # True if the targets are all a comparable type. For example this is true if all targets are GKE clusters. This is false if some targets are Cloud Run targets and others are GKE clusters. + }, }, "createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Description of the `DeliveryPipeline`. Max length is 255 characters. @@ -376,13 +384,17 @@Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline. "updateTime": "A String", # Last time the condition was updated. }, - "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Detalis around targets enumerated in the pipeline. - "missingTargets": [ # The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}. + "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline. + "missingTargets": [ # The list of Target names that do not exist. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}. "A String", ], "status": True or False, # True if there aren't any missing Targets. "updateTime": "A String", # Last time the condition was updated. }, + "targetsTypeCondition": { # TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type. # Details on the whether the targets enumerated in the pipeline are of the same type. + "errorDetails": "A String", # Human readable error message. + "status": True or False, # True if the targets are all a comparable type. For example this is true if all targets are GKE clusters. This is false if some targets are Cloud Run targets and others are GKE clusters. + }, }, "createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Description of the `DeliveryPipeline`. Max length is 255 characters. @@ -450,13 +462,17 @@Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline. "updateTime": "A String", # Last time the condition was updated. }, - "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Detalis around targets enumerated in the pipeline. - "missingTargets": [ # The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}. + "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline. + "missingTargets": [ # The list of Target names that do not exist. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}. "A String", ], "status": True or False, # True if there aren't any missing Targets. "updateTime": "A String", # Last time the condition was updated. }, + "targetsTypeCondition": { # TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type. # Details on the whether the targets enumerated in the pipeline are of the same type. + "errorDetails": "A String", # Human readable error message. + "status": True or False, # True if the targets are all a comparable type. For example this is true if all targets are GKE clusters. This is false if some targets are Cloud Run targets and others are GKE clusters. + }, }, "createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Description of the `DeliveryPipeline`. Max length is 255 characters. diff --git a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html index d8284b9cc7e..df4917eb18e 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.deliveryPipelines.releases.html @@ -157,13 +157,17 @@Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline. "updateTime": "A String", # Last time the condition was updated. }, - "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Detalis around targets enumerated in the pipeline. - "missingTargets": [ # The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}. + "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline. + "missingTargets": [ # The list of Target names that do not exist. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}. "A String", ], "status": True or False, # True if there aren't any missing Targets. "updateTime": "A String", # Last time the condition was updated. }, + "targetsTypeCondition": { # TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type. # Details on the whether the targets enumerated in the pipeline are of the same type. + "errorDetails": "A String", # Human readable error message. + "status": True or False, # True if the targets are all a comparable type. For example this is true if all targets are GKE clusters. This is false if some targets are Cloud Run targets and others are GKE clusters. + }, }, "createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Description of the `DeliveryPipeline`. Max length is 255 characters. @@ -336,13 +340,17 @@Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline. "updateTime": "A String", # Last time the condition was updated. }, - "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Detalis around targets enumerated in the pipeline. - "missingTargets": [ # The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}. + "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline. + "missingTargets": [ # The list of Target names that do not exist. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}. "A String", ], "status": True or False, # True if there aren't any missing Targets. "updateTime": "A String", # Last time the condition was updated. }, + "targetsTypeCondition": { # TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type. # Details on the whether the targets enumerated in the pipeline are of the same type. + "errorDetails": "A String", # Human readable error message. + "status": True or False, # True if the targets are all a comparable type. For example this is true if all targets are GKE clusters. This is false if some targets are Cloud Run targets and others are GKE clusters. + }, }, "createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Description of the `DeliveryPipeline`. Max length is 255 characters. @@ -491,13 +499,17 @@Method Details
"status": True or False, # True if the Pipeline is in a valid state. Otherwise at least one condition in `PipelineCondition` is in an invalid state. Iterate over those conditions and see which condition(s) has status = false to find out what is wrong with the Pipeline. "updateTime": "A String", # Last time the condition was updated. }, - "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Detalis around targets enumerated in the pipeline. - "missingTargets": [ # The list of Target names that are missing. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}. + "targetsPresentCondition": { # TargetsPresentCondition contains information on any Targets defined in the Delivery Pipeline that do not actually exist. # Details around targets enumerated in the pipeline. + "missingTargets": [ # The list of Target names that do not exist. For example, projects/{project_id}/locations/{location_name}/targets/{target_name}. "A String", ], "status": True or False, # True if there aren't any missing Targets. "updateTime": "A String", # Last time the condition was updated. }, + "targetsTypeCondition": { # TargetsTypeCondition contains information on whether the Targets defined in the Delivery Pipeline are of the same type. # Details on the whether the targets enumerated in the pipeline are of the same type. + "errorDetails": "A String", # Human readable error message. + "status": True or False, # True if the targets are all a comparable type. For example this is true if all targets are GKE clusters. This is false if some targets are Cloud Run targets and others are GKE clusters. + }, }, "createTime": "A String", # Output only. Time at which the pipeline was created. "description": "A String", # Description of the `DeliveryPipeline`. Max length is 255 characters. diff --git a/docs/dyn/clouddeploy_v1.projects.locations.html b/docs/dyn/clouddeploy_v1.projects.locations.html index 33ac8913dc0..c5b0c31ee3e 100644 --- a/docs/dyn/clouddeploy_v1.projects.locations.html +++ b/docs/dyn/clouddeploy_v1.projects.locations.html @@ -152,11 +152,11 @@Method Details
An object of the form: { # Service-wide configuration. - "defaultSkaffoldVersion": "A String", # Output only. Default Skaffold version that is assigned when a Release is created without specifying a Skaffold version. + "defaultSkaffoldVersion": "A String", # Default Skaffold version that is assigned when a Release is created without specifying a Skaffold version. "name": "A String", # Name of the configuration. - "supportedVersions": [ # Output only. All supported versions of Skaffold. + "supportedVersions": [ # All supported versions of Skaffold. { # Details of a supported Skaffold version. - "supportEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date when this version is expected to no longer be supported. + "supportEndDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date when this version is expected to no longer be supported. For a more precise time, use the `support_expiration_time` field. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. diff --git a/docs/dyn/cloudfunctions_v2.projects.locations.functions.html b/docs/dyn/cloudfunctions_v2.projects.locations.functions.html index 68bc7ad0dff..82528058798 100644 --- a/docs/dyn/cloudfunctions_v2.projects.locations.functions.html +++ b/docs/dyn/cloudfunctions_v2.projects.locations.functions.html @@ -171,7 +171,7 @@Method Details
"workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project. }, "description": "A String", # User-provided description of a function. - "environment": "A String", # Describe whether the function is gen1 or gen2. + "environment": "A String", # Describe whether the function is 1st Gen or 2nd Gen. "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service. "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners. "eventFilters": [ # Criteria used to filter events. @@ -424,7 +424,7 @@Method Details
"workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project. }, "description": "A String", # User-provided description of a function. - "environment": "A String", # Describe whether the function is gen1 or gen2. + "environment": "A String", # Describe whether the function is 1st Gen or 2nd Gen. "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service. "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners. "eventFilters": [ # Criteria used to filter events. @@ -612,7 +612,7 @@Method Details
"workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project. }, "description": "A String", # User-provided description of a function. - "environment": "A String", # Describe whether the function is gen1 or gen2. + "environment": "A String", # Describe whether the function is 1st Gen or 2nd Gen. "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service. "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners. "eventFilters": [ # Criteria used to filter events. @@ -761,7 +761,7 @@Method Details
"workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project. }, "description": "A String", # User-provided description of a function. - "environment": "A String", # Describe whether the function is gen1 or gen2. + "environment": "A String", # Describe whether the function is 1st Gen or 2nd Gen. "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service. "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners. "eventFilters": [ # Criteria used to filter events. diff --git a/docs/dyn/cloudfunctions_v2alpha.projects.locations.functions.html b/docs/dyn/cloudfunctions_v2alpha.projects.locations.functions.html index 04d9227c669..76b37df0f1b 100644 --- a/docs/dyn/cloudfunctions_v2alpha.projects.locations.functions.html +++ b/docs/dyn/cloudfunctions_v2alpha.projects.locations.functions.html @@ -171,7 +171,7 @@Method Details
"workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project. }, "description": "A String", # User-provided description of a function. - "environment": "A String", # Describe whether the function is gen1 or gen2. + "environment": "A String", # Describe whether the function is 1st Gen or 2nd Gen. "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service. "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners. "eventFilters": [ # Criteria used to filter events. @@ -424,7 +424,7 @@Method Details
"workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project. }, "description": "A String", # User-provided description of a function. - "environment": "A String", # Describe whether the function is gen1 or gen2. + "environment": "A String", # Describe whether the function is 1st Gen or 2nd Gen. "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service. "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners. "eventFilters": [ # Criteria used to filter events. @@ -612,7 +612,7 @@Method Details
"workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project. }, "description": "A String", # User-provided description of a function. - "environment": "A String", # Describe whether the function is gen1 or gen2. + "environment": "A String", # Describe whether the function is 1st Gen or 2nd Gen. "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service. "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners. "eventFilters": [ # Criteria used to filter events. @@ -761,7 +761,7 @@Method Details
"workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project. }, "description": "A String", # User-provided description of a function. - "environment": "A String", # Describe whether the function is gen1 or gen2. + "environment": "A String", # Describe whether the function is 1st Gen or 2nd Gen. "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service. "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners. "eventFilters": [ # Criteria used to filter events. diff --git a/docs/dyn/cloudfunctions_v2beta.projects.locations.functions.html b/docs/dyn/cloudfunctions_v2beta.projects.locations.functions.html index e8dea57d469..ebcb228cb99 100644 --- a/docs/dyn/cloudfunctions_v2beta.projects.locations.functions.html +++ b/docs/dyn/cloudfunctions_v2beta.projects.locations.functions.html @@ -171,7 +171,7 @@Method Details
"workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project. }, "description": "A String", # User-provided description of a function. - "environment": "A String", # Describe whether the function is gen1 or gen2. + "environment": "A String", # Describe whether the function is 1st Gen or 2nd Gen. "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service. "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners. "eventFilters": [ # Criteria used to filter events. @@ -424,7 +424,7 @@Method Details
"workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project. }, "description": "A String", # User-provided description of a function. - "environment": "A String", # Describe whether the function is gen1 or gen2. + "environment": "A String", # Describe whether the function is 1st Gen or 2nd Gen. "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service. "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners. "eventFilters": [ # Criteria used to filter events. @@ -612,7 +612,7 @@Method Details
"workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project. }, "description": "A String", # User-provided description of a function. - "environment": "A String", # Describe whether the function is gen1 or gen2. + "environment": "A String", # Describe whether the function is 1st Gen or 2nd Gen. "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service. "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners. "eventFilters": [ # Criteria used to filter events. @@ -761,7 +761,7 @@Method Details
"workerPool": "A String", # Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is `projects/{project}/locations/{region}/workerPools/{workerPool}` where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project. }, "description": "A String", # User-provided description of a function. - "environment": "A String", # Describe whether the function is gen1 or gen2. + "environment": "A String", # Describe whether the function is 1st Gen or 2nd Gen. "eventTrigger": { # Describes EventTrigger, used to request events to be sent from another service. # An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service. "channel": "A String", # Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners. "eventFilters": [ # Criteria used to filter events. diff --git a/docs/dyn/cloudsupport_v2beta.cases.html b/docs/dyn/cloudsupport_v2beta.cases.html index b7c1944804f..d968b0c058a 100644 --- a/docs/dyn/cloudsupport_v2beta.cases.html +++ b/docs/dyn/cloudsupport_v2beta.cases.html @@ -104,7 +104,7 @@Instance Methods
Retrieves the next page of results.
-
patch(name, body=None, updateMask=None, x__xgafv=None)Update the specified case. Only a subset of fields (display_name, description, time_zone, subscriber_email_addresses, related_resources, severity, priority, primary_contact, and labels) can be updated.
+Update the specified case. Only a subset of fields can be updated.
search(pageSize=None, pageToken=None, query=None, x__xgafv=None)Search cases using the specified query.
@@ -392,7 +392,7 @@Method Details
@@ -489,7 +486,7 @@patch(name, body=None, updateMask=None, x__xgafv=None)-Update the specified case. Only a subset of fields (display_name, description, time_zone, subscriber_email_addresses, related_resources, severity, priority, primary_contact, and labels) can be updated. +Update the specified case. Only a subset of fields can be updated. Args: name: string, The resource name for the case. (required) diff --git a/docs/dyn/compute_alpha.addresses.html b/docs/dyn/compute_alpha.addresses.html index b009b2f6bd6..a38e4d9f3d0 100644 --- a/docs/dyn/compute_alpha.addresses.html +++ b/docs/dyn/compute_alpha.addresses.html @@ -278,9 +278,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -452,9 +449,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -640,9 +634,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -749,9 +740,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.autoscalers.html b/docs/dyn/compute_alpha.autoscalers.html index ffb8bea0d44..818cb93ccc8 100644 --- a/docs/dyn/compute_alpha.autoscalers.html +++ b/docs/dyn/compute_alpha.autoscalers.html @@ -326,9 +326,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -596,9 +593,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -903,9 +897,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1113,9 +1104,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.backendBuckets.html b/docs/dyn/compute_alpha.backendBuckets.html index cbb76cca5b8..2f8c61b4d5d 100644 --- a/docs/dyn/compute_alpha.backendBuckets.html +++ b/docs/dyn/compute_alpha.backendBuckets.html @@ -191,9 +191,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -294,9 +291,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -393,9 +387,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -710,9 +701,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -961,9 +949,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1066,9 +1051,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1456,9 +1438,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html index de8108196ec..680e20928fa 100644 --- a/docs/dyn/compute_alpha.backendServices.html +++ b/docs/dyn/compute_alpha.backendServices.html @@ -203,9 +203,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -794,9 +791,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -893,9 +887,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1993,9 +1984,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2982,9 +2970,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3087,9 +3072,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3401,9 +3383,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3951,9 +3930,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.disks.html b/docs/dyn/compute_alpha.disks.html index 6b33f37e142..401f968f6e8 100644 --- a/docs/dyn/compute_alpha.disks.html +++ b/docs/dyn/compute_alpha.disks.html @@ -214,9 +214,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -504,9 +501,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -677,9 +671,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -776,9 +767,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1229,9 +1217,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1505,9 +1490,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1611,9 +1593,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1930,9 +1909,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2036,9 +2012,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2142,9 +2115,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2247,9 +2217,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2498,9 +2465,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.externalVpnGateways.html b/docs/dyn/compute_alpha.externalVpnGateways.html index 1e106cea07e..1a8763c9426 100644 --- a/docs/dyn/compute_alpha.externalVpnGateways.html +++ b/docs/dyn/compute_alpha.externalVpnGateways.html @@ -170,9 +170,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -326,9 +323,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -506,9 +500,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.firewallPolicies.html b/docs/dyn/compute_alpha.firewallPolicies.html index c0e2a4611be..e362bff8f32 100644 --- a/docs/dyn/compute_alpha.firewallPolicies.html +++ b/docs/dyn/compute_alpha.firewallPolicies.html @@ -212,9 +212,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -383,9 +380,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -481,9 +475,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -583,9 +574,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1107,9 +1095,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1382,9 +1367,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1580,9 +1562,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1752,9 +1731,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1850,9 +1826,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1948,9 +1921,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.firewalls.html b/docs/dyn/compute_alpha.firewalls.html index 083c251982b..c5eb4582c86 100644 --- a/docs/dyn/compute_alpha.firewalls.html +++ b/docs/dyn/compute_alpha.firewalls.html @@ -173,9 +173,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -395,9 +392,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -654,9 +648,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -839,9 +830,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.forwardingRules.html b/docs/dyn/compute_alpha.forwardingRules.html index ee6e655faf9..d903975feeb 100644 --- a/docs/dyn/compute_alpha.forwardingRules.html +++ b/docs/dyn/compute_alpha.forwardingRules.html @@ -193,7 +193,7 @@Method Details
"A String", ], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. - "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. + "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. }, ], "warning": { # Informational warning which replaces the list of forwarding rules when the list is empty. @@ -313,9 +313,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -418,7 +415,7 @@Method Details
"A String", ], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. - "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. + "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. }Method Details
"A String", ], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. - "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. + "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). @@ -551,9 +548,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -663,7 +657,7 @@Method Details
"A String", ], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. - "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. + "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. }, ], "kind": "compute#forwardingRuleList", # Type of resource. @@ -764,7 +758,7 @@Method Details
"A String", ], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. - "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. + "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). @@ -826,9 +820,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -935,9 +926,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1041,9 +1029,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.futureReservations.html b/docs/dyn/compute_alpha.futureReservations.html index 400db36bb2b..fbc16528d21 100644 --- a/docs/dyn/compute_alpha.futureReservations.html +++ b/docs/dyn/compute_alpha.futureReservations.html @@ -314,9 +314,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -418,9 +415,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -678,9 +672,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -981,9 +972,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.globalAddresses.html b/docs/dyn/compute_alpha.globalAddresses.html index df0c1b7e64f..d8c4c72924c 100644 --- a/docs/dyn/compute_alpha.globalAddresses.html +++ b/docs/dyn/compute_alpha.globalAddresses.html @@ -176,9 +176,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -368,9 +365,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -554,9 +548,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -661,9 +652,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.globalForwardingRules.html b/docs/dyn/compute_alpha.globalForwardingRules.html index ff02d04619a..671956c37fd 100644 --- a/docs/dyn/compute_alpha.globalForwardingRules.html +++ b/docs/dyn/compute_alpha.globalForwardingRules.html @@ -176,9 +176,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -280,7 +277,7 @@Method Details
"A String", ], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. - "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. + "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. }Method Details
"A String", ], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. - "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. + "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). @@ -412,9 +409,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -523,7 +517,7 @@Method Details
"A String", ], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. - "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. + "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. }, ], "kind": "compute#forwardingRuleList", # Type of resource. @@ -623,7 +617,7 @@Method Details
"A String", ], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. - "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. + "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. } requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). @@ -685,9 +679,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -792,9 +783,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -897,9 +885,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html b/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html index 60bf77f89fa..37eb6c939e9 100644 --- a/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html +++ b/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html @@ -188,9 +188,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -291,9 +288,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -406,9 +400,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -628,9 +619,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.globalOperations.html b/docs/dyn/compute_alpha.globalOperations.html index ce03367b59d..f77960958d4 100644 --- a/docs/dyn/compute_alpha.globalOperations.html +++ b/docs/dyn/compute_alpha.globalOperations.html @@ -174,9 +174,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -334,9 +331,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -438,9 +432,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -564,9 +555,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.globalOrganizationOperations.html b/docs/dyn/compute_alpha.globalOrganizationOperations.html index ae9902b44a5..fd47670853f 100644 --- a/docs/dyn/compute_alpha.globalOrganizationOperations.html +++ b/docs/dyn/compute_alpha.globalOrganizationOperations.html @@ -174,9 +174,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -278,9 +275,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html b/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html index 0fb89548b26..04538678302 100644 --- a/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html +++ b/docs/dyn/compute_alpha.globalPublicDelegatedPrefixes.html @@ -167,9 +167,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -337,9 +334,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -544,9 +538,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.healthChecks.html b/docs/dyn/compute_alpha.healthChecks.html index d3552b6f39f..c56c3048e4d 100644 --- a/docs/dyn/compute_alpha.healthChecks.html +++ b/docs/dyn/compute_alpha.healthChecks.html @@ -326,9 +326,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -596,9 +593,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -903,9 +897,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1112,9 +1103,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.httpHealthChecks.html b/docs/dyn/compute_alpha.httpHealthChecks.html index 7b4fe1e06e5..1b2bea222b6 100644 --- a/docs/dyn/compute_alpha.httpHealthChecks.html +++ b/docs/dyn/compute_alpha.httpHealthChecks.html @@ -173,9 +173,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -323,9 +320,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -510,9 +504,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -659,9 +650,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.httpsHealthChecks.html b/docs/dyn/compute_alpha.httpsHealthChecks.html index f2734e2dab6..117b005a57a 100644 --- a/docs/dyn/compute_alpha.httpsHealthChecks.html +++ b/docs/dyn/compute_alpha.httpsHealthChecks.html @@ -173,9 +173,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -323,9 +320,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -510,9 +504,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -659,9 +650,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.images.html b/docs/dyn/compute_alpha.images.html index d5807b1e458..4584a2b68aa 100644 --- a/docs/dyn/compute_alpha.images.html +++ b/docs/dyn/compute_alpha.images.html @@ -185,9 +185,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -300,9 +297,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -899,9 +893,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1295,9 +1286,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1611,9 +1599,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html b/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html index 17e6ee91cad..21e8eb25682 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html +++ b/docs/dyn/compute_alpha.instanceGroupManagerResizeRequests.html @@ -166,9 +166,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -424,9 +421,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html index a59dc7181fb..29c9fa7d8d1 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagers.html +++ b/docs/dyn/compute_alpha.instanceGroupManagers.html @@ -253,9 +253,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -591,9 +588,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -738,9 +732,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -837,9 +828,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -946,9 +934,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1053,9 +1038,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1485,9 +1467,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2266,9 +2245,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2408,9 +2384,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2516,9 +2489,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2616,9 +2586,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2723,9 +2690,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2831,9 +2795,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2950,9 +2911,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3056,9 +3014,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3165,9 +3120,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3273,9 +3225,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3382,9 +3331,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3491,9 +3437,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3782,9 +3725,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3924,9 +3864,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.instanceGroups.html b/docs/dyn/compute_alpha.instanceGroups.html index d2cf3e108ce..91a5872f4af 100644 --- a/docs/dyn/compute_alpha.instanceGroups.html +++ b/docs/dyn/compute_alpha.instanceGroups.html @@ -195,9 +195,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -391,9 +388,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -553,9 +547,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -810,9 +801,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -922,9 +910,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.instanceTemplates.html b/docs/dyn/compute_alpha.instanceTemplates.html index 1ad2524a585..54995fe0af9 100644 --- a/docs/dyn/compute_alpha.instanceTemplates.html +++ b/docs/dyn/compute_alpha.instanceTemplates.html @@ -173,9 +173,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -231,6 +228,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -657,6 +655,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -1018,9 +1017,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1083,6 +1079,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html index 87bdf5ba5c9..99b853b7b19 100644 --- a/docs/dyn/compute_alpha.instances.html +++ b/docs/dyn/compute_alpha.instances.html @@ -323,9 +323,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -431,9 +428,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -493,6 +487,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -1071,9 +1066,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1120,6 +1112,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -1475,6 +1468,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -1844,9 +1838,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1948,9 +1939,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2049,9 +2037,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2149,9 +2134,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2202,6 +2184,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -3144,6 +3127,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -3556,9 +3540,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3616,6 +3597,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -4125,9 +4107,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -4233,9 +4212,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -4332,9 +4308,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -4456,9 +4429,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -4571,9 +4541,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -4672,9 +4639,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -4991,9 +4955,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -5102,9 +5063,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -5208,9 +5166,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -5321,9 +5276,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -5427,9 +5379,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -5534,9 +5483,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -5667,9 +5613,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -5776,9 +5719,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -5882,9 +5822,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -5988,9 +5925,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -6097,9 +6031,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -6197,9 +6128,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -6296,9 +6224,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -6420,9 +6345,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -6520,9 +6442,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -6620,9 +6539,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -6700,6 +6616,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -7123,9 +7040,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -7241,9 +7155,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -7347,9 +7258,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -7512,9 +7420,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -7620,9 +7525,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -7728,9 +7630,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.instantSnapshots.html b/docs/dyn/compute_alpha.instantSnapshots.html index 76afefcb7c2..3a51f6354aa 100644 --- a/docs/dyn/compute_alpha.instantSnapshots.html +++ b/docs/dyn/compute_alpha.instantSnapshots.html @@ -282,9 +282,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -400,9 +397,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -674,9 +668,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1072,9 +1063,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.interconnectAttachments.html b/docs/dyn/compute_alpha.interconnectAttachments.html index a184ba2604b..57f50b94a7a 100644 --- a/docs/dyn/compute_alpha.interconnectAttachments.html +++ b/docs/dyn/compute_alpha.interconnectAttachments.html @@ -322,9 +322,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -677,9 +674,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -964,9 +958,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1283,9 +1274,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.interconnects.html b/docs/dyn/compute_alpha.interconnects.html index 1c400a29418..30c42d54030 100644 --- a/docs/dyn/compute_alpha.interconnects.html +++ b/docs/dyn/compute_alpha.interconnects.html @@ -185,9 +185,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -620,9 +617,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -899,9 +893,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1215,9 +1206,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.licenses.html b/docs/dyn/compute_alpha.licenses.html index e009b60ccd0..31f50877291 100644 --- a/docs/dyn/compute_alpha.licenses.html +++ b/docs/dyn/compute_alpha.licenses.html @@ -173,9 +173,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -426,9 +423,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.machineImages.html b/docs/dyn/compute_alpha.machineImages.html index b5088c51110..5224d5eaf4d 100644 --- a/docs/dyn/compute_alpha.machineImages.html +++ b/docs/dyn/compute_alpha.machineImages.html @@ -173,9 +173,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -230,6 +227,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -847,6 +845,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -1401,9 +1400,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1465,6 +1461,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, diff --git a/docs/dyn/compute_alpha.networkAttachments.html b/docs/dyn/compute_alpha.networkAttachments.html index 5ab99e7c00f..cab263d3c31 100644 --- a/docs/dyn/compute_alpha.networkAttachments.html +++ b/docs/dyn/compute_alpha.networkAttachments.html @@ -281,9 +281,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -571,9 +568,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.networkEdgeSecurityServices.html b/docs/dyn/compute_alpha.networkEdgeSecurityServices.html index 9d2fd428343..5d6a0b29fad 100644 --- a/docs/dyn/compute_alpha.networkEdgeSecurityServices.html +++ b/docs/dyn/compute_alpha.networkEdgeSecurityServices.html @@ -252,9 +252,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -397,9 +394,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -514,9 +508,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.networkEndpointGroups.html b/docs/dyn/compute_alpha.networkEndpointGroups.html index 6fa00113e94..203bf4bb5ec 100644 --- a/docs/dyn/compute_alpha.networkEndpointGroups.html +++ b/docs/dyn/compute_alpha.networkEndpointGroups.html @@ -321,9 +321,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -425,9 +422,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -541,9 +535,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -765,9 +756,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.networkFirewallPolicies.html b/docs/dyn/compute_alpha.networkFirewallPolicies.html index 70af34a7fa1..193d6baae88 100644 --- a/docs/dyn/compute_alpha.networkFirewallPolicies.html +++ b/docs/dyn/compute_alpha.networkFirewallPolicies.html @@ -207,9 +207,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -381,9 +378,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -480,9 +474,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -583,9 +574,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1111,9 +1099,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1459,9 +1444,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1632,9 +1614,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1731,9 +1710,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1830,9 +1806,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.networks.html b/docs/dyn/compute_alpha.networks.html index ebf0dc8878a..b84f249a9d2 100644 --- a/docs/dyn/compute_alpha.networks.html +++ b/docs/dyn/compute_alpha.networks.html @@ -224,9 +224,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -327,9 +324,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -845,9 +839,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1277,9 +1268,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1382,9 +1370,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1480,9 +1465,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1630,9 +1612,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.nodeGroups.html b/docs/dyn/compute_alpha.nodeGroups.html index c6bcaf8117b..d7181fa0bf3 100644 --- a/docs/dyn/compute_alpha.nodeGroups.html +++ b/docs/dyn/compute_alpha.nodeGroups.html @@ -203,9 +203,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -423,9 +420,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -531,9 +525,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -846,9 +837,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1198,9 +1186,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1514,9 +1499,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1622,9 +1604,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.nodeTemplates.html b/docs/dyn/compute_alpha.nodeTemplates.html index 274a089b98a..01d6cc10705 100644 --- a/docs/dyn/compute_alpha.nodeTemplates.html +++ b/docs/dyn/compute_alpha.nodeTemplates.html @@ -289,9 +289,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -589,9 +586,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.organizationSecurityPolicies.html b/docs/dyn/compute_alpha.organizationSecurityPolicies.html index 6b06118b730..96881866625 100644 --- a/docs/dyn/compute_alpha.organizationSecurityPolicies.html +++ b/docs/dyn/compute_alpha.organizationSecurityPolicies.html @@ -202,9 +202,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -461,9 +458,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -564,9 +558,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -661,9 +652,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1428,9 +1416,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1835,9 +1820,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2162,9 +2144,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2422,9 +2401,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2520,9 +2496,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2618,9 +2591,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.packetMirrorings.html b/docs/dyn/compute_alpha.packetMirrorings.html index 6dcdeac96ea..b989b7f2b01 100644 --- a/docs/dyn/compute_alpha.packetMirrorings.html +++ b/docs/dyn/compute_alpha.packetMirrorings.html @@ -294,9 +294,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -506,9 +503,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -755,9 +749,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.projects.html b/docs/dyn/compute_alpha.projects.html index ee6f90ed81c..36e8f8d3d1a 100644 --- a/docs/dyn/compute_alpha.projects.html +++ b/docs/dyn/compute_alpha.projects.html @@ -196,9 +196,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -303,9 +300,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -400,9 +394,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -507,9 +498,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -861,9 +849,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -966,9 +951,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1077,9 +1059,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1181,9 +1160,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1285,9 +1261,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1390,9 +1363,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html b/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html index 92cc04e84ac..9cc9f662548 100644 --- a/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html +++ b/docs/dyn/compute_alpha.publicAdvertisedPrefixes.html @@ -168,9 +168,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -271,9 +268,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -437,9 +431,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -640,9 +631,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -738,9 +726,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.publicDelegatedPrefixes.html b/docs/dyn/compute_alpha.publicDelegatedPrefixes.html index 9bce3500b48..52c4ada93b8 100644 --- a/docs/dyn/compute_alpha.publicDelegatedPrefixes.html +++ b/docs/dyn/compute_alpha.publicDelegatedPrefixes.html @@ -272,9 +272,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -376,9 +373,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -548,9 +542,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -757,9 +748,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -856,9 +844,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionAutoscalers.html b/docs/dyn/compute_alpha.regionAutoscalers.html index aa951d049c0..0f5d0fa57e8 100644 --- a/docs/dyn/compute_alpha.regionAutoscalers.html +++ b/docs/dyn/compute_alpha.regionAutoscalers.html @@ -174,9 +174,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -444,9 +441,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -751,9 +745,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -961,9 +952,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html index f4c5e6783e2..5a2c803de19 100644 --- a/docs/dyn/compute_alpha.regionBackendServices.html +++ b/docs/dyn/compute_alpha.regionBackendServices.html @@ -186,9 +186,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1290,9 +1287,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2281,9 +2275,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2597,9 +2588,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3149,9 +3137,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionCommitments.html b/docs/dyn/compute_alpha.regionCommitments.html index ccef6169206..1e1590ebc34 100644 --- a/docs/dyn/compute_alpha.regionCommitments.html +++ b/docs/dyn/compute_alpha.regionCommitments.html @@ -566,9 +566,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -955,9 +952,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1125,9 +1119,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionDisks.html b/docs/dyn/compute_alpha.regionDisks.html index a72fad86c44..39ac14d65f8 100644 --- a/docs/dyn/compute_alpha.regionDisks.html +++ b/docs/dyn/compute_alpha.regionDisks.html @@ -208,9 +208,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -313,9 +310,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -486,9 +480,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -585,9 +576,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1038,9 +1026,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1314,9 +1299,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1420,9 +1402,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1739,9 +1718,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1845,9 +1821,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1951,9 +1924,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2056,9 +2026,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2307,9 +2274,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionHealthCheckServices.html b/docs/dyn/compute_alpha.regionHealthCheckServices.html index 70294e02942..a0deb438827 100644 --- a/docs/dyn/compute_alpha.regionHealthCheckServices.html +++ b/docs/dyn/compute_alpha.regionHealthCheckServices.html @@ -270,9 +270,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -434,9 +431,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -635,9 +629,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionHealthChecks.html b/docs/dyn/compute_alpha.regionHealthChecks.html index 6eea7662e40..4e2c79d3080 100644 --- a/docs/dyn/compute_alpha.regionHealthChecks.html +++ b/docs/dyn/compute_alpha.regionHealthChecks.html @@ -174,9 +174,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -446,9 +443,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -755,9 +749,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -966,9 +957,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html index 8bda0e858ce..ada3b400dad 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html @@ -247,9 +247,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -358,9 +355,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -505,9 +499,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -604,9 +595,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -714,9 +702,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -821,9 +806,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1253,9 +1235,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2034,9 +2013,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2176,9 +2152,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2284,9 +2257,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2384,9 +2354,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2491,9 +2458,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2599,9 +2563,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2718,9 +2679,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2824,9 +2782,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2933,9 +2888,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3041,9 +2993,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3150,9 +3099,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3259,9 +3205,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3550,9 +3493,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3692,9 +3632,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionInstanceGroups.html b/docs/dyn/compute_alpha.regionInstanceGroups.html index 0444dd2846a..992975663bd 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroups.html +++ b/docs/dyn/compute_alpha.regionInstanceGroups.html @@ -371,9 +371,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionInstanceTemplates.html b/docs/dyn/compute_alpha.regionInstanceTemplates.html index 0e629eb82e0..13935205b5b 100644 --- a/docs/dyn/compute_alpha.regionInstanceTemplates.html +++ b/docs/dyn/compute_alpha.regionInstanceTemplates.html @@ -165,9 +165,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -224,6 +221,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -548,6 +546,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -909,9 +908,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -975,6 +971,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, diff --git a/docs/dyn/compute_alpha.regionInstances.html b/docs/dyn/compute_alpha.regionInstances.html index 8494bf1e5b6..5a899935a84 100644 --- a/docs/dyn/compute_alpha.regionInstances.html +++ b/docs/dyn/compute_alpha.regionInstances.html @@ -98,6 +98,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -453,6 +454,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -822,9 +824,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionInstantSnapshots.html b/docs/dyn/compute_alpha.regionInstantSnapshots.html index 90f96ae82e9..7cf798f4742 100644 --- a/docs/dyn/compute_alpha.regionInstantSnapshots.html +++ b/docs/dyn/compute_alpha.regionInstantSnapshots.html @@ -180,9 +180,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -298,9 +295,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -572,9 +566,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -970,9 +961,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html b/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html index 11200ff2cdb..2f44484b49e 100644 --- a/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html @@ -165,9 +165,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -389,9 +386,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html index 729e7933b7f..42b44711433 100644 --- a/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_alpha.regionNetworkFirewallPolicies.html @@ -211,9 +211,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -386,9 +383,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -486,9 +480,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -590,9 +581,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1276,9 +1264,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1626,9 +1611,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1800,9 +1782,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1900,9 +1879,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2000,9 +1976,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionNotificationEndpoints.html b/docs/dyn/compute_alpha.regionNotificationEndpoints.html index 5f553fb2c68..af51d558775 100644 --- a/docs/dyn/compute_alpha.regionNotificationEndpoints.html +++ b/docs/dyn/compute_alpha.regionNotificationEndpoints.html @@ -264,9 +264,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -422,9 +419,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionOperations.html b/docs/dyn/compute_alpha.regionOperations.html index 01e4fbbbd1c..410c096466d 100644 --- a/docs/dyn/compute_alpha.regionOperations.html +++ b/docs/dyn/compute_alpha.regionOperations.html @@ -179,9 +179,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -284,9 +281,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -411,9 +405,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionSecurityPolicies.html b/docs/dyn/compute_alpha.regionSecurityPolicies.html index ca29093d650..074ea6495fa 100644 --- a/docs/dyn/compute_alpha.regionSecurityPolicies.html +++ b/docs/dyn/compute_alpha.regionSecurityPolicies.html @@ -337,9 +337,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -441,9 +438,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1191,9 +1185,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1805,9 +1796,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2068,9 +2056,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2167,9 +2152,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionSslCertificates.html b/docs/dyn/compute_alpha.regionSslCertificates.html index 1fa35d8efc9..e55aae1f930 100644 --- a/docs/dyn/compute_alpha.regionSslCertificates.html +++ b/docs/dyn/compute_alpha.regionSslCertificates.html @@ -168,9 +168,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -348,9 +345,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionSslPolicies.html b/docs/dyn/compute_alpha.regionSslPolicies.html index 60c4b3c9413..4593b2691fe 100644 --- a/docs/dyn/compute_alpha.regionSslPolicies.html +++ b/docs/dyn/compute_alpha.regionSslPolicies.html @@ -174,9 +174,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -470,9 +467,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -830,9 +824,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionTargetHttpProxies.html b/docs/dyn/compute_alpha.regionTargetHttpProxies.html index b0bc3f58c78..2499f004809 100644 --- a/docs/dyn/compute_alpha.regionTargetHttpProxies.html +++ b/docs/dyn/compute_alpha.regionTargetHttpProxies.html @@ -171,9 +171,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -323,9 +320,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -499,9 +493,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionTargetHttpsProxies.html b/docs/dyn/compute_alpha.regionTargetHttpsProxies.html index 4c434b49f82..63959549de5 100644 --- a/docs/dyn/compute_alpha.regionTargetHttpsProxies.html +++ b/docs/dyn/compute_alpha.regionTargetHttpsProxies.html @@ -177,9 +177,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -349,9 +346,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -558,9 +552,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -666,9 +657,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -772,9 +760,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionTargetTcpProxies.html b/docs/dyn/compute_alpha.regionTargetTcpProxies.html index e021e85685f..57a227e341a 100644 --- a/docs/dyn/compute_alpha.regionTargetTcpProxies.html +++ b/docs/dyn/compute_alpha.regionTargetTcpProxies.html @@ -168,9 +168,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -312,9 +309,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.regionUrlMaps.html b/docs/dyn/compute_alpha.regionUrlMaps.html index 2c74044a489..766af75fbcc 100644 --- a/docs/dyn/compute_alpha.regionUrlMaps.html +++ b/docs/dyn/compute_alpha.regionUrlMaps.html @@ -180,9 +180,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1538,9 +1535,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1645,9 +1639,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3040,9 +3031,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3794,9 +3782,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.reservations.html b/docs/dyn/compute_alpha.reservations.html index afa783305f1..57f08e21b37 100644 --- a/docs/dyn/compute_alpha.reservations.html +++ b/docs/dyn/compute_alpha.reservations.html @@ -320,9 +320,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -670,9 +667,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -893,9 +887,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1303,9 +1294,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.resourcePolicies.html b/docs/dyn/compute_alpha.resourcePolicies.html index d35750d7b7d..5ac53d1bc0a 100644 --- a/docs/dyn/compute_alpha.resourcePolicies.html +++ b/docs/dyn/compute_alpha.resourcePolicies.html @@ -345,9 +345,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -749,9 +746,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1088,9 +1082,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.routers.html b/docs/dyn/compute_alpha.routers.html index 9434a78f82a..88e32db6fff 100644 --- a/docs/dyn/compute_alpha.routers.html +++ b/docs/dyn/compute_alpha.routers.html @@ -406,9 +406,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1201,9 +1198,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1644,9 +1638,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2232,9 +2223,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.routes.html b/docs/dyn/compute_alpha.routes.html index 6aa221cbfaa..0ae5a80c38f 100644 --- a/docs/dyn/compute_alpha.routes.html +++ b/docs/dyn/compute_alpha.routes.html @@ -167,9 +167,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -379,9 +376,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.securityPolicies.html b/docs/dyn/compute_alpha.securityPolicies.html index 865480f44ac..83dcc457463 100644 --- a/docs/dyn/compute_alpha.securityPolicies.html +++ b/docs/dyn/compute_alpha.securityPolicies.html @@ -351,9 +351,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -752,9 +749,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1499,9 +1493,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2151,9 +2142,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2412,9 +2400,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2510,9 +2495,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2617,9 +2599,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.serviceAttachments.html b/docs/dyn/compute_alpha.serviceAttachments.html index d88477ab643..6b4c8a1001e 100644 --- a/docs/dyn/compute_alpha.serviceAttachments.html +++ b/docs/dyn/compute_alpha.serviceAttachments.html @@ -295,9 +295,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -601,9 +598,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -840,9 +834,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.snapshots.html b/docs/dyn/compute_alpha.snapshots.html index db132034ac6..d737705af9e 100644 --- a/docs/dyn/compute_alpha.snapshots.html +++ b/docs/dyn/compute_alpha.snapshots.html @@ -176,9 +176,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -525,9 +522,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -958,9 +952,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.sslCertificates.html b/docs/dyn/compute_alpha.sslCertificates.html index 1b73f31b24f..ffb37f098b4 100644 --- a/docs/dyn/compute_alpha.sslCertificates.html +++ b/docs/dyn/compute_alpha.sslCertificates.html @@ -274,9 +274,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -452,9 +449,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.sslPolicies.html b/docs/dyn/compute_alpha.sslPolicies.html index c07055b52f9..6b2b5329f0a 100644 --- a/docs/dyn/compute_alpha.sslPolicies.html +++ b/docs/dyn/compute_alpha.sslPolicies.html @@ -339,9 +339,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -633,9 +630,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -990,9 +984,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.subnetworks.html b/docs/dyn/compute_alpha.subnetworks.html index 3d782a4445a..a4178744678 100644 --- a/docs/dyn/compute_alpha.subnetworks.html +++ b/docs/dyn/compute_alpha.subnetworks.html @@ -318,9 +318,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -424,9 +421,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -752,9 +746,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1085,9 +1076,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1401,9 +1389,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.targetGrpcProxies.html b/docs/dyn/compute_alpha.targetGrpcProxies.html index 34235a2b7f9..305566b1c97 100644 --- a/docs/dyn/compute_alpha.targetGrpcProxies.html +++ b/docs/dyn/compute_alpha.targetGrpcProxies.html @@ -170,9 +170,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -312,9 +309,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -491,9 +485,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.targetHttpProxies.html b/docs/dyn/compute_alpha.targetHttpProxies.html index ebe1ecb2316..cad467505e1 100644 --- a/docs/dyn/compute_alpha.targetHttpProxies.html +++ b/docs/dyn/compute_alpha.targetHttpProxies.html @@ -266,9 +266,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -416,9 +413,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -603,9 +597,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -708,9 +699,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.targetHttpsProxies.html b/docs/dyn/compute_alpha.targetHttpsProxies.html index 5752ee19f30..2f40cf1760a 100644 --- a/docs/dyn/compute_alpha.targetHttpsProxies.html +++ b/docs/dyn/compute_alpha.targetHttpsProxies.html @@ -288,9 +288,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -458,9 +455,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -665,9 +659,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -770,9 +761,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -875,9 +863,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -982,9 +967,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1087,9 +1069,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1192,9 +1171,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.targetInstances.html b/docs/dyn/compute_alpha.targetInstances.html index da9dde271a9..6b0b4db620d 100644 --- a/docs/dyn/compute_alpha.targetInstances.html +++ b/docs/dyn/compute_alpha.targetInstances.html @@ -259,9 +259,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -407,9 +404,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.targetPools.html b/docs/dyn/compute_alpha.targetPools.html index 6d1d5fe8f08..a29b143f141 100644 --- a/docs/dyn/compute_alpha.targetPools.html +++ b/docs/dyn/compute_alpha.targetPools.html @@ -198,9 +198,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -308,9 +305,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -503,9 +497,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -706,9 +697,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -890,9 +878,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1000,9 +985,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1107,9 +1089,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.targetSslProxies.html b/docs/dyn/compute_alpha.targetSslProxies.html index 814c036a653..988b5e2f40c 100644 --- a/docs/dyn/compute_alpha.targetSslProxies.html +++ b/docs/dyn/compute_alpha.targetSslProxies.html @@ -182,9 +182,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -330,9 +327,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -503,9 +497,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -608,9 +599,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -713,9 +701,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -820,9 +805,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -925,9 +907,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.targetTcpProxies.html b/docs/dyn/compute_alpha.targetTcpProxies.html index 427628102d7..18b9686d667 100644 --- a/docs/dyn/compute_alpha.targetTcpProxies.html +++ b/docs/dyn/compute_alpha.targetTcpProxies.html @@ -262,9 +262,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -404,9 +401,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -574,9 +568,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -679,9 +670,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.targetVpnGateways.html b/docs/dyn/compute_alpha.targetVpnGateways.html index b2f84bb6cf4..59cba6e3b12 100644 --- a/docs/dyn/compute_alpha.targetVpnGateways.html +++ b/docs/dyn/compute_alpha.targetVpnGateways.html @@ -269,9 +269,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -431,9 +428,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -615,9 +609,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.urlMaps.html b/docs/dyn/compute_alpha.urlMaps.html index 0af4e6dabb0..a0f698dac0c 100644 --- a/docs/dyn/compute_alpha.urlMaps.html +++ b/docs/dyn/compute_alpha.urlMaps.html @@ -875,9 +875,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2231,9 +2228,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2337,9 +2331,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -3730,9 +3721,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -4482,9 +4470,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.vpnGateways.html b/docs/dyn/compute_alpha.vpnGateways.html index 36a619eedd9..a36c77ec0a6 100644 --- a/docs/dyn/compute_alpha.vpnGateways.html +++ b/docs/dyn/compute_alpha.vpnGateways.html @@ -273,9 +273,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -476,9 +473,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -661,9 +655,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.vpnTunnels.html b/docs/dyn/compute_alpha.vpnTunnels.html index 9dbb40a9ce3..a7c9f52d7da 100644 --- a/docs/dyn/compute_alpha.vpnTunnels.html +++ b/docs/dyn/compute_alpha.vpnTunnels.html @@ -280,9 +280,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -464,9 +461,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -659,9 +653,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.zoneOperations.html b/docs/dyn/compute_alpha.zoneOperations.html index 85e6d36ff5f..dd51eacb639 100644 --- a/docs/dyn/compute_alpha.zoneOperations.html +++ b/docs/dyn/compute_alpha.zoneOperations.html @@ -179,9 +179,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -284,9 +281,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -411,9 +405,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/compute_alpha.zoneQueuedResources.html b/docs/dyn/compute_alpha.zoneQueuedResources.html index bf4bd39bee6..fafd2a7587d 100644 --- a/docs/dyn/compute_alpha.zoneQueuedResources.html +++ b/docs/dyn/compute_alpha.zoneQueuedResources.html @@ -135,6 +135,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -490,6 +491,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -983,9 +985,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1087,9 +1086,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1143,6 +1139,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -1498,6 +1495,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -1898,6 +1896,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -2253,6 +2252,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -2693,9 +2693,6 @@Method Details
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. - "metadata": { # [Output Only] Service-specific metadata attached to this operation. - "a_key": "", # Properties of the object. Contains field @type with type URL. - }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2756,6 +2753,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, @@ -3111,6 +3109,7 @@Method Details
"enableNestedVirtualization": True or False, # Whether to enable nested virtualization or not (default is false). "enableUefiNetworking": True or False, # Whether to enable UEFI networking for instance creation. "numaNodeCount": 42, # The number of vNUMA nodes. + "performanceMonitoringUnit": "A String", # Type of Performance Monitoring Unit requested on instance. "threadsPerCore": 42, # The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. "visibleCoreCount": 42, # The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. }, diff --git a/docs/dyn/compute_beta.forwardingRules.html b/docs/dyn/compute_beta.forwardingRules.html index a060ef1da4f..a1a03163009 100644 --- a/docs/dyn/compute_beta.forwardingRules.html +++ b/docs/dyn/compute_beta.forwardingRules.html @@ -191,7 +191,7 @@Method Details
"A String", ], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. - "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. + "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. }, ], "warning": { # Informational warning which replaces the list of forwarding rules when the list is empty. @@ -410,7 +410,7 @@Method Details
"A String", ], "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. - "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. + "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. }
setNodeTemplate(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)
Updates the node template of the node group.
+
+ simulateMaintenanceEvent(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)
Simulates maintenance event on specified nodes from the node group.
testIamPermissions(project, zone, resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource.
@@ -1484,6 +1487,110 @@simulateMaintenanceEvent(project, zone, nodeGroup, body=None, requestId=None, x__xgafv=None)
+ Simulates maintenance event on specified nodes from the node group.
+
+Args:
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ nodeGroup: string, Name of the NodeGroup resource whose nodes will go under maintenance simulation. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+ "nodes": [ # Names of the nodes to go under maintenance simulation.
+ "A String",
+ ],
+}
+
+ requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.
+ "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+ "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+ "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+ "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+ "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+ {
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+ {
+ "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+ "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+ "metadatas": { # Additional structured details about this error. Keys should match /[a-zA-Z0-9-_]/ and be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+ "a_key": "A String",
+ },
+ "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+ },
+ "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+ "links": [ # URL(s) pointing to additional information on handling the current error.
+ { # Describes a URL link.
+ "description": "A String", # Describes what the link offers.
+ "url": "A String", # The URL of the link.
+ },
+ ],
+ },
+ "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+ "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+ "message": "A String", # The localized error message in the above locale.
+ },
+ "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+ "dimensions": { # The map holding related quota dimensions.
+ "a_key": "A String",
+ },
+ "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+ "limitName": "A String", # The name of the quota limit.
+ "metricName": "A String", # The Compute Engine quota metric name.
+ },
+ },
+ ],
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ },
+ ],
+ },
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+ "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+ "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
+ "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+ "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+ "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+ "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+ "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+ "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
+ "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+testIamPermissions(project, zone, resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. diff --git a/docs/dyn/compute_v1.forwardingRules.html b/docs/dyn/compute_v1.forwardingRules.html index 9e6242c90df..fb70d4f5b9b 100644 --- a/docs/dyn/compute_v1.forwardingRules.html +++ b/docs/dyn/compute_v1.forwardingRules.html @@ -184,7 +184,7 @@Method Details
"serviceLabel": "A String", # An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. "serviceName": "A String", # [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. - "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. + "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. }, ], "warning": { # Informational warning which replaces the list of forwarding rules when the list is empty. @@ -399,7 +399,7 @@Method Details
"serviceLabel": "A String", # An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. "serviceName": "A String", # [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. "subnetwork": "A String", # This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. - "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For more information, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. + "target": "A String", # The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. }
projects()
diff --git a/docs/dyn/contentwarehouse_v1.projects.html b/docs/dyn/contentwarehouse_v1.projects.html
index 2d2c9bd035b..df8ebd604e8 100644
--- a/docs/dyn/contentwarehouse_v1.projects.html
+++ b/docs/dyn/contentwarehouse_v1.projects.html
@@ -72,7 +72,7 @@
-
locations()
@@ -106,7 +106,7 @@
documentLinks()
@@ -136,15 +136,14 @@
documentSchemas()
diff --git a/docs/dyn/contentwarehouse_v1.projects.locations.operations.html b/docs/dyn/contentwarehouse_v1.projects.locations.operations.html
index 5db711ea60e..c5531937685 100644
--- a/docs/dyn/contentwarehouse_v1.projects.locations.operations.html
+++ b/docs/dyn/contentwarehouse_v1.projects.locations.operations.html
@@ -72,7 +72,7 @@
-
+ projects()
+
Returns the projects Resource.
+ +
+ close()
Close httplib2 connections.
+ +Create a BatchHttpRequest object based on the discovery document.
+close()
+ Close httplib2 connections.+
new_batch_http_request()
+ Create a BatchHttpRequest object based on the discovery document. + + Args: + callback: callable, A callback to be called for each response, of the + form callback(id, response, exception). The first parameter is the + request id, and the second is the deserialized response object. The + third is an apiclient.errors.HttpError exception object if an HTTP + error occurred while processing the request, or None if no error + occurred. + + Returns: + A BatchHttpRequest object based on the discovery document. ++
+ locations()
+
Returns the locations Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
+ repositories()
+
Returns the repositories Resource.
+ +
+ close()
Close httplib2 connections.
+ +Gets information about a location.
+ +Lists information about the supported locations for this service.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
get(name, x__xgafv=None)
+ Gets information about a location.
+
+Args:
+ name: string, Resource name for the location. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A resource that represents Google Cloud Platform location.
+ "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+ "a_key": "A String",
+ },
+ "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+ "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+}
+list(name, filter=None, includeUnrevealedLocations=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists information about the supported locations for this service.
+
+Args:
+ name: string, The resource that owns the locations collection, if applicable. (required)
+ filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
+ includeUnrevealedLocations: boolean, If true, the returned list will include locations which are not yet revealed.
+ pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
+ pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Locations.ListLocations.
+ "locations": [ # A list of locations that matches the specified filter in the request.
+ { # A resource that represents Google Cloud Platform location.
+ "displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
+ "labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
+ "a_key": "A String",
+ },
+ "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
+ "metadata": { # Service-specific metadata. For example the available capacity at the given location.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
+ },
+ ],
+ "nextPageToken": "A String", # The standard List next-page token.
+}
+list_next()
+ 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. ++
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a new CompilationResult in a given project and location.
+ +Fetches a single CompilationResult.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists CompilationResults in a given Repository.
+ +Retrieves the next page of results.
+
+ query(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Returns CompilationResultActions in a given CompilationResult.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates a new CompilationResult in a given project and location.
+
+Args:
+ parent: string, Required. The repository in which to create the compilation result. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents the result of compiling a Dataform project.
+ "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+ "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+ "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+ "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+ "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+ "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+ "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+ "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+ "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+ "a_key": "A String",
+ },
+ },
+ "compilationErrors": [ # Output only. Errors encountered during project compilation.
+ { # An error encountered when attempting to compile a Dataform project.
+ "actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ "message": "A String", # Output only. The error's top level message.
+ "path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root.
+ "stack": "A String", # Output only. The error's full stack trace.
+ },
+ ],
+ "dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation.
+ "gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+ "name": "A String", # Output only. The compilation result's name.
+ "releaseConfig": "A String", # Immutable. The name of the release config to compile. The release config's 'current_compilation_result' field will be updated to this compilation result. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+ "resolvedGitCommitSha": "A String", # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
+ "workspace": "A String", # Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents the result of compiling a Dataform project.
+ "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+ "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+ "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+ "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+ "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+ "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+ "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+ "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+ "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+ "a_key": "A String",
+ },
+ },
+ "compilationErrors": [ # Output only. Errors encountered during project compilation.
+ { # An error encountered when attempting to compile a Dataform project.
+ "actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ "message": "A String", # Output only. The error's top level message.
+ "path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root.
+ "stack": "A String", # Output only. The error's full stack trace.
+ },
+ ],
+ "dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation.
+ "gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+ "name": "A String", # Output only. The compilation result's name.
+ "releaseConfig": "A String", # Immutable. The name of the release config to compile. The release config's 'current_compilation_result' field will be updated to this compilation result. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+ "resolvedGitCommitSha": "A String", # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
+ "workspace": "A String", # Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.
+}
+get(name, x__xgafv=None)
+ Fetches a single CompilationResult.
+
+Args:
+ name: string, Required. The compilation result's name. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents the result of compiling a Dataform project.
+ "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+ "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+ "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+ "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+ "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+ "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+ "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+ "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+ "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+ "a_key": "A String",
+ },
+ },
+ "compilationErrors": [ # Output only. Errors encountered during project compilation.
+ { # An error encountered when attempting to compile a Dataform project.
+ "actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ "message": "A String", # Output only. The error's top level message.
+ "path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root.
+ "stack": "A String", # Output only. The error's full stack trace.
+ },
+ ],
+ "dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation.
+ "gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+ "name": "A String", # Output only. The compilation result's name.
+ "releaseConfig": "A String", # Immutable. The name of the release config to compile. The release config's 'current_compilation_result' field will be updated to this compilation result. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+ "resolvedGitCommitSha": "A String", # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
+ "workspace": "A String", # Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists CompilationResults in a given Repository.
+
+Args:
+ parent: string, Required. The repository in which to list compilation results. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+ pageSize: integer, Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+ pageToken: string, Optional. Page token received from a previous `ListCompilationResults` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCompilationResults` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `ListCompilationResults` response message.
+ "compilationResults": [ # List of compilation results.
+ { # Represents the result of compiling a Dataform project.
+ "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+ "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+ "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+ "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+ "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+ "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+ "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+ "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+ "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+ "a_key": "A String",
+ },
+ },
+ "compilationErrors": [ # Output only. Errors encountered during project compilation.
+ { # An error encountered when attempting to compile a Dataform project.
+ "actionTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The identifier of the action where this error occurred, if available.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ "message": "A String", # Output only. The error's top level message.
+ "path": "A String", # Output only. The path of the file where this error occurred, if available, relative to the project root.
+ "stack": "A String", # Output only. The error's full stack trace.
+ },
+ ],
+ "dataformCoreVersion": "A String", # Output only. The version of `@dataform/core` that was used for compilation.
+ "gitCommitish": "A String", # Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+ "name": "A String", # Output only. The compilation result's name.
+ "releaseConfig": "A String", # Immutable. The name of the release config to compile. The release config's 'current_compilation_result' field will be updated to this compilation result. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+ "resolvedGitCommitSha": "A String", # Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace.
+ "workspace": "A String", # Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "unreachable": [ # Locations which could not be reached.
+ "A String",
+ ],
+}
+list_next()
+ 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. ++
query(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Returns CompilationResultActions in a given CompilationResult.
+
+Args:
+ name: string, Required. The compilation result's name. (required)
+ filter: string, Optional. Optional filter for the returned list. Filtering is only currently supported on the `file_path` field.
+ pageSize: integer, Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+ pageToken: string, Optional. Page token received from a previous `QueryCompilationResultActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryCompilationResultActions` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `QueryCompilationResultActions` response message.
+ "compilationResultActions": [ # List of compilation result actions.
+ { # Represents a single Dataform action in a compilation result.
+ "assertion": { # Represents an assertion upon a SQL query which is required return zero rows. # The assertion executed by this action.
+ "dependencyTargets": [ # A list of actions that this action depends on.
+ { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ ],
+ "disabled": True or False, # Whether this action is disabled (i.e. should not be run).
+ "parentAction": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # The parent action of this assertion. Only set if this assertion was automatically generated.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ "relationDescriptor": { # Describes a relation and its columns. # Descriptor for the assertion's automatically-generated view and its columns.
+ "bigqueryLabels": { # A set of BigQuery labels that should be applied to the relation.
+ "a_key": "A String",
+ },
+ "columns": [ # A list of descriptions of columns within the relation.
+ { # Describes a column.
+ "bigqueryPolicyTags": [ # A list of BigQuery policy tags that will be applied to the column.
+ "A String",
+ ],
+ "description": "A String", # A textual description of the column.
+ "path": [ # The identifier for the column. Each entry in `path` represents one level of nesting.
+ "A String",
+ ],
+ },
+ ],
+ "description": "A String", # A text description of the relation.
+ },
+ "selectQuery": "A String", # The SELECT query which must return zero rows in order for this assertion to succeed.
+ "tags": [ # Arbitrary, user-defined tags on this action.
+ "A String",
+ ],
+ },
+ "canonicalTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ "declaration": { # Represents a relation which is not managed by Dataform but which may be referenced by Dataform actions. # The declaration declared by this action.
+ "relationDescriptor": { # Describes a relation and its columns. # Descriptor for the relation and its columns. Used as documentation only, i.e. values here will result in no changes to the relation's metadata.
+ "bigqueryLabels": { # A set of BigQuery labels that should be applied to the relation.
+ "a_key": "A String",
+ },
+ "columns": [ # A list of descriptions of columns within the relation.
+ { # Describes a column.
+ "bigqueryPolicyTags": [ # A list of BigQuery policy tags that will be applied to the column.
+ "A String",
+ ],
+ "description": "A String", # A textual description of the column.
+ "path": [ # The identifier for the column. Each entry in `path` represents one level of nesting.
+ "A String",
+ ],
+ },
+ ],
+ "description": "A String", # A text description of the relation.
+ },
+ },
+ "filePath": "A String", # The full path including filename in which this action is located, relative to the workspace root.
+ "operations": { # Represents a list of arbitrary database operations. # The database operations executed by this action.
+ "dependencyTargets": [ # A list of actions that this action depends on.
+ { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ ],
+ "disabled": True or False, # Whether this action is disabled (i.e. should not be run).
+ "hasOutput": True or False, # Whether these operations produce an output relation.
+ "queries": [ # A list of arbitrary SQL statements that will be executed without alteration.
+ "A String",
+ ],
+ "relationDescriptor": { # Describes a relation and its columns. # Descriptor for any output relation and its columns. Only set if `has_output` is true.
+ "bigqueryLabels": { # A set of BigQuery labels that should be applied to the relation.
+ "a_key": "A String",
+ },
+ "columns": [ # A list of descriptions of columns within the relation.
+ { # Describes a column.
+ "bigqueryPolicyTags": [ # A list of BigQuery policy tags that will be applied to the column.
+ "A String",
+ ],
+ "description": "A String", # A textual description of the column.
+ "path": [ # The identifier for the column. Each entry in `path` represents one level of nesting.
+ "A String",
+ ],
+ },
+ ],
+ "description": "A String", # A text description of the relation.
+ },
+ "tags": [ # Arbitrary, user-defined tags on this action.
+ "A String",
+ ],
+ },
+ "relation": { # Represents a database relation. # The database relation created/updated by this action.
+ "additionalOptions": { # Additional options that will be provided as key/value pairs into the options clause of a create table/view statement. See https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language for more information on which options are supported.
+ "a_key": "A String",
+ },
+ "clusterExpressions": [ # A list of columns or SQL expressions used to cluster the table.
+ "A String",
+ ],
+ "dependencyTargets": [ # A list of actions that this action depends on.
+ { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ ],
+ "disabled": True or False, # Whether this action is disabled (i.e. should not be run).
+ "incrementalTableConfig": { # Contains settings for relations of type `INCREMENTAL_TABLE`. # Configures `INCREMENTAL_TABLE` settings for this relation. Only set if `relation_type` is `INCREMENTAL_TABLE`.
+ "incrementalPostOperations": [ # SQL statements to be executed after inserting new rows into the relation.
+ "A String",
+ ],
+ "incrementalPreOperations": [ # SQL statements to be executed before inserting new rows into the relation.
+ "A String",
+ ],
+ "incrementalSelectQuery": "A String", # The SELECT query which returns rows which should be inserted into the relation if it already exists and is not being refreshed.
+ "refreshDisabled": True or False, # Whether this table should be protected from being refreshed.
+ "uniqueKeyParts": [ # A set of columns or SQL expressions used to define row uniqueness. If any duplicates are discovered (as defined by `unique_key_parts`), only the newly selected rows (as defined by `incremental_select_query`) will be included in the relation.
+ "A String",
+ ],
+ "updatePartitionFilter": "A String", # A SQL expression conditional used to limit the set of existing rows considered for a merge operation (see `unique_key_parts` for more information).
+ },
+ "partitionExpirationDays": 42, # Sets the partition expiration in days.
+ "partitionExpression": "A String", # The SQL expression used to partition the relation.
+ "postOperations": [ # SQL statements to be executed after creating the relation.
+ "A String",
+ ],
+ "preOperations": [ # SQL statements to be executed before creating the relation.
+ "A String",
+ ],
+ "relationDescriptor": { # Describes a relation and its columns. # Descriptor for the relation and its columns.
+ "bigqueryLabels": { # A set of BigQuery labels that should be applied to the relation.
+ "a_key": "A String",
+ },
+ "columns": [ # A list of descriptions of columns within the relation.
+ { # Describes a column.
+ "bigqueryPolicyTags": [ # A list of BigQuery policy tags that will be applied to the column.
+ "A String",
+ ],
+ "description": "A String", # A textual description of the column.
+ "path": [ # The identifier for the column. Each entry in `path` represents one level of nesting.
+ "A String",
+ ],
+ },
+ ],
+ "description": "A String", # A text description of the relation.
+ },
+ "relationType": "A String", # The type of this relation.
+ "requirePartitionFilter": True or False, # Specifies whether queries on this table must include a predicate filter that filters on the partitioning column.
+ "selectQuery": "A String", # The SELECT query which returns rows which this relation should contain.
+ "tags": [ # Arbitrary, user-defined tags on this action.
+ "A String",
+ ],
+ },
+ "target": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # This action's identifier. Unique within the compilation result.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+query_next()
+ 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. ++
Returns the compilationResults Resource.
+ +
+ releaseConfigs()
+
Returns the releaseConfigs Resource.
+ + +Returns the workflowConfigs Resource.
+ + +Returns the workflowInvocations Resource.
+ +
+ workspaces()
+
Returns the workspaces Resource.
+ +
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, repositoryId=None, x__xgafv=None)
Creates a new Repository in a given project and location.
+
+ delete(name, force=None, x__xgafv=None)
Deletes a single Repository.
+
+ fetchRemoteBranches(name, x__xgafv=None)
Fetches a Repository's remote branches.
+ +Fetches a single Repository.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Repositories in a given project and location.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a single Repository.
+close()
+ Close httplib2 connections.+
create(parent, body=None, repositoryId=None, x__xgafv=None)
+ Creates a new Repository in a given project and location.
+
+Args:
+ parent: string, Required. The location in which to create the repository. Must be in the format `projects/*/locations/*`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Dataform Git repository.
+ "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
+ "authenticationTokenSecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+ "defaultBranch": "A String", # Required. The Git remote's default branch name.
+ "tokenStatus": "A String", # Output only. Indicates the status of the Git access token.
+ "url": "A String", # Required. The Git remote's URL.
+ },
+ "name": "A String", # Output only. The repository's name.
+ "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
+}
+
+ repositoryId: string, Required. The ID to use for the repository, which will become the final component of the repository's resource name.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a Dataform Git repository.
+ "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
+ "authenticationTokenSecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+ "defaultBranch": "A String", # Required. The Git remote's default branch name.
+ "tokenStatus": "A String", # Output only. Indicates the status of the Git access token.
+ "url": "A String", # Required. The Git remote's URL.
+ },
+ "name": "A String", # Output only. The repository's name.
+ "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
+}
+delete(name, force=None, x__xgafv=None)
+ Deletes a single Repository.
+
+Args:
+ name: string, Required. The repository's name. (required)
+ force: boolean, If set to true, any child resources of this repository will also be deleted. (Otherwise, the request will only succeed if the repository has no child resources.)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+fetchRemoteBranches(name, x__xgafv=None)
+ Fetches a Repository's remote branches.
+
+Args:
+ name: string, Required. The repository's name. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `FetchRemoteBranches` response message.
+ "branches": [ # The remote repository's branch names.
+ "A String",
+ ],
+}
+get(name, x__xgafv=None)
+ Fetches a single Repository.
+
+Args:
+ name: string, Required. The repository's name. (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 Dataform Git repository.
+ "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
+ "authenticationTokenSecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+ "defaultBranch": "A String", # Required. The Git remote's default branch name.
+ "tokenStatus": "A String", # Output only. Indicates the status of the Git access token.
+ "url": "A String", # Required. The Git remote's URL.
+ },
+ "name": "A String", # Output only. The repository's name.
+ "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists Repositories in a given project and location.
+
+Args:
+ parent: string, Required. The location in which to list repositories. Must be in the format `projects/*/locations/*`. (required)
+ filter: string, Optional. Filter for the returned list.
+ orderBy: string, Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
+ pageSize: integer, Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+ pageToken: string, Optional. Page token received from a previous `ListRepositories` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepositories` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `ListRepositories` response message.
+ "nextPageToken": "A String", # A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "repositories": [ # List of repositories.
+ { # Represents a Dataform Git repository.
+ "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
+ "authenticationTokenSecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+ "defaultBranch": "A String", # Required. The Git remote's default branch name.
+ "tokenStatus": "A String", # Output only. Indicates the status of the Git access token.
+ "url": "A String", # Required. The Git remote's URL.
+ },
+ "name": "A String", # Output only. The repository's name.
+ "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
+ },
+ ],
+ "unreachable": [ # Locations which could not be reached.
+ "A String",
+ ],
+}
+list_next()
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates a single Repository.
+
+Args:
+ name: string, Output only. The repository's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Dataform Git repository.
+ "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
+ "authenticationTokenSecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+ "defaultBranch": "A String", # Required. The Git remote's default branch name.
+ "tokenStatus": "A String", # Output only. Indicates the status of the Git access token.
+ "url": "A String", # Required. The Git remote's URL.
+ },
+ "name": "A String", # Output only. The repository's name.
+ "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
+}
+
+ updateMask: string, Optional. Specifies the fields to be updated in the repository. If left unset, all fields will be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a Dataform Git repository.
+ "gitRemoteSettings": { # Controls Git remote configuration for a repository. # Optional. If set, configures this repository to be linked to a Git remote.
+ "authenticationTokenSecretVersion": "A String", # Required. The name of the Secret Manager secret version to use as an authentication token for Git operations. Must be in the format `projects/*/secrets/*/versions/*`.
+ "defaultBranch": "A String", # Required. The Git remote's default branch name.
+ "tokenStatus": "A String", # Output only. Indicates the status of the Git access token.
+ "url": "A String", # Required. The Git remote's URL.
+ },
+ "name": "A String", # Output only. The repository's name.
+ "npmrcEnvironmentVariablesSecretVersion": "A String", # Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format.
+}
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, releaseConfigId=None, x__xgafv=None)
Creates a new ReleaseConfig in a given Repository.
+ +Deletes a single ReleaseConfig.
+ +Fetches a single ReleaseConfig.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists ReleaseConfigs in a given Repository.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a single ReleaseConfig.
+close()
+ Close httplib2 connections.+
create(parent, body=None, releaseConfigId=None, x__xgafv=None)
+ Creates a new ReleaseConfig in a given Repository.
+
+Args:
+ parent: string, Required. The repository in which to create the release config. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Dataform release configuration.
+ "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+ "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+ "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+ "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+ "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+ "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+ "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+ "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+ "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+ "a_key": "A String",
+ },
+ },
+ "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic creation of compilation results.
+ "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+ "name": "A String", # Output only. The release config's name.
+ "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+ { # A record of an attempt to create a compilation result for this release config.
+ "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "errorStatus": { # 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). # The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "releaseTime": "A String", # The timestamp of this release attempt.
+ },
+ ],
+ "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is created from this release config, or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+}
+
+ releaseConfigId: string, Required. The ID to use for the release config, which will become the final component of the release config's resource name.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a Dataform release configuration.
+ "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+ "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+ "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+ "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+ "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+ "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+ "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+ "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+ "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+ "a_key": "A String",
+ },
+ },
+ "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic creation of compilation results.
+ "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+ "name": "A String", # Output only. The release config's name.
+ "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+ { # A record of an attempt to create a compilation result for this release config.
+ "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "errorStatus": { # 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). # The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "releaseTime": "A String", # The timestamp of this release attempt.
+ },
+ ],
+ "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is created from this release config, or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+}
+delete(name, x__xgafv=None)
+ Deletes a single ReleaseConfig.
+
+Args:
+ name: string, Required. The release config's name. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+get(name, x__xgafv=None)
+ Fetches a single ReleaseConfig.
+
+Args:
+ name: string, Required. The release config's name. (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 Dataform release configuration.
+ "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+ "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+ "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+ "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+ "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+ "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+ "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+ "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+ "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+ "a_key": "A String",
+ },
+ },
+ "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic creation of compilation results.
+ "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+ "name": "A String", # Output only. The release config's name.
+ "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+ { # A record of an attempt to create a compilation result for this release config.
+ "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "errorStatus": { # 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). # The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "releaseTime": "A String", # The timestamp of this release attempt.
+ },
+ ],
+ "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is created from this release config, or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists ReleaseConfigs in a given Repository.
+
+Args:
+ parent: string, Required. The repository in which to list release configs. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+ pageSize: integer, Optional. Maximum number of release configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+ pageToken: string, Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `ListReleaseConfigs` response message.
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "releaseConfigs": [ # List of release configs.
+ { # Represents a Dataform release configuration.
+ "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+ "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+ "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+ "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+ "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+ "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+ "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+ "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+ "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+ "a_key": "A String",
+ },
+ },
+ "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic creation of compilation results.
+ "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+ "name": "A String", # Output only. The release config's name.
+ "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+ { # A record of an attempt to create a compilation result for this release config.
+ "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "errorStatus": { # 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). # The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "releaseTime": "A String", # The timestamp of this release attempt.
+ },
+ ],
+ "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is created from this release config, or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+ },
+ ],
+ "unreachable": [ # Locations which could not be reached.
+ "A String",
+ ],
+}
+list_next()
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates a single ReleaseConfig.
+
+Args:
+ name: string, Output only. The release config's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Dataform release configuration.
+ "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+ "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+ "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+ "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+ "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+ "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+ "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+ "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+ "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+ "a_key": "A String",
+ },
+ },
+ "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic creation of compilation results.
+ "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+ "name": "A String", # Output only. The release config's name.
+ "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+ { # A record of an attempt to create a compilation result for this release config.
+ "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "errorStatus": { # 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). # The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "releaseTime": "A String", # The timestamp of this release attempt.
+ },
+ ],
+ "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is created from this release config, or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+}
+
+ updateMask: string, Optional. Specifies the fields to be updated in the release config. If left unset, all fields will be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a Dataform release configuration.
+ "codeCompilationConfig": { # Configures various aspects of Dataform code compilation. # Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json.
+ "assertionSchema": "A String", # Optional. The default schema (BigQuery dataset ID) for assertions.
+ "databaseSuffix": "A String", # Optional. The suffix that should be appended to all database (Google Cloud project ID) names.
+ "defaultDatabase": "A String", # Optional. The default database (Google Cloud project ID).
+ "defaultLocation": "A String", # Optional. The default BigQuery location to use. Defaults to "US". See the BigQuery docs for a full list of locations: https://cloud.google.com/bigquery/docs/locations.
+ "defaultSchema": "A String", # Optional. The default schema (BigQuery dataset ID).
+ "schemaSuffix": "A String", # Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
+ "tablePrefix": "A String", # Optional. The prefix that should be prepended to all table names.
+ "vars": { # Optional. User-defined variables that are made available to project code during compilation.
+ "a_key": "A String",
+ },
+ },
+ "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic creation of compilation results.
+ "gitCommitish": "A String", # Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
+ "name": "A String", # Output only. The release config's name.
+ "recentScheduledReleaseRecords": [ # Output only. Records of the 10 most recent scheduled release attempts. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+ { # A record of an attempt to create a compilation result for this release config.
+ "compilationResult": "A String", # The name of the created compilation result, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "errorStatus": { # 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). # The error status encountered upon this attempt to create the compilation result, if the attempt was unsuccessful.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "releaseTime": "A String", # The timestamp of this release attempt.
+ },
+ ],
+ "releaseCompilationResult": "A String", # Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is created from this release config, or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+}
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, workflowConfigId=None, x__xgafv=None)
Creates a new WorkflowConfig in a given Repository.
+ +Deletes a single WorkflowConfig.
+ +Fetches a single WorkflowConfig.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists WorkflowConfigs in a given Repository.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a single WorkflowConfig.
+close()
+ Close httplib2 connections.+
create(parent, body=None, workflowConfigId=None, x__xgafv=None)
+ Creates a new WorkflowConfig in a given Repository.
+
+Args:
+ parent: string, Required. The repository in which to create the workflow config. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Dataform workflow configuration.
+ "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
+ "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
+ "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+ "includedTags": [ # Optional. The set of tags to include.
+ "A String",
+ ],
+ "includedTargets": [ # Optional. The set of action identifiers to include.
+ { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ ],
+ "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+ "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+ },
+ "name": "A String", # Output only. The workflow config's name.
+ "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+ { # A record of an attempt to create a workflow invocation for this workflow config.
+ "errorStatus": { # 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). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "executionTime": "A String", # The timestamp of this execution attempt.
+ "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
+ },
+ ],
+ "releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+ "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+}
+
+ workflowConfigId: string, Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a Dataform workflow configuration.
+ "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
+ "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
+ "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+ "includedTags": [ # Optional. The set of tags to include.
+ "A String",
+ ],
+ "includedTargets": [ # Optional. The set of action identifiers to include.
+ { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ ],
+ "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+ "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+ },
+ "name": "A String", # Output only. The workflow config's name.
+ "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+ { # A record of an attempt to create a workflow invocation for this workflow config.
+ "errorStatus": { # 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). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "executionTime": "A String", # The timestamp of this execution attempt.
+ "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
+ },
+ ],
+ "releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+ "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+}
+delete(name, x__xgafv=None)
+ Deletes a single WorkflowConfig.
+
+Args:
+ name: string, Required. The workflow config's name. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+get(name, x__xgafv=None)
+ Fetches a single WorkflowConfig.
+
+Args:
+ name: string, Required. The workflow config's name. (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 Dataform workflow configuration.
+ "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
+ "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
+ "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+ "includedTags": [ # Optional. The set of tags to include.
+ "A String",
+ ],
+ "includedTargets": [ # Optional. The set of action identifiers to include.
+ { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ ],
+ "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+ "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+ },
+ "name": "A String", # Output only. The workflow config's name.
+ "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+ { # A record of an attempt to create a workflow invocation for this workflow config.
+ "errorStatus": { # 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). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "executionTime": "A String", # The timestamp of this execution attempt.
+ "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
+ },
+ ],
+ "releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+ "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists WorkflowConfigs in a given Repository.
+
+Args:
+ parent: string, Required. The repository in which to list workflow configs. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+ pageSize: integer, Optional. Maximum number of workflow configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+ pageToken: string, Optional. Page token received from a previous `ListWorkflowConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowConfigs` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `ListWorkflowConfigs` response message.
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "unreachable": [ # Locations which could not be reached.
+ "A String",
+ ],
+ "workflowConfigs": [ # List of workflow configs.
+ { # Represents a Dataform workflow configuration.
+ "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
+ "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
+ "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+ "includedTags": [ # Optional. The set of tags to include.
+ "A String",
+ ],
+ "includedTargets": [ # Optional. The set of action identifiers to include.
+ { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ ],
+ "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+ "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+ },
+ "name": "A String", # Output only. The workflow config's name.
+ "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+ { # A record of an attempt to create a workflow invocation for this workflow config.
+ "errorStatus": { # 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). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "executionTime": "A String", # The timestamp of this execution attempt.
+ "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
+ },
+ ],
+ "releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+ "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+ },
+ ],
+}
+list_next()
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates a single WorkflowConfig.
+
+Args:
+ name: string, Output only. The workflow config's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Dataform workflow configuration.
+ "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
+ "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
+ "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+ "includedTags": [ # Optional. The set of tags to include.
+ "A String",
+ ],
+ "includedTargets": [ # Optional. The set of action identifiers to include.
+ { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ ],
+ "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+ "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+ },
+ "name": "A String", # Output only. The workflow config's name.
+ "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+ { # A record of an attempt to create a workflow invocation for this workflow config.
+ "errorStatus": { # 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). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "executionTime": "A String", # The timestamp of this execution attempt.
+ "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
+ },
+ ],
+ "releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+ "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+}
+
+ updateMask: string, Optional. Specifies the fields to be updated in the workflow config. If left unset, all fields will be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a Dataform workflow configuration.
+ "cronSchedule": "A String", # Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
+ "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Optional. If left unset, a default InvocationConfig will be used.
+ "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+ "includedTags": [ # Optional. The set of tags to include.
+ "A String",
+ ],
+ "includedTargets": [ # Optional. The set of action identifiers to include.
+ { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ ],
+ "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+ "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+ },
+ "name": "A String", # Output only. The workflow config's name.
+ "recentScheduledExecutionRecords": [ # Output only. Records of the 10 most recent scheduled execution attempts. Updated whenever automatic creation of a compilation result is triggered by cron_schedule.
+ { # A record of an attempt to create a workflow invocation for this workflow config.
+ "errorStatus": { # 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). # The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "executionTime": "A String", # The timestamp of this execution attempt.
+ "workflowInvocation": "A String", # The name of the created workflow invocation, if one was successfully created. Must be in the format `projects/*/locations/*/repositories/*/workflowInvocations/*`.
+ },
+ ],
+ "releaseConfig": "A String", # Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.
+ "timeZone": "A String", # Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+}
+
+ cancel(name, body=None, x__xgafv=None)
Requests cancellation of a running WorkflowInvocation.
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a new WorkflowInvocation in a given Repository.
+ +Deletes a single WorkflowInvocation.
+ +Fetches a single WorkflowInvocation.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists WorkflowInvocations in a given Repository.
+ +Retrieves the next page of results.
+
+ query(name, pageSize=None, pageToken=None, x__xgafv=None)
Returns WorkflowInvocationActions in a given WorkflowInvocation.
+ +Retrieves the next page of results.
+cancel(name, body=None, x__xgafv=None)
+ Requests cancellation of a running WorkflowInvocation.
+
+Args:
+ name: string, Required. The workflow invocation resource's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # `CancelWorkflowInvocation` request message.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates a new WorkflowInvocation in a given Repository.
+
+Args:
+ parent: string, Required. The repository in which to create the workflow invocation. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a single invocation of a compilation result.
+ "compilationResult": "A String", # Immutable. The name of the compilation result to compile. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
+ "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+ "includedTags": [ # Optional. The set of tags to include.
+ "A String",
+ ],
+ "includedTargets": [ # Optional. The set of action identifiers to include.
+ { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ ],
+ "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+ "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+ },
+ "invocationTiming": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation's timing details.
+ "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+ "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+ },
+ "name": "A String", # Output only. The workflow invocation's name.
+ "state": "A String", # Output only. This workflow invocation's current state.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a single invocation of a compilation result.
+ "compilationResult": "A String", # Immutable. The name of the compilation result to compile. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
+ "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+ "includedTags": [ # Optional. The set of tags to include.
+ "A String",
+ ],
+ "includedTargets": [ # Optional. The set of action identifiers to include.
+ { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ ],
+ "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+ "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+ },
+ "invocationTiming": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation's timing details.
+ "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+ "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+ },
+ "name": "A String", # Output only. The workflow invocation's name.
+ "state": "A String", # Output only. This workflow invocation's current state.
+}
+delete(name, x__xgafv=None)
+ Deletes a single WorkflowInvocation.
+
+Args:
+ name: string, Required. The workflow invocation resource's name. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+get(name, x__xgafv=None)
+ Fetches a single WorkflowInvocation.
+
+Args:
+ name: string, Required. The workflow invocation resource's name. (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 single invocation of a compilation result.
+ "compilationResult": "A String", # Immutable. The name of the compilation result to compile. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
+ "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+ "includedTags": [ # Optional. The set of tags to include.
+ "A String",
+ ],
+ "includedTargets": [ # Optional. The set of action identifiers to include.
+ { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ ],
+ "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+ "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+ },
+ "invocationTiming": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation's timing details.
+ "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+ "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+ },
+ "name": "A String", # Output only. The workflow invocation's name.
+ "state": "A String", # Output only. This workflow invocation's current state.
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists WorkflowInvocations in a given Repository.
+
+Args:
+ parent: string, Required. The parent resource of the WorkflowInvocation type. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+ filter: string, Optional. Filter for the returned list.
+ orderBy: string, Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
+ pageSize: integer, Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+ pageToken: string, Optional. Page token received from a previous `ListWorkflowInvocations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflowInvocations` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `ListWorkflowInvocations` response message.
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "unreachable": [ # Locations which could not be reached.
+ "A String",
+ ],
+ "workflowInvocations": [ # List of workflow invocations.
+ { # Represents a single invocation of a compilation result.
+ "compilationResult": "A String", # Immutable. The name of the compilation result to compile. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.
+ "invocationConfig": { # Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. # Immutable. If left unset, a default InvocationConfig will be used.
+ "fullyRefreshIncrementalTablesEnabled": True or False, # Optional. When set to true, any incremental tables will be fully refreshed.
+ "includedTags": [ # Optional. The set of tags to include.
+ "A String",
+ ],
+ "includedTargets": [ # Optional. The set of action identifiers to include.
+ { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ ],
+ "transitiveDependenciesIncluded": True or False, # Optional. When set to true, transitive dependencies of included actions will be executed.
+ "transitiveDependentsIncluded": True or False, # Optional. When set to true, transitive dependents of included actions will be executed.
+ },
+ "invocationTiming": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This workflow invocation's timing details.
+ "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+ "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+ },
+ "name": "A String", # Output only. The workflow invocation's name.
+ "state": "A String", # Output only. This workflow invocation's current state.
+ },
+ ],
+}
+list_next()
+ 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. ++
query(name, pageSize=None, pageToken=None, x__xgafv=None)
+ Returns WorkflowInvocationActions in a given WorkflowInvocation.
+
+Args:
+ name: string, Required. The workflow invocation's name. (required)
+ pageSize: integer, Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+ pageToken: string, Optional. Page token received from a previous `QueryWorkflowInvocationActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryWorkflowInvocationActions` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `QueryWorkflowInvocationActions` response message.
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "workflowInvocationActions": [ # List of workflow invocation actions.
+ { # Represents a single action in a workflow invocation.
+ "bigqueryAction": { # Represents a workflow action that will run against BigQuery. # Output only. The workflow action's bigquery action details.
+ "sqlScript": "A String", # Output only. The generated BigQuery SQL script that will be executed.
+ },
+ "canonicalTarget": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ "failureReason": "A String", # Output only. If and only if action's state is FAILED a failure reason is set.
+ "invocationTiming": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Output only. This action's timing details. `start_time` will be set if the action is in [RUNNING, SUCCEEDED, CANCELLED, FAILED] state. `end_time` will be set if the action is in [SUCCEEDED, CANCELLED, FAILED] state.
+ "endTime": "A String", # Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
+ "startTime": "A String", # Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
+ },
+ "state": "A String", # Output only. This action's current state.
+ "target": { # Represents an action identifier. If the action writes output, the output will be written to the referenced database object. # Output only. This action's identifier. Unique within the workflow invocation.
+ "database": "A String", # The action's database (Google Cloud project ID) .
+ "name": "A String", # The action's name, within `database` and `schema`.
+ "schema": "A String", # The action's schema (BigQuery dataset ID), within `database`.
+ },
+ },
+ ],
+}
+query_next()
+ 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. ++
+ close()
Close httplib2 connections.
+
+ commit(name, body=None, x__xgafv=None)
Applies a Git commit for uncommitted files in a Workspace.
+
+ create(parent, body=None, workspaceId=None, x__xgafv=None)
Creates a new Workspace in a given Repository.
+ +Deletes a single Workspace.
+
+ fetchFileDiff(workspace, path=None, x__xgafv=None)
Fetches Git diff for an uncommitted file in a Workspace.
+
+ fetchFileGitStatuses(name, x__xgafv=None)
Fetches Git statuses for the files in a Workspace.
+
+ fetchGitAheadBehind(name, remoteBranch=None, x__xgafv=None)
Fetches Git ahead/behind against a remote branch.
+ +Fetches a single Workspace.
+
+ installNpmPackages(workspace, body=None, x__xgafv=None)
Installs dependency NPM packages (inside a Workspace).
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Workspaces in a given Repository.
+ +Retrieves the next page of results.
+
+ makeDirectory(workspace, body=None, x__xgafv=None)
Creates a directory inside a Workspace.
+
+ moveDirectory(workspace, body=None, x__xgafv=None)
Moves a directory (inside a Workspace), and all of its contents, to a new location.
+
+ moveFile(workspace, body=None, x__xgafv=None)
Moves a file (inside a Workspace) to a new location.
+
+ pull(name, body=None, x__xgafv=None)
Pulls Git commits from the Repository's remote into a Workspace.
+
+ push(name, body=None, x__xgafv=None)
Pushes Git commits from a Workspace to the Repository's remote.
+
+ queryDirectoryContents(workspace, pageSize=None, pageToken=None, path=None, x__xgafv=None)
Returns the contents of a given Workspace directory.
+
+ queryDirectoryContents_next()
Retrieves the next page of results.
+
+ readFile(workspace, path=None, x__xgafv=None)
Returns the contents of a file (inside a Workspace).
+
+ removeDirectory(workspace, body=None, x__xgafv=None)
Deletes a directory (inside a Workspace) and all of its contents.
+
+ removeFile(workspace, body=None, x__xgafv=None)
Deletes a file (inside a Workspace).
+
+ reset(name, body=None, x__xgafv=None)
Performs a Git reset for uncommitted files in a Workspace.
+
+ writeFile(workspace, body=None, x__xgafv=None)
Writes to a file (inside a Workspace).
+close()
+ Close httplib2 connections.+
commit(name, body=None, x__xgafv=None)
+ Applies a Git commit for uncommitted files in a Workspace.
+
+Args:
+ name: string, Required. The workspace's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # `CommitWorkspaceChanges` request message.
+ "author": { # Represents the author of a Git commit. # Required. The commit's author.
+ "emailAddress": "A String", # Required. The commit author's email address.
+ "name": "A String", # Required. The commit author's name.
+ },
+ "commitMessage": "A String", # Optional. The commit's message.
+ "paths": [ # Optional. Full file paths to commit including filename, rooted at workspace root. If left empty, all files will be committed.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+create(parent, body=None, workspaceId=None, x__xgafv=None)
+ Creates a new Workspace in a given Repository.
+
+Args:
+ parent: string, Required. The repository in which to create the workspace. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a Dataform Git workspace.
+ "name": "A String", # Output only. The workspace's name.
+}
+
+ workspaceId: string, Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a Dataform Git workspace.
+ "name": "A String", # Output only. The workspace's name.
+}
+delete(name, x__xgafv=None)
+ Deletes a single Workspace.
+
+Args:
+ name: string, Required. The workspace resource's name. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+fetchFileDiff(workspace, path=None, x__xgafv=None)
+ Fetches Git diff for an uncommitted file in a Workspace.
+
+Args:
+ workspace: string, Required. The workspace's name. (required)
+ path: string, Required. The file's full path including filename, relative to the workspace root.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `FetchFileDiff` response message.
+ "formattedDiff": "A String", # The raw formatted Git diff for the file.
+}
+fetchFileGitStatuses(name, x__xgafv=None)
+ Fetches Git statuses for the files in a Workspace.
+
+Args:
+ name: string, Required. The workspace's name. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `FetchFileGitStatuses` response message.
+ "uncommittedFileChanges": [ # A list of all files which have uncommitted Git changes. There will only be a single entry for any given file.
+ { # Represents the Git state of a file with uncommitted changes.
+ "path": "A String", # The file's full path including filename, relative to the workspace root.
+ "state": "A String", # Indicates the status of the file.
+ },
+ ],
+}
+fetchGitAheadBehind(name, remoteBranch=None, x__xgafv=None)
+ Fetches Git ahead/behind against a remote branch.
+
+Args:
+ name: string, Required. The workspace's name. (required)
+ remoteBranch: string, Optional. The name of the branch in the Git remote against which this workspace should be compared. If left unset, the repository's default branch name will be used.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `FetchGitAheadBehind` response message.
+ "commitsAhead": 42, # The number of commits in the remote branch that are not in the workspace.
+ "commitsBehind": 42, # The number of commits in the workspace that are not in the remote branch.
+}
+get(name, x__xgafv=None)
+ Fetches a single Workspace.
+
+Args:
+ name: string, Required. The workspace's name. (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 Dataform Git workspace.
+ "name": "A String", # Output only. The workspace's name.
+}
+installNpmPackages(workspace, body=None, x__xgafv=None)
+ Installs dependency NPM packages (inside a Workspace).
+
+Args:
+ workspace: string, Required. The workspace's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # `InstallNpmPackages` request message.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `InstallNpmPackages` response message.
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists Workspaces in a given Repository.
+
+Args:
+ parent: string, Required. The repository in which to list workspaces. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+ filter: string, Optional. Filter for the returned list.
+ orderBy: string, Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
+ pageSize: integer, Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+ pageToken: string, Optional. Page token received from a previous `ListWorkspaces` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkspaces` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `ListWorkspaces` response message.
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "unreachable": [ # Locations which could not be reached.
+ "A String",
+ ],
+ "workspaces": [ # List of workspaces.
+ { # Represents a Dataform Git workspace.
+ "name": "A String", # Output only. The workspace's name.
+ },
+ ],
+}
+list_next()
+ 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. ++
makeDirectory(workspace, body=None, x__xgafv=None)
+ Creates a directory inside a Workspace.
+
+Args:
+ workspace: string, Required. The workspace's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # `MakeDirectory` request message.
+ "path": "A String", # Required. The directory's full path including directory name, relative to the workspace root.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `MakeDirectory` response message.
+}
+moveDirectory(workspace, body=None, x__xgafv=None)
+ Moves a directory (inside a Workspace), and all of its contents, to a new location.
+
+Args:
+ workspace: string, Required. The workspace's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # `MoveDirectory` request message.
+ "newPath": "A String", # Required. The new path for the directory including directory name, rooted at workspace root.
+ "path": "A String", # Required. The directory's full path including directory name, relative to the workspace root.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `MoveDirectory` response message.
+}
+moveFile(workspace, body=None, x__xgafv=None)
+ Moves a file (inside a Workspace) to a new location.
+
+Args:
+ workspace: string, Required. The workspace's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # `MoveFile` request message.
+ "newPath": "A String", # Required. The file's new path including filename, relative to the workspace root.
+ "path": "A String", # Required. The file's full path including filename, relative to the workspace root.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `MoveFile` response message.
+}
+pull(name, body=None, x__xgafv=None)
+ Pulls Git commits from the Repository's remote into a Workspace.
+
+Args:
+ name: string, Required. The workspace's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # `PullGitCommits` request message.
+ "author": { # Represents the author of a Git commit. # Required. The author of any merge commit which may be created as a result of merging fetched Git commits into this workspace.
+ "emailAddress": "A String", # Required. The commit author's email address.
+ "name": "A String", # Required. The commit author's name.
+ },
+ "remoteBranch": "A String", # Optional. The name of the branch in the Git remote from which to pull commits. If left unset, the repository's default branch name will be used.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+push(name, body=None, x__xgafv=None)
+ Pushes Git commits from a Workspace to the Repository's remote.
+
+Args:
+ name: string, Required. The workspace's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # `PushGitCommits` request message.
+ "remoteBranch": "A String", # Optional. The name of the branch in the Git remote to which commits should be pushed. If left unset, the repository's default branch name will be used.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+queryDirectoryContents(workspace, pageSize=None, pageToken=None, path=None, x__xgafv=None)
+ Returns the contents of a given Workspace directory.
+
+Args:
+ workspace: string, Required. The workspace's name. (required)
+ pageSize: integer, Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
+ pageToken: string, Optional. Page token received from a previous `QueryDirectoryContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDirectoryContents` must match the call that provided the page token.
+ path: string, Optional. The directory's full path including directory name, relative to the workspace root. If left unset, the workspace root is used.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `QueryDirectoryContents` response message.
+ "directoryEntries": [ # List of entries in the directory.
+ { # Represents a single entry in a workspace directory.
+ "directory": "A String", # A child directory in the directory.
+ "file": "A String", # A file in the directory.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+queryDirectoryContents_next()
+ 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. ++
readFile(workspace, path=None, x__xgafv=None)
+ Returns the contents of a file (inside a Workspace).
+
+Args:
+ workspace: string, Required. The workspace's name. (required)
+ path: string, Required. The file's full path including filename, relative to the workspace root.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `ReadFile` response message.
+ "fileContents": "A String", # The file's contents.
+}
+removeDirectory(workspace, body=None, x__xgafv=None)
+ Deletes a directory (inside a Workspace) and all of its contents.
+
+Args:
+ workspace: string, Required. The workspace's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # `RemoveDirectory` request message.
+ "path": "A String", # Required. The directory's full path including directory name, relative to the workspace root.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+removeFile(workspace, body=None, x__xgafv=None)
+ Deletes a file (inside a Workspace).
+
+Args:
+ workspace: string, Required. The workspace's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # `RemoveFile` request message.
+ "path": "A String", # Required. The file's full path including filename, relative to the workspace root.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+reset(name, body=None, x__xgafv=None)
+ Performs a Git reset for uncommitted files in a Workspace.
+
+Args:
+ name: string, Required. The workspace's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # `ResetWorkspaceChanges` request message.
+ "clean": True or False, # Optional. If set to true, untracked files will be deleted.
+ "paths": [ # Optional. Full file paths to reset back to their committed state including filename, rooted at workspace root. If left empty, all files will be reset.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+writeFile(workspace, body=None, x__xgafv=None)
+ Writes to a file (inside a Workspace).
+
+Args:
+ workspace: string, Required. The workspace's name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # `WriteFile` request message.
+ "contents": "A String", # Required. The file's contents.
+ "path": "A String", # Required. The file.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # `WriteFile` response message.
+}
+close()
Close httplib2 connections.
- create(parent, body=None, connectionProfileId=None, requestId=None, x__xgafv=None)
create(parent, body=None, connectionProfileId=None, requestId=None, skipValidation=None, validateOnly=None, x__xgafv=None)
Creates a new connection profile in a given project and location.
delete(name, force=None, requestId=None, x__xgafv=None)
list_next()
Retrieves the next page of results.
- patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
patch(name, body=None, requestId=None, skipValidation=None, updateMask=None, validateOnly=None, x__xgafv=None)
Update the configuration of a single connection profile.
setIamPolicy(resource, body=None, x__xgafv=None)
create(parent, body=None, connectionProfileId=None, requestId=None, x__xgafv=None)
+ create(parent, body=None, connectionProfileId=None, requestId=None, skipValidation=None, validateOnly=None, x__xgafv=None)
Creates a new connection profile in a given project and location. Args: @@ -218,6 +218,26 @@Method Details
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. + "oracle": { # Specifies connection parameters required specifically for Oracle databases. # An Oracle database connection profile. + "databaseService": "A String", # Required. Database service for the Oracle connection. + "forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity. + "hostname": "A String", # Required. Hostname for the SSH tunnel. + "password": "A String", # Input only. SSH password. + "port": 42, # Port for the SSH tunnel, default value is 22. + "privateKey": "A String", # Input only. SSH private key. + "username": "A String", # Required. Username for the SSH tunnel. + }, + "host": "A String", # Required. The IP or hostname of the source Oracle database. + "password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. + "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. + "port": 42, # Required. The network port of the source Oracle database. + "privateConnectivity": { # Private Connectivity. # Private connectivity. + "privateConnection": "A String", # Required. The resource name (URI) of the private connection. + }, + "staticServiceIpConnectivity": { # Static IP address connectivity configured on service project. # Static Service IP connectivity. + }, + "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. + }, "postgresql": { # Specifies connection parameters required specifically for PostgreSQL databases. # A PostgreSQL database connection profile. "cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. "host": "A String", # Required. The IP or hostname of the source PostgreSQL database. @@ -225,12 +245,17 @@Method Details
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates If this connection profile password is stored. "port": 42, # Required. The network port of the source PostgreSQL database. + "privateServiceConnectConnectivity": { # Private Service Connect connectivity (https://cloud.google.com/vpc/docs/private-service-connect#benefits-services) # Private service connect connectivity. + "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} + }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. "clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory. "type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. }, + "staticIpConnectivity": { # The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # Static ip connectivity data (default, no additional details needed). + }, "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "provider": "A String", # The database provider. @@ -240,6 +265,8 @@Method Details
connectionProfileId: string, Required. The connection profile identifier. requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + skipValidation: boolean, Optional. Create the connection profile without validating it. The default is false. Only supported for Oracle connection profiles. + validateOnly: boolean, Optional. Only validate the connection profile, but don't create any resources. The default is false. Only supported for Oracle connection profiles. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -419,6 +446,26 @@Method Details
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. + "oracle": { # Specifies connection parameters required specifically for Oracle databases. # An Oracle database connection profile. + "databaseService": "A String", # Required. Database service for the Oracle connection. + "forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity. + "hostname": "A String", # Required. Hostname for the SSH tunnel. + "password": "A String", # Input only. SSH password. + "port": 42, # Port for the SSH tunnel, default value is 22. + "privateKey": "A String", # Input only. SSH private key. + "username": "A String", # Required. Username for the SSH tunnel. + }, + "host": "A String", # Required. The IP or hostname of the source Oracle database. + "password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. + "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. + "port": 42, # Required. The network port of the source Oracle database. + "privateConnectivity": { # Private Connectivity. # Private connectivity. + "privateConnection": "A String", # Required. The resource name (URI) of the private connection. + }, + "staticServiceIpConnectivity": { # Static IP address connectivity configured on service project. # Static Service IP connectivity. + }, + "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. + }, "postgresql": { # Specifies connection parameters required specifically for PostgreSQL databases. # A PostgreSQL database connection profile. "cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. "host": "A String", # Required. The IP or hostname of the source PostgreSQL database. @@ -426,12 +473,17 @@Method Details
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates If this connection profile password is stored. "port": 42, # Required. The network port of the source PostgreSQL database. + "privateServiceConnectConnectivity": { # Private Service Connect connectivity (https://cloud.google.com/vpc/docs/private-service-connect#benefits-services) # Private service connect connectivity. + "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} + }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. "clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory. "type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. }, + "staticIpConnectivity": { # The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # Static ip connectivity data (default, no additional details needed). + }, "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "provider": "A String", # The database provider. @@ -607,6 +659,26 @@Method Details
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. + "oracle": { # Specifies connection parameters required specifically for Oracle databases. # An Oracle database connection profile. + "databaseService": "A String", # Required. Database service for the Oracle connection. + "forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity. + "hostname": "A String", # Required. Hostname for the SSH tunnel. + "password": "A String", # Input only. SSH password. + "port": 42, # Port for the SSH tunnel, default value is 22. + "privateKey": "A String", # Input only. SSH private key. + "username": "A String", # Required. Username for the SSH tunnel. + }, + "host": "A String", # Required. The IP or hostname of the source Oracle database. + "password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. + "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. + "port": 42, # Required. The network port of the source Oracle database. + "privateConnectivity": { # Private Connectivity. # Private connectivity. + "privateConnection": "A String", # Required. The resource name (URI) of the private connection. + }, + "staticServiceIpConnectivity": { # Static IP address connectivity configured on service project. # Static Service IP connectivity. + }, + "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. + }, "postgresql": { # Specifies connection parameters required specifically for PostgreSQL databases. # A PostgreSQL database connection profile. "cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. "host": "A String", # Required. The IP or hostname of the source PostgreSQL database. @@ -614,12 +686,17 @@Method Details
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates If this connection profile password is stored. "port": 42, # Required. The network port of the source PostgreSQL database. + "privateServiceConnectConnectivity": { # Private Service Connect connectivity (https://cloud.google.com/vpc/docs/private-service-connect#benefits-services) # Private service connect connectivity. + "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} + }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. "clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory. "type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. }, + "staticIpConnectivity": { # The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # Static ip connectivity data (default, no additional details needed). + }, "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "provider": "A String", # The database provider. @@ -649,7 +726,7 @@Method Details
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)
+ patch(name, body=None, requestId=None, skipValidation=None, updateMask=None, validateOnly=None, x__xgafv=None)
Update the configuration of a single connection profile. Args: @@ -756,6 +833,26 @@Method Details
"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. + "oracle": { # Specifies connection parameters required specifically for Oracle databases. # An Oracle database connection profile. + "databaseService": "A String", # Required. Database service for the Oracle connection. + "forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity. + "hostname": "A String", # Required. Hostname for the SSH tunnel. + "password": "A String", # Input only. SSH password. + "port": 42, # Port for the SSH tunnel, default value is 22. + "privateKey": "A String", # Input only. SSH private key. + "username": "A String", # Required. Username for the SSH tunnel. + }, + "host": "A String", # Required. The IP or hostname of the source Oracle database. + "password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. + "passwordSet": True or False, # Output only. Indicates whether a new password is included in the request. + "port": 42, # Required. The network port of the source Oracle database. + "privateConnectivity": { # Private Connectivity. # Private connectivity. + "privateConnection": "A String", # Required. The resource name (URI) of the private connection. + }, + "staticServiceIpConnectivity": { # Static IP address connectivity configured on service project. # Static Service IP connectivity. + }, + "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. + }, "postgresql": { # Specifies connection parameters required specifically for PostgreSQL databases. # A PostgreSQL database connection profile. "cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source. "host": "A String", # Required. The IP or hostname of the source PostgreSQL database. @@ -763,12 +860,17 @@Method Details
"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. "passwordSet": True or False, # Output only. Indicates If this connection profile password is stored. "port": 42, # Required. The network port of the source PostgreSQL database. + "privateServiceConnectConnectivity": { # Private Service Connect connectivity (https://cloud.google.com/vpc/docs/private-service-connect#benefits-services) # Private service connect connectivity. + "serviceAttachment": "A String", # Required. A service attachment that exposes a database, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name} + }, "ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database. "caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host. "clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory. "clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory. "type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'. }, + "staticIpConnectivity": { # The source database will allow incoming connections from the destination database's public IP. You can retrieve the Cloud SQL instance's public IP from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. # Static ip connectivity data (default, no additional details needed). + }, "username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service. }, "provider": "A String", # The database provider. @@ -777,7 +879,9 @@Method Details
} requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + skipValidation: boolean, Optional. Update the connection profile without validating it. The default is false. Only supported for Oracle connection profiles. updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the connection profile resource by the update. + validateOnly: boolean, Optional. Only validate the connection profile, but don't update any resources. The default is false. Only supported for Oracle connection profiles. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html new file mode 100644 index 00000000000..95dc8014bfa --- /dev/null +++ b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.html @@ -0,0 +1,891 @@ + + + +Database Migration API . projects . locations . conversionWorkspaces
+Instance Methods
++
+mappingRules()+Returns the mappingRules Resource.
+ ++
+apply(name, body=None, x__xgafv=None)Apply draft tree onto a specific destination database
++
+close()Close httplib2 connections.
++
+commit(name, body=None, x__xgafv=None)Marks all the data in the conversion workspace as committed.
++
+convert(name, body=None, x__xgafv=None)Creates a draft tree schema for the destination database.
++
+create(parent, body=None, conversionWorkspaceId=None, requestId=None, x__xgafv=None)Creates a new conversion workspace in a given project and location.
++
+delete(name, requestId=None, x__xgafv=None)Deletes a single conversion workspace.
++
+describeConversionWorkspaceRevisions(conversionWorkspace, commitId=None, x__xgafv=None)Retrieves a list of committed revisions of a specific conversion workspace.
+ +Use this method to describe the database entities tree for a specific conversion workspace and a specific tree type. The DB Entities are not a resource like conversion workspace or mapping rule, and they can not be created, updated or deleted like one. Instead they are simple data objects describing the structure of the client database.
++
+describeDatabaseEntities_next()Retrieves the next page of results.
+ +Gets details of a single conversion workspace.
++
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists conversion workspaces in a given project and location.
+ +Retrieves the next page of results.
++
+patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)Updates the parameters of a single conversion workspace.
++
+rollback(name, body=None, x__xgafv=None)Rollbacks a conversion workspace to the last committed spanshot.
+ +Use this method to search/list the background jobs for a specific conversion workspace. The background jobs are not a resource like conversion workspace or mapping rule, and they can not be created, updated or deleted like one. Instead they are a way to expose the data plane jobs log.
++
+seed(name, body=None, x__xgafv=None)Imports a snapshot of the source database into the conversion workspace.
+Method Details
+++ +apply(name, body=None, x__xgafv=None)+Apply draft tree onto a specific destination database + +Args: + name: string, Required. Name of the conversion workspace resource to apply draft to destination for. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for 'ApplyConversionWorkspace' request. + "connectionProfile": "A String", # Fully qualified (Uri) name of the destination connection profile. + "filter": "A String", # Filter which entities to apply. Leaving this field empty will apply all of the entities. Supports Google AIP 160 based filtering. +} + + 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. + "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. + "error": { # 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). # The error result of the operation in case of failure or cancellation. + "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. + }, + ], + "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. + }, + "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. + }, + "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}`. + "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. + }, +}+++ +close()+Close httplib2 connections.+++ +commit(name, body=None, x__xgafv=None)+Marks all the data in the conversion workspace as committed. + +Args: + name: string, Required. Name of the conversion workspace resource to commit. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for 'CommitConversionWorkspace' request. + "commitName": "A String", # Optional name of the commit. +} + + 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. + "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. + "error": { # 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). # The error result of the operation in case of failure or cancellation. + "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. + }, + ], + "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. + }, + "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. + }, + "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}`. + "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. + }, +}+++ +convert(name, body=None, x__xgafv=None)+Creates a draft tree schema for the destination database. + +Args: + name: string, Name of the conversion workspace resource to convert in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for 'ConvertConversionWorkspace' request. + "autoCommit": True or False, # Should the conversion workspace be committed automatically after the conversion. + "filter": "A String", # Filter the entities to convert. Leaving this field empty will convert all of the entities. Supports Google AIP-160 style filtering. +} + + 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. + "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. + "error": { # 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). # The error result of the operation in case of failure or cancellation. + "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. + }, + ], + "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. + }, + "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. + }, + "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}`. + "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. + }, +}+++ +create(parent, body=None, conversionWorkspaceId=None, requestId=None, x__xgafv=None)+Creates a new conversion workspace in a given project and location. + +Args: + parent: string, Required. The parent, which owns this collection of conversion workspaces. (required) + body: object, The request body. + The object takes the form of: + +{ # The main conversion workspace resource entity. + "createTime": "A String", # Output only. The timestamp when the workspace resource was created. + "destination": { # The type and version of a source or destination DB. # Required. The destination engine details. + "engine": "A String", # Required. Engine Type. + "version": "A String", # Required. Engine named version, for e.g. 12.c.1 + }, + "displayName": "A String", # The display name for the workspace + "globalSettings": { # A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true + "a_key": "A String", + }, + "hasUncommittedChanges": True or False, # Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed) + "latestCommitId": "A String", # Output only. The latest commit id + "latestCommitTime": "A String", # Output only. The timestamp when the workspace was committed. + "name": "A String", # Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. + "source": { # The type and version of a source or destination DB. # Required. The source engine details. + "engine": "A String", # Required. Engine Type. + "version": "A String", # Required. Engine named version, for e.g. 12.c.1 + }, + "updateTime": "A String", # Output only. The timestamp when the workspace resource was last updated. +} + + conversionWorkspaceId: string, Required. The ID of the conversion workspace to create. + requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + 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. + "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. + "error": { # 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). # The error result of the operation in case of failure or cancellation. + "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. + }, + ], + "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. + }, + "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. + }, + "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}`. + "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. + }, +}+++ +delete(name, requestId=None, x__xgafv=None)+Deletes a single conversion workspace. + +Args: + name: string, Required. Name of the conversion workspace resource to delete. (required) + requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + 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. + "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. + "error": { # 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). # The error result of the operation in case of failure or cancellation. + "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. + }, + ], + "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. + }, + "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. + }, + "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}`. + "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. + }, +}+++ +describeConversionWorkspaceRevisions(conversionWorkspace, commitId=None, x__xgafv=None)+Retrieves a list of committed revisions of a specific conversion workspace. + +Args: + conversionWorkspace: string, Required. Name of the conversion workspace resource whose revisions are listed. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required) + commitId: string, Optional filter to request a specific commit id + 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 'DescribeConversionWorkspaceRevisions' request. + "revisions": [ # The list of conversion workspace revisions. + { # The main conversion workspace resource entity. + "createTime": "A String", # Output only. The timestamp when the workspace resource was created. + "destination": { # The type and version of a source or destination DB. # Required. The destination engine details. + "engine": "A String", # Required. Engine Type. + "version": "A String", # Required. Engine named version, for e.g. 12.c.1 + }, + "displayName": "A String", # The display name for the workspace + "globalSettings": { # A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true + "a_key": "A String", + }, + "hasUncommittedChanges": True or False, # Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed) + "latestCommitId": "A String", # Output only. The latest commit id + "latestCommitTime": "A String", # Output only. The timestamp when the workspace was committed. + "name": "A String", # Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. + "source": { # The type and version of a source or destination DB. # Required. The source engine details. + "engine": "A String", # Required. Engine Type. + "version": "A String", # Required. Engine named version, for e.g. 12.c.1 + }, + "updateTime": "A String", # Output only. The timestamp when the workspace resource was last updated. + }, + ], +}+++ +describeDatabaseEntities(conversionWorkspace, commitId=None, filter=None, pageSize=None, pageToken=None, tree=None, uncommitted=None, x__xgafv=None)+Use this method to describe the database entities tree for a specific conversion workspace and a specific tree type. The DB Entities are not a resource like conversion workspace or mapping rule, and they can not be created, updated or deleted like one. Instead they are simple data objects describing the structure of the client database. + +Args: + conversionWorkspace: string, Required. Name of the conversion workspace resource whose DB entities are described in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required) + commitId: string, Request a specific commit id. If not specified, the entities from the latest commit are returned. + filter: string, Filter the returned entities based on AIP-160 standard + pageSize: integer, The maximum number of entities to return. The service may return fewer than this value. + pageToken: string, The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token. + tree: string, The tree to fetch + Allowed values + DB_TREE_TYPE_UNSPECIFIED - Unspecified tree type + SOURCE_TREE - The source database tree + DRAFT_TREE - The draft database tree + DESTINATION_TREE - The destination database tree + uncommitted: boolean, Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified. + 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 'DescribeDatabaseEntities' request. + "databaseEntities": [ # The list of database entities for the conversion workspace. + { # The base entity type for all the database related entities The message contains the entity name, the name of its parent, its type and the specific details per its type + "databaseFunction": { # Function's parent is a schema. # Function + "customFeatures": { # Custom engine specific features + "a_key": "", # Properties of the object. + }, + "sqlCode": "A String", # The SQL code which creates the function + }, + "databasePackage": { # Package's parent is a schema. # Package + "customFeatures": { # Custom engine specific features + "a_key": "", # Properties of the object. + }, + "packageBody": "A String", # The SQL code which creates the package body. If the package specification has cursors or subprograms, then the package body is mandatory. + "packageSqlCode": "A String", # The SQL code which creates the package + }, + "entityType": "A String", # The type of the database entity (table, view, index, ...). + "mappings": [ # Details about entity mappings. For source tree entities, this holds the draft entities which were generated by the mapping rules. For draft tree entities, this holds the source entities which were converted to form the draft entity. Destination entities will have no mapping details. + { # Details of the mappings of a database entity. + "draftEntity": "A String", # Target entity full name. The draft entity can also include a column, index or constraint using the same naming notation schema.table.column + "mappingLog": [ # Entity mapping log entries. Multiple rules can be effective and contribute changes to a converted entity such as, a rule can handle the entity name, another rule can handle an entity type. In addition, rules which did not change the entity are also logged along the with the reason preventing them to do so. + { # A single record of a rule which was used for a mapping. + "mappingComment": "A String", # Comment. + "ruleId": "A String", # Which rule caused it. + "ruleRevisionId": "A String", # Rule revision id + }, + ], + "sourceEntity": "A String", # Source entity full name. The source entity can also be a column, index or constraint using the same naming notation schema.table.column + }, + ], + "parentEntity": "A String", # The full name of the parent entity (e.g. schema name). + "schema": { # Schema typically has no parent entity, but can have a parent entity DatabaseInstance (for database engines which supports it). For some database engines the term schema and user can be used interchangeably when they refer to a namespace or a collection of other database entities. Can store additional information which is schema specific. # Schema. + "customFeatures": { # Custom engine specific features + "a_key": "", # Properties of the object. + }, + }, + "sequence": { # Sequence's parent is a schema. # Sequence + "cache": "A String", # Indicates number of entries to cache / precreate + "customFeatures": { # Custom engine specific features + "a_key": "", # Properties of the object. + }, + "cycle": True or False, # Indicates whether the sequence value should cycle through + "increment": "A String", # Increment value for the sequence + "maxValue": "A String", # Maximum number for the sequence represented as bytes to accommodate large numbers + "minValue": "A String", # Minimum number for the sequence represented as bytes to accommodate large numbers + "startValue": "A String", # Start number for the sequence represented as bytes to accommodate large numbers + }, + "shortName": "A String", # The short name (e.g. table name) of the entity. + "storedProcedure": { # Stored procedure's parent is a schema. # Stored Procedure + "customFeatures": { # Custom engine specific features + "a_key": "", # Properties of the object. + }, + "sqlCode": "A String", # The SQL code which creates the stored procedure + }, + "synonym": { # Synonym's parent is a schema. # Synonym + "customFeatures": { # Custom engine specific features + "a_key": "", # Properties of the object. + }, + "sourceEntity": "A String", # The name of the entity for which the synonym is being created (the source) + "sourceType": "A String", # The type of the entity for which the synonym is being created (usually a table or a sequence) + }, + "table": { # Table's parent is a schema. # Table. + "columns": [ # Table Columns. + { # Column is not used as an independent entity, it is retrieved as part of a Table entity. + "array": True or False, # Is the column of array type + "arrayLength": 42, # If the column is array, of which length + "autoGenerated": True or False, # Is the column auto-generated/identity + "charset": "A String", # Charset override - instead of table level charset + "collation": "A String", # Collation override - instead of table level collation + "comment": "A String", # Comment associated with the column + "customFeatures": { # Custom engine specific features + "a_key": "", # Properties of the object. + }, + "dataType": "A String", # Column data type + "defaultValue": "A String", # Default value of the column + "fractionalSecondsPrecision": 42, # Column fractional second precision - used for timestamp based datatypes + "length": "A String", # Column length - e.g. varchar (50) + "name": "A String", # Column name + "nullable": True or False, # Is the column nullable + "ordinalPosition": 42, # Column order in the table + "precision": 42, # Column precision - when relevant + "scale": 42, # Column scale - when relevant + "setValues": [ # Specifies the list of values allowed in the column. List is empty if set values is not required + "A String", + ], + "udt": True or False, # Is the column a UDT + }, + ], + "comment": "A String", # Comment associated with the table + "constraints": [ # Table Constraints. + { # Constraint is not used as an independent entity, it is retrieved as part of another entity such as Table or View. + "customFeatures": { # Custom engine specific features + "a_key": "", # Properties of the object. + }, + "name": "A String", # The name of the table constraint + "referenceColumns": [ # Reference Columns which may be associated with the constraint. eg: if the constraint is a FOREIGN_KEY, this represents the list of full names of referenced columns by the foreign key. + "A String", + ], + "referenceTable": "A String", # Reference table which may be associated with the constraint. eg: if the constraint is a FOREIGN_KEY, this represents the list of full name of the referenced table by the foreign key. + "tableColumns": [ # Table columns used as part of the Constraint for e.g. primary key constraint should list the columns which constitutes the key + "A String", + ], + "tableName": "A String", # Table which is associated with the constraint. In case the constraint is defined on a table, this field is left empty as this information is stored in parent_name. However, if constraint is defined on a view, this field stores the table name on which the view is defined. + "type": "A String", # Type of constraint - e.g. unique, primary key, foreign key (currently only primary key is supported) + }, + ], + "customFeatures": { # Custom engine specific features + "a_key": "", # Properties of the object. + }, + "indices": [ # Table Indices. + { # Index is not used as an independent entity, it is retrieved as part of a Table entity. + "customFeatures": { # Custom engine specific features + "a_key": "", # Properties of the object. + }, + "name": "A String", # The name of the index + "tableColumns": [ # Table columns used as part of the Index for e.g. B-TREE index should list the columns which constitutes the index. + "A String", + ], + "type": "A String", # Type of index - e.g. B-TREE + "unique": True or False, # boolean value indicating whether the index is unique + }, + ], + "triggers": [ # Table triggers. + { # Trigger is not used as an independent entity, it is retrieved as part of a Table entity. + "customFeatures": { # Custom engine specific features + "a_key": "", # Properties of the object. + }, + "name": "A String", # The name of the trigger + "sqlCode": "A String", # The SQL code which creates the trigger + "triggerType": "A String", # Indicates when the trigger fires, e.g. BEFORE STATEMENT, AFTER EACH ROW + "triggeringEvents": [ # The DML, DDL, or database events that fires the trigger, e.g. INSERT, UPDATE + "A String", + ], + }, + ], + }, + "tree": "A String", # The type of tree the entity belongs to. + "view": { # View's parent is a schema. # View + "constraints": [ # View Constraints. + { # Constraint is not used as an independent entity, it is retrieved as part of another entity such as Table or View. + "customFeatures": { # Custom engine specific features + "a_key": "", # Properties of the object. + }, + "name": "A String", # The name of the table constraint + "referenceColumns": [ # Reference Columns which may be associated with the constraint. eg: if the constraint is a FOREIGN_KEY, this represents the list of full names of referenced columns by the foreign key. + "A String", + ], + "referenceTable": "A String", # Reference table which may be associated with the constraint. eg: if the constraint is a FOREIGN_KEY, this represents the list of full name of the referenced table by the foreign key. + "tableColumns": [ # Table columns used as part of the Constraint for e.g. primary key constraint should list the columns which constitutes the key + "A String", + ], + "tableName": "A String", # Table which is associated with the constraint. In case the constraint is defined on a table, this field is left empty as this information is stored in parent_name. However, if constraint is defined on a view, this field stores the table name on which the view is defined. + "type": "A String", # Type of constraint - e.g. unique, primary key, foreign key (currently only primary key is supported) + }, + ], + "customFeatures": { # Custom engine specific features + "a_key": "", # Properties of the object. + }, + "sqlCode": "A String", # The SQL code which creates the view. + }, + }, + ], + "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. +}+++ +describeDatabaseEntities_next()+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. ++++ +get(name, x__xgafv=None)+Gets details of a single conversion workspace. + +Args: + name: string, Required. Name of the conversion workspace resource to get. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The main conversion workspace resource entity. + "createTime": "A String", # Output only. The timestamp when the workspace resource was created. + "destination": { # The type and version of a source or destination DB. # Required. The destination engine details. + "engine": "A String", # Required. Engine Type. + "version": "A String", # Required. Engine named version, for e.g. 12.c.1 + }, + "displayName": "A String", # The display name for the workspace + "globalSettings": { # A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true + "a_key": "A String", + }, + "hasUncommittedChanges": True or False, # Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed) + "latestCommitId": "A String", # Output only. The latest commit id + "latestCommitTime": "A String", # Output only. The timestamp when the workspace was committed. + "name": "A String", # Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. + "source": { # The type and version of a source or destination DB. # Required. The source engine details. + "engine": "A String", # Required. Engine Type. + "version": "A String", # Required. Engine named version, for e.g. 12.c.1 + }, + "updateTime": "A String", # Output only. The timestamp when the workspace resource was last updated. +}+++ +list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)+Lists conversion workspaces in a given project and location. + +Args: + parent: string, Required. The parent, which owns this collection of conversion workspaces. (required) + filter: string, A filter expression that filters conversion workspaces listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list conversion workspaces created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z.** You can also filter nested fields. For example, you could specify **source.version = "12.c.1"** to select all conversion workspaces with source database version equal to 12.c.1 + pageSize: integer, The maximum number of conversion workspaces to return. The service may return fewer than this value. If unspecified, at most 50 sets will be returned. + pageToken: string, The nextPageToken value received in the previous call to conversionWorkspaces.list, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspaces.list must match the call that provided the page token. + 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 'ListConversionWorkspaces' request. + "conversionWorkspaces": [ # The list of conversion workspace objects. + { # The main conversion workspace resource entity. + "createTime": "A String", # Output only. The timestamp when the workspace resource was created. + "destination": { # The type and version of a source or destination DB. # Required. The destination engine details. + "engine": "A String", # Required. Engine Type. + "version": "A String", # Required. Engine named version, for e.g. 12.c.1 + }, + "displayName": "A String", # The display name for the workspace + "globalSettings": { # A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true + "a_key": "A String", + }, + "hasUncommittedChanges": True or False, # Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed) + "latestCommitId": "A String", # Output only. The latest commit id + "latestCommitTime": "A String", # Output only. The timestamp when the workspace was committed. + "name": "A String", # Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. + "source": { # The type and version of a source or destination DB. # Required. The source engine details. + "engine": "A String", # Required. Engine Type. + "version": "A String", # Required. Engine named version, for e.g. 12.c.1 + }, + "updateTime": "A String", # Output only. The timestamp when the workspace resource was last updated. + }, + ], + "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "unreachable": [ # Locations that could not be reached. + "A String", + ], +}+++ +list_next()+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. ++++ +patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)+Updates the parameters of a single conversion workspace. + +Args: + name: string, Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required) + body: object, The request body. + The object takes the form of: + +{ # The main conversion workspace resource entity. + "createTime": "A String", # Output only. The timestamp when the workspace resource was created. + "destination": { # The type and version of a source or destination DB. # Required. The destination engine details. + "engine": "A String", # Required. Engine Type. + "version": "A String", # Required. Engine named version, for e.g. 12.c.1 + }, + "displayName": "A String", # The display name for the workspace + "globalSettings": { # A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true + "a_key": "A String", + }, + "hasUncommittedChanges": True or False, # Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed) + "latestCommitId": "A String", # Output only. The latest commit id + "latestCommitTime": "A String", # Output only. The timestamp when the workspace was committed. + "name": "A String", # Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. + "source": { # The type and version of a source or destination DB. # Required. The source engine details. + "engine": "A String", # Required. Engine Type. + "version": "A String", # Required. Engine named version, for e.g. 12.c.1 + }, + "updateTime": "A String", # Output only. The timestamp when the workspace resource was last updated. +} + + requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the conversion workspace resource by the update. + 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. + "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. + "error": { # 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). # The error result of the operation in case of failure or cancellation. + "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. + }, + ], + "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. + }, + "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. + }, + "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}`. + "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. + }, +}+++ +rollback(name, body=None, x__xgafv=None)+Rollbacks a conversion workspace to the last committed spanshot. + +Args: + name: string, Required. Name of the conversion workspace resource to rollback to. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for 'RollbackConversionWorkspace' request. +} + + 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. + "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. + "error": { # 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). # The error result of the operation in case of failure or cancellation. + "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. + }, + ], + "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. + }, + "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. + }, + "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}`. + "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. + }, +}+++ +searchBackgroundJobs(conversionWorkspace, completedUntilTime=None, maxSize=None, returnMostRecentPerJobType=None, x__xgafv=None)+Use this method to search/list the background jobs for a specific conversion workspace. The background jobs are not a resource like conversion workspace or mapping rule, and they can not be created, updated or deleted like one. Instead they are a way to expose the data plane jobs log. + +Args: + conversionWorkspace: string, Required. Name of the conversion workspace resource whos jobs are listed. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required) + completedUntilTime: string, Optional. If supplied, will only return jobs that completed until (not including) the given timestamp. + maxSize: integer, Optional. The maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 100 jobs will be returned. The maximum value is 100; values above 100 will be coerced to 100. + returnMostRecentPerJobType: boolean, Optional. Whether or not to return just the most recent job per job type + 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 'SearchBackgroundJobs' request. + "jobs": [ # The list of conversion workspace mapping rules. + { # Execution log of a background job. + "completionComment": "A String", # Job completion comment, such as how many entities were seeded, how many warnings were found during conversion and similar information. + "completionState": "A String", # Job completion state, i.e. the final state after the job completed. + "finishTime": "A String", # The timestamp when the background job was finished. + "id": "A String", # The background job log entry id + "importRulesJobDetails": { # Details regarding an Import Rules background job # Import rules job details + "fileFormat": "A String", # The requested file format + "files": [ # File names used for the import rules job + "A String", + ], + }, + "jobType": "A String", # The type of job that was executed. + "requestAutocommit": True or False, # Whether the client requested the conversion workspace to be committed after a successful completion of the job. + "seedJobDetails": { # Details regarding a Seed background job # Seed job details + "connectionProfile": "A String", # The connection profile which was used for the seed job + }, + "startTime": "A String", # The timestamp when the background job was started. + }, + ], +}+++ + \ No newline at end of file diff --git a/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.mappingRules.html b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.mappingRules.html new file mode 100644 index 00000000000..cd2b6bbbfa9 --- /dev/null +++ b/docs/dyn/datamigration_v1.projects.locations.conversionWorkspaces.mappingRules.html @@ -0,0 +1,138 @@ + + + +seed(name, body=None, x__xgafv=None)+Imports a snapshot of the source database into the conversion workspace. + +Args: + name: string, Name of the conversion workspace resource to seed with new database structure. in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for 'SeedConversionWorkspace' request. + "autoCommit": True or False, # Should the conversion workspace be committed automatically after the seed operation. + "destinationConnectionProfile": "A String", # Fully qualified (Uri) name of the destination connection profile. + "sourceConnectionProfile": "A String", # Fully qualified (Uri) name of the source connection profile. +} + + 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. + "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. + "error": { # 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). # The error result of the operation in case of failure or cancellation. + "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. + }, + ], + "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. + }, + "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. + }, + "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}`. + "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. + }, +}+Database Migration API . projects . locations . conversionWorkspaces . mappingRules
+Instance Methods
++
+close()Close httplib2 connections.
++
+import_(parent, body=None, x__xgafv=None)Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.
+Method Details
+++ +close()+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/docs/dyn/datamigration_v1.projects.locations.html b/docs/dyn/datamigration_v1.projects.locations.html index 0090ff55123..b8784b63bca 100644 --- a/docs/dyn/datamigration_v1.projects.locations.html +++ b/docs/dyn/datamigration_v1.projects.locations.html @@ -79,6 +79,11 @@import_(parent, body=None, x__xgafv=None)+Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files. + +Args: + parent: string, Required. Name of the conversion workspace resource to import the rules to in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for 'ImportMappingRules' request. + "autoCommit": True or False, # Should the conversion workspace be committed automatically after the import operation. + "rulesFiles": [ # One or more rules files + { # Details of a single rules file + "rulesContent": "A String", # The text content of the rules that needs to be converted + "rulesSourceFilename": "A String", # The filename of the rules that needs to be converted. This is used mainly so future logs of the import rules job will contain this detail and can therefore be searched by it later + }, + ], + "rulesFormat": "A String", # The format of the rules content file. +} + + 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. + "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. + "error": { # 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). # The error result of the operation in case of failure or cancellation. + "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. + }, + ], + "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. + }, + "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. + }, + "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}`. + "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. + }, +}+Instance Methods
Returns the connectionProfiles Resource.
+ +Returns the conversionWorkspaces Resource.
+ @@ -89,6 +94,11 @@Instance Methods
Returns the operations Resource.
+ +Returns the privateConnections Resource.
+Close httplib2 connections.
diff --git a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html index f046fe69d6d..cff4f328961 100644 --- a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html +++ b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html @@ -141,6 +141,10 @@Method Details
The object takes the form of: { # Represents a Database Migration Service migration job object. + "conversionWorkspace": { # A conversion workspace's version. # The conversion workspace used by the migration. + "commitId": "A String", # The commit ID of the conversion workspace. + "name": "A String", # The resource name (URI) of the conversion workspace. + }, "createTime": "A String", # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". "destination": "A String", # Required. The resource name (URI) of the destination connection profile. "destinationDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the destination. @@ -168,6 +172,7 @@Method Details
], "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. }, + "filter": "A String", # This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace. "labels": { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. "a_key": "A String", }, @@ -312,6 +317,10 @@Method Details
An object of the form: { # Represents a Database Migration Service migration job object. + "conversionWorkspace": { # A conversion workspace's version. # The conversion workspace used by the migration. + "commitId": "A String", # The commit ID of the conversion workspace. + "name": "A String", # The resource name (URI) of the conversion workspace. + }, "createTime": "A String", # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". "destination": "A String", # Required. The resource name (URI) of the destination connection profile. "destinationDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the destination. @@ -339,6 +348,7 @@Method Details
], "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. }, + "filter": "A String", # This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace. "labels": { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. "a_key": "A String", }, @@ -435,6 +445,10 @@Method Details
{ # Response message for 'ListMigrationJobs' request. "migrationJobs": [ # The list of migration jobs objects. { # Represents a Database Migration Service migration job object. + "conversionWorkspace": { # A conversion workspace's version. # The conversion workspace used by the migration. + "commitId": "A String", # The commit ID of the conversion workspace. + "name": "A String", # The resource name (URI) of the conversion workspace. + }, "createTime": "A String", # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". "destination": "A String", # Required. The resource name (URI) of the destination connection profile. "destinationDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the destination. @@ -462,6 +476,7 @@Method Details
], "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. }, + "filter": "A String", # This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace. "labels": { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. "a_key": "A String", }, @@ -519,6 +534,10 @@Method Details
The object takes the form of: { # Represents a Database Migration Service migration job object. + "conversionWorkspace": { # A conversion workspace's version. # The conversion workspace used by the migration. + "commitId": "A String", # The commit ID of the conversion workspace. + "name": "A String", # The resource name (URI) of the conversion workspace. + }, "createTime": "A String", # Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". "destination": "A String", # Required. The resource name (URI) of the destination connection profile. "destinationDatabase": { # A message defining the database engine and provider. # The database engine type and provider of the destination. @@ -546,6 +565,7 @@Method Details
], "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. }, + "filter": "A String", # This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace. "labels": { # The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. "a_key": "A String", }, diff --git a/docs/dyn/datamigration_v1.projects.locations.privateConnections.html b/docs/dyn/datamigration_v1.projects.locations.privateConnections.html new file mode 100644 index 00000000000..b7cdd9dc560 --- /dev/null +++ b/docs/dyn/datamigration_v1.projects.locations.privateConnections.html @@ -0,0 +1,305 @@ + + + +Database Migration API . projects . locations . privateConnections
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, body=None, privateConnectionId=None, requestId=None, x__xgafv=None)Creates a new private connection in a given project and location.
++
+delete(name, requestId=None, x__xgafv=None)Deletes a single Database Migration Service private connection.
+ +Gets details of a single private connection.
++
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)Retrieves a list of private connections in a given project and location.
+ +Retrieves the next page of results.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, body=None, privateConnectionId=None, requestId=None, x__xgafv=None)+Creates a new private connection in a given project and location. + +Args: + parent: string, Required. The parent that owns the collection of PrivateConnections. (required) + body: object, The request body. + The object takes the form of: + +{ # The PrivateConnection resource is used to establish private connectivity with the customer's network. + "createTime": "A String", # Output only. The create time of the resource. + "displayName": "A String", # The private connection display name. + "error": { # 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). # Output only. The error details in case of state FAILED. + "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. + }, + ], + "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. + }, + "labels": { # The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. + "a_key": "A String", + }, + "name": "A String", # The resource's name. + "state": "A String", # Output only. The state of the Private Connection. + "updateTime": "A String", # Output only. The last update time of the resource. + "vpcPeeringConfig": { # The VPC Peering configuration is used to create VPC peering with the consumer's VPC. # VPC Peering Config. + "subnet": "A String", # Required. A free subnet for peering. (CIDR of /29) + "vpcName": "A String", # Required. Fully qualified name of the VPC DMS will peer to. + }, +} + + privateConnectionId: string, Required. The private connection identifier. + requestId: string, Optional. A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + 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. + "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. + "error": { # 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). # The error result of the operation in case of failure or cancellation. + "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. + }, + ], + "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. + }, + "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. + }, + "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}`. + "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. + }, +}+++ +delete(name, requestId=None, x__xgafv=None)+Deletes a single Database Migration Service private connection. + +Args: + name: string, Required. The name of the private connection to delete. (required) + requestId: string, Optional. A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + 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. + "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. + "error": { # 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). # The error result of the operation in case of failure or cancellation. + "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. + }, + ], + "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. + }, + "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. + }, + "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}`. + "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. + }, +}+++ +get(name, x__xgafv=None)+Gets details of a single private connection. + +Args: + name: string, Required. The name of the private connection to get. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The PrivateConnection resource is used to establish private connectivity with the customer's network. + "createTime": "A String", # Output only. The create time of the resource. + "displayName": "A String", # The private connection display name. + "error": { # 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). # Output only. The error details in case of state FAILED. + "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. + }, + ], + "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. + }, + "labels": { # The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. + "a_key": "A String", + }, + "name": "A String", # The resource's name. + "state": "A String", # Output only. The state of the Private Connection. + "updateTime": "A String", # Output only. The last update time of the resource. + "vpcPeeringConfig": { # The VPC Peering configuration is used to create VPC peering with the consumer's VPC. # VPC Peering Config. + "subnet": "A String", # Required. A free subnet for peering. (CIDR of /29) + "vpcName": "A String", # Required. Fully qualified name of the VPC DMS will peer to. + }, +}+++ +list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)+Retrieves a list of private connections in a given project and location. + +Args: + parent: string, Required. The parent that owns the collection of private connections. (required) + filter: string, A filter expression that filters private connections listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list private connections created this year by specifying **createTime %gt; 2021-01-01T00:00:00.000000000Z**. + orderBy: string, Order by fields for the result. + pageSize: integer, Maximum number of private connections to return. If unspecified, at most 50 private connections that will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + pageToken: string, Page token received from a previous `ListPrivateConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrivateConnections` must match the call that provided the page token. + 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 'ListPrivateConnections' request. + "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "privateConnections": [ # List of private connections. + { # The PrivateConnection resource is used to establish private connectivity with the customer's network. + "createTime": "A String", # Output only. The create time of the resource. + "displayName": "A String", # The private connection display name. + "error": { # 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). # Output only. The error details in case of state FAILED. + "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. + }, + ], + "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. + }, + "labels": { # The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. + "a_key": "A String", + }, + "name": "A String", # The resource's name. + "state": "A String", # Output only. The state of the Private Connection. + "updateTime": "A String", # Output only. The last update time of the resource. + "vpcPeeringConfig": { # The VPC Peering configuration is used to create VPC peering with the consumer's VPC. # VPC Peering Config. + "subnet": "A String", # Required. A free subnet for peering. (CIDR of /29) + "vpcName": "A String", # Required. Fully qualified name of the VPC DMS will peer to. + }, + }, + ], + "unreachable": [ # Locations that could not be reached. + "A String", + ], +}+++ + \ No newline at end of file diff --git a/docs/dyn/datapipelines_v1.projects.locations.html b/docs/dyn/datapipelines_v1.projects.locations.html index 9a58a46b75d..17fdcfc63c9 100644 --- a/docs/dyn/datapipelines_v1.projects.locations.html +++ b/docs/dyn/datapipelines_v1.projects.locations.html @@ -79,17 +79,9 @@list_next()+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. ++Instance Methods
Returns the pipelines Resource.
- -Returns the transformDescriptions Resource.
-Close httplib2 connections.
--
-computeSchema(location, body=None, x__xgafv=None)Computes the schema for the transform. Computation from `raw_schema` will always occur if it is set. This requires that the transform supports that encoding. If no raw schema is provided and if the transform is for an IO, then this will attempt to connect to the resource using the details provided in `config` and infer the schema from that. If the transform is not an IO, is a sink that doesn't exist yet, or is a sink with no schema requirement, then this will fall back to basing the schema off the one provided in `input_schemas`. The computed schema will be validated.
listPipelines(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it.
@@ -102,183 +94,6 @@Method Details
Close httplib2 connections.
computeSchema(location, body=None, x__xgafv=None)
- Computes the schema for the transform. Computation from `raw_schema` will always occur if it is set. This requires that the transform supports that encoding. If no raw schema is provided and if the transform is for an IO, then this will attempt to connect to the resource using the details provided in `config` and infer the schema from that. If the transform is not an IO, is a sink that doesn't exist yet, or is a sink with no schema requirement, then this will fall back to basing the schema off the one provided in `input_schemas`. The computed schema will be validated.
-
-Args:
- location: string, Required. The full location formatted as "projects/{your-project}/locations/{google-cloud-region}". If attempting to infer the schema from an existing Google Cloud resource, the default Data Pipelines service account for this project will be used in making requests for the resource. If the region given for "{google-cloud-region}" is different than the region where the resource is stored, then the data will be transferred to and processed in the region specified here, but it will not be persistently stored in this region. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Request message for ComputeSchema
- "config": { # A fully configured transform that can be validated. # Required. The configuration for the transform. If this is not a source, then each input with its schema must be set. It is not required to have any outputs set.
- "config": { # Represents an Apache Beam row, though the `Any` nature of values is replaced with more concrete representations of valid values. # Configuration values provided. These must match the schema provided in the row's schema.
- "schema": { # Holds a schema or a reference to a schema in some repository. # Required. The schema of the row's data.
- "localSchema": { # Represents a simplified Apache Beam schema. # Schema located locally with the message.
- "fields": [ # Fields in the schema. Every field within a schema must have a unique name.
- { # Info for a single field in the schema.
- "name": "A String", # Name of the field.
- "type": { # Type info about a field. # Type info for the field.
- "collectionElementType": # Object with schema name: GoogleCloudDatapipelinesV1FieldType # If `type` is an array or iterable, this is the type contained in that array or iterable.
- "logicalType": { # Represents the input for creating a specified logical type. # If `type` is a logical type, this is the info for the specific logical type.
- "enumerationType": { # Represents the Beam EnumerationType logical type. # The enum represented by this logical type.
- "values": [ # Names of the values. The numeric value is the same as the index.
- "A String",
- ],
- },
- "fixedBytes": { # Represents the Beam FixedBytes logical type. # The fixed-size byte collection represented by this logical type.
- "sizeBytes": 42, # Number of bytes to allocate.
- },
- },
- "mapType": { # Represents a map in a schema. # If `type` is a map, this is the key and value types for that map.
- "mapKeyType": # Object with schema name: GoogleCloudDatapipelinesV1FieldType # Key type of the map. Only atomic types are supported.
- "mapValueType": # Object with schema name: GoogleCloudDatapipelinesV1FieldType # Value type of the map.
- },
- "nullable": True or False, # Whether or not this field is nullable.
- "rowSchema": # Object with schema name: GoogleCloudDatapipelinesV1Schema # If `type` is a row, this is the schema of that row.
- "type": "A String", # Specific type of the field. For non-atomic types, the corresponding type info for that non-atomic must be set.
- },
- },
- ],
- "referenceId": "A String", # An identifier of the schema for looking it up in a repository. This only needs to be set if the schema is stored in a repository.
- },
- "referenceId": "A String", # The `reference_id` value of a schema in a repository.
- },
- "values": [ # Required. The values of this Row. A fully built row is required to hold to the schema specified by `schema`.
- { # A single value in a row. The value set must correspond to the correct type from the row's schema.
- "arrayValue": { # Represents an array of values. The elements can be of any type. # The array value of this field. Corresponds to TYPE_NAME_ARRAY in the schema.
- "elements": [ # The elements of the array.
- # Object with schema name: GoogleCloudDatapipelinesV1FieldValue
- ],
- },
- "atomicValue": { # Represents a non-dividable value. # The atomic value of this field. Must correspond to the correct atomic type in the schema.
- "booleanValue": True or False, # A boolean value.
- "byteValue": 42, # An 8-bit signed value.
- "bytesValue": "A String", # An array of raw bytes.
- "datetimeValue": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # A datetime value.
- "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.
- "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time.
- "minutes": 42, # Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.
- "month": 42, # Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.
- "nanos": 42, # Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.
- "seconds": 42, # Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.
- "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Time zone.
- "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
- "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
- },
- "utcOffset": "A String", # UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.
- "year": 42, # Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.
- },
- "decimalValue": { # A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html # A large decimal value, equivalent to Java BigDecimal.
- "value": "A String", # The decimal value, as a string. The string representation consists of an optional sign, `+` (`U+002B`) or `-` (`U+002D`), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent. An empty string **should** be interpreted as `0`. The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand. The exponent consists of the character `e` (`U+0065`) or `E` (`U+0045`) followed by one or more decimal digits. Services **should** normalize decimal values before storing them by: - Removing an explicitly-provided `+` sign (`+2.5` -> `2.5`). - Replacing a zero-length integer value with `0` (`.5` -> `0.5`). - Coercing the exponent character to upper-case, with explicit sign (`2.5e8` -> `2.5E+8`). - Removing an explicitly-provided zero exponent (`2.5E0` -> `2.5`). Services **may** perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: `2.5E-1` <-> `0.25`). Additionally, services **may** preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so. Note that only the `.` character is supported to divide the integer and the fraction; `,` **should not** be supported regardless of locale. Additionally, thousand separators **should not** be supported. If a service does support them, values **must** be normalized. The ENBF grammar is: DecimalString = '' | [Sign] Significand [Exponent]; Sign = '+' | '-'; Significand = Digits '.' | [Digits] '.' Digits; Exponent = ('e' | 'E') [Sign] Digits; Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' }; Services **should** clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values. Services **may** choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and **should** round the value to fit the supported scale. Alternatively, the service **may** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if precision would be lost. Services **should** error with `400 Bad Request` (`INVALID_ARGUMENT` in gRPC) if the service receives a value outside of the supported range.
- },
- "doubleValue": 3.14, # A 64-bit floating point value.
- "floatValue": 3.14, # A 32-bit floating point value.
- "int16Value": 42, # A 16-bit signed value.
- "int32Value": 42, # A 32-bit signed value.
- "int64Value": "A String", # A 64-bit signed value.
- "stringValue": "A String", # A string value.
- },
- "enumValue": { # Represents a selected value from an EnumerationType. # The enum value of this field. Corresponds to TYPE_NAME_LOGICAL_TYPE in the schema if that logical type represents an `EnumerationType` type.
- "name": "A String", # Name of the enum option.
- },
- "fixedBytesValue": { # Represents a collection of bytes whose size is the same as the associated FixedBytes size value. # The fixed-length byte collection of this field. Corresponds to TYPE_NAME_LOGICAL_TYPE in the schema if that logical type represents a `FixedBytes` type.
- "value": "A String", # The raw bytes. It must be exactly the size specified in the schema.
- },
- "iterableValue": { # Represents an iterable of values. The elements can be of any type. # The iterable value of this field. Corresponds to TYPE_NAME_ITERABLE in the schema.
- "elements": [ # The elements of the iterable.
- # Object with schema name: GoogleCloudDatapipelinesV1FieldValue
- ],
- },
- "mapValue": { # Represents a key/value pairing. # The map value of this field. Corresponds to TYPE_NAME_MAP in the schema.
- "entries": [ # The entries in the map.
- { # A single entry in the map. Each entry must have a unique key.
- "key": # Object with schema name: GoogleCloudDatapipelinesV1FieldValue # The key value. Only atomic values are supported.
- "value": # Object with schema name: GoogleCloudDatapipelinesV1FieldValue # The value associated with the key. It may be of any type.
- },
- ],
- },
- "rowValue": # Object with schema name: GoogleCloudDatapipelinesV1Row # The row value of this field. Corresponds to TYPE_NAME_ROW in the schema. This row also holds to its own schema.
- },
- ],
- },
- "uniformResourceName": "A String", # Unique resource name of the transform. This should be the same as the equivalent `TransformDescription` value.
- },
- "inputSchemas": [ # Optional. In relation to the full pipeline graph, the schemas of the transforms that are used as inputs to the one for `config`. If `config` represents a transform for reading from some resource, then this should be empty. For all other transforms, at least one value must be provided.
- { # Represents a simplified Apache Beam schema.
- "fields": [ # Fields in the schema. Every field within a schema must have a unique name.
- { # Info for a single field in the schema.
- "name": "A String", # Name of the field.
- "type": { # Type info about a field. # Type info for the field.
- "collectionElementType": # Object with schema name: GoogleCloudDatapipelinesV1FieldType # If `type` is an array or iterable, this is the type contained in that array or iterable.
- "logicalType": { # Represents the input for creating a specified logical type. # If `type` is a logical type, this is the info for the specific logical type.
- "enumerationType": { # Represents the Beam EnumerationType logical type. # The enum represented by this logical type.
- "values": [ # Names of the values. The numeric value is the same as the index.
- "A String",
- ],
- },
- "fixedBytes": { # Represents the Beam FixedBytes logical type. # The fixed-size byte collection represented by this logical type.
- "sizeBytes": 42, # Number of bytes to allocate.
- },
- },
- "mapType": { # Represents a map in a schema. # If `type` is a map, this is the key and value types for that map.
- "mapKeyType": # Object with schema name: GoogleCloudDatapipelinesV1FieldType # Key type of the map. Only atomic types are supported.
- "mapValueType": # Object with schema name: GoogleCloudDatapipelinesV1FieldType # Value type of the map.
- },
- "nullable": True or False, # Whether or not this field is nullable.
- "rowSchema": # Object with schema name: GoogleCloudDatapipelinesV1Schema # If `type` is a row, this is the schema of that row.
- "type": "A String", # Specific type of the field. For non-atomic types, the corresponding type info for that non-atomic must be set.
- },
- },
- ],
- "referenceId": "A String", # An identifier of the schema for looking it up in a repository. This only needs to be set if the schema is stored in a repository.
- },
- ],
- "rawSchema": { # The raw schema and its type. # Optional. If set, this will use the provided raw schema to compute the schema rather than connecting to any resources. Validation will still occur to make sure it is compatible with all input schemas. If the transform is an IO, the IO must support that schema type.
- "rawSchema": "A String", # The schema.
- "type": "A String", # The type of the schema.
- },
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # Represents a simplified Apache Beam schema.
- "fields": [ # Fields in the schema. Every field within a schema must have a unique name.
- { # Info for a single field in the schema.
- "name": "A String", # Name of the field.
- "type": { # Type info about a field. # Type info for the field.
- "collectionElementType": # Object with schema name: GoogleCloudDatapipelinesV1FieldType # If `type` is an array or iterable, this is the type contained in that array or iterable.
- "logicalType": { # Represents the input for creating a specified logical type. # If `type` is a logical type, this is the info for the specific logical type.
- "enumerationType": { # Represents the Beam EnumerationType logical type. # The enum represented by this logical type.
- "values": [ # Names of the values. The numeric value is the same as the index.
- "A String",
- ],
- },
- "fixedBytes": { # Represents the Beam FixedBytes logical type. # The fixed-size byte collection represented by this logical type.
- "sizeBytes": 42, # Number of bytes to allocate.
- },
- },
- "mapType": { # Represents a map in a schema. # If `type` is a map, this is the key and value types for that map.
- "mapKeyType": # Object with schema name: GoogleCloudDatapipelinesV1FieldType # Key type of the map. Only atomic types are supported.
- "mapValueType": # Object with schema name: GoogleCloudDatapipelinesV1FieldType # Value type of the map.
- },
- "nullable": True or False, # Whether or not this field is nullable.
- "rowSchema": # Object with schema name: GoogleCloudDatapipelinesV1Schema # If `type` is a row, this is the schema of that row.
- "type": "A String", # Specific type of the field. For non-atomic types, the corresponding type info for that non-atomic must be set.
- },
- },
- ],
- "referenceId": "A String", # An identifier of the schema for looking it up in a repository. This only needs to be set if the schema is stored in a repository.
-}
-listPipelines(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists pipelines. Returns a "FORBIDDEN" error if the caller doesn't have permission to access it. diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.tasks.html b/docs/dyn/dataplex_v1.projects.locations.lakes.tasks.html index d858990a945..a425eff84cb 100644 --- a/docs/dyn/dataplex_v1.projects.locations.lakes.tasks.html +++ b/docs/dyn/dataplex_v1.projects.locations.lakes.tasks.html @@ -103,6 +103,9 @@Instance Methods
patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None)Update the task resource.
++
+run(name, body=None, x__xgafv=None)Run an on demand execution of a Task.
setIamPolicy(resource, body=None, x__xgafv=None)Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
@@ -794,6 +797,41 @@Method Details
}
run(name, body=None, x__xgafv=None)
+ Run an on demand execution of a Task.
+
+Args:
+ name: string, Required. The resource name of the task: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "job": { # A job represents an instance of a task. # Jobs created by RunTask API.
+ "endTime": "A String", # Output only. The time when the job ended.
+ "message": "A String", # Output only. Additional information about the current state.
+ "name": "A String", # Output only. The relative resource name of the job, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/tasks/{task_id}/jobs/{job_id}.
+ "retryCount": 42, # Output only. The number of times the job has been retried (excluding the initial attempt).
+ "service": "A String", # Output only. The underlying service running a job.
+ "serviceJob": "A String", # Output only. The full resource name for the job run under a particular service.
+ "startTime": "A String", # Output only. The time when the job was started.
+ "state": "A String", # Output only. Execution state for the job.
+ "uid": "A String", # Output only. System generated globally unique ID for the job.
+ },
+}
+setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.zones.assets.html b/docs/dyn/dataplex_v1.projects.locations.lakes.zones.assets.html index b89043a9a8f..6c9fb055247 100644 --- a/docs/dyn/dataplex_v1.projects.locations.lakes.zones.assets.html +++ b/docs/dyn/dataplex_v1.projects.locations.lakes.zones.assets.html @@ -167,6 +167,7 @@Method Details
"name": "A String", # Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. "resourceSpec": { # Identifies the cloud resource that is referenced by this asset. # Required. Specification of the resource that is referenced by this asset. "name": "A String", # Immutable. Relative name of the cloud resource that contains the data that is being managed within a lake. For example: projects/{project_number}/buckets/{bucket_id} projects/{project_number}/datasets/{dataset_id} + "readAccessMode": "A String", # Optional. Determines how read permissions are handled for each asset and their associated tables. Only available to storage buckets assets. "type": "A String", # Required. Immutable. Type of resource. }, "resourceStatus": { # Status of the resource referenced by an asset. # Output only. Status of the resource referenced by this asset. @@ -307,6 +308,7 @@Method Details
"name": "A String", # Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. "resourceSpec": { # Identifies the cloud resource that is referenced by this asset. # Required. Specification of the resource that is referenced by this asset. "name": "A String", # Immutable. Relative name of the cloud resource that contains the data that is being managed within a lake. For example: projects/{project_number}/buckets/{bucket_id} projects/{project_number}/datasets/{dataset_id} + "readAccessMode": "A String", # Optional. Determines how read permissions are handled for each asset and their associated tables. Only available to storage buckets assets. "type": "A String", # Required. Immutable. Type of resource. }, "resourceStatus": { # Status of the resource referenced by an asset. # Output only. Status of the resource referenced by this asset. @@ -436,6 +438,7 @@Method Details
"name": "A String", # Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. "resourceSpec": { # Identifies the cloud resource that is referenced by this asset. # Required. Specification of the resource that is referenced by this asset. "name": "A String", # Immutable. Relative name of the cloud resource that contains the data that is being managed within a lake. For example: projects/{project_number}/buckets/{bucket_id} projects/{project_number}/datasets/{dataset_id} + "readAccessMode": "A String", # Optional. Determines how read permissions are handled for each asset and their associated tables. Only available to storage buckets assets. "type": "A String", # Required. Immutable. Type of resource. }, "resourceStatus": { # Status of the resource referenced by an asset. # Output only. Status of the resource referenced by this asset. @@ -523,6 +526,7 @@Method Details
"name": "A String", # Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. "resourceSpec": { # Identifies the cloud resource that is referenced by this asset. # Required. Specification of the resource that is referenced by this asset. "name": "A String", # Immutable. Relative name of the cloud resource that contains the data that is being managed within a lake. For example: projects/{project_number}/buckets/{bucket_id} projects/{project_number}/datasets/{dataset_id} + "readAccessMode": "A String", # Optional. Determines how read permissions are handled for each asset and their associated tables. Only available to storage buckets assets. "type": "A String", # Required. Immutable. Type of resource. }, "resourceStatus": { # Status of the resource referenced by an asset. # Output only. Status of the resource referenced by this asset. diff --git a/docs/dyn/dataplex_v1.projects.locations.lakes.zones.entities.html b/docs/dyn/dataplex_v1.projects.locations.lakes.zones.entities.html index 079dccee6ab..59d59088a61 100644 --- a/docs/dyn/dataplex_v1.projects.locations.lakes.zones.entities.html +++ b/docs/dyn/dataplex_v1.projects.locations.lakes.zones.entities.html @@ -116,6 +116,9 @@Method Details
The object takes the form of: { # Represents tables and fileset metadata contained within a zone. + "access": { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable. + "read": "A String", # Output only. Describes the read access mechanism of the data. Not user settable. + }, "asset": "A String", # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset. "catalogEntry": "A String", # Output only. The name of the associated Data Catalog entry. "compatibility": { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with. @@ -189,6 +192,9 @@Method Details
An object of the form: { # Represents tables and fileset metadata contained within a zone. + "access": { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable. + "read": "A String", # Output only. Describes the read access mechanism of the data. Not user settable. + }, "asset": "A String", # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset. "catalogEntry": "A String", # Output only. The name of the associated Data Catalog entry. "compatibility": { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with. @@ -293,6 +299,9 @@Method Details
An object of the form: { # Represents tables and fileset metadata contained within a zone. + "access": { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable. + "read": "A String", # Output only. Describes the read access mechanism of the data. Not user settable. + }, "asset": "A String", # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset. "catalogEntry": "A String", # Output only. The name of the associated Data Catalog entry. "compatibility": { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with. @@ -382,6 +391,9 @@Method Details
{ # List metadata entities response. "entities": [ # Entities in the specified parent zone. { # Represents tables and fileset metadata contained within a zone. + "access": { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable. + "read": "A String", # Output only. Describes the read access mechanism of the data. Not user settable. + }, "asset": "A String", # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset. "catalogEntry": "A String", # Output only. The name of the associated Data Catalog entry. "compatibility": { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with. @@ -473,6 +485,9 @@Method Details
The object takes the form of: { # Represents tables and fileset metadata contained within a zone. + "access": { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable. + "read": "A String", # Output only. Describes the read access mechanism of the data. Not user settable. + }, "asset": "A String", # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset. "catalogEntry": "A String", # Output only. The name of the associated Data Catalog entry. "compatibility": { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with. @@ -546,6 +561,9 @@Method Details
An object of the form: { # Represents tables and fileset metadata contained within a zone. + "access": { # Describes the access mechanism of the data within its storage location. # Output only. Identifies the access mechanism to the entity. Not user settable. + "read": "A String", # Output only. Describes the read access mechanism of the data. Not user settable. + }, "asset": "A String", # Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset. "catalogEntry": "A String", # Output only. The name of the associated Data Catalog entry. "compatibility": { # Provides compatibility information for various metadata stores. # Output only. Metadata stores that the entity is compatible with. diff --git a/docs/dyn/dataproc_v1.projects.regions.clusters.nodeGroups.html b/docs/dyn/dataproc_v1.projects.regions.clusters.nodeGroups.html index 14760bee204..607f6844a6e 100644 --- a/docs/dyn/dataproc_v1.projects.regions.clusters.nodeGroups.html +++ b/docs/dyn/dataproc_v1.projects.regions.clusters.nodeGroups.html @@ -77,6 +77,9 @@Instance Methods
Close httplib2 connections.
++
+create(parent, body=None, nodeGroupId=None, requestId=None, x__xgafv=None)Creates a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).
Gets the resource representation for a node group in a cluster.
@@ -89,6 +92,91 @@Method Details
Close httplib2 connections.
create(parent, body=None, nodeGroupId=None, requestId=None, x__xgafv=None)
+ Creates a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).
+
+Args:
+ parent: string, Required. The parent resource where this node group will be created. Format: projects/{project}/regions/{region}/clusters/{cluster} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Dataproc Node Group. The Dataproc NodeGroup resource is not related to the Dataproc NodeGroupAffinity resource.
+ "labels": { # Optional. Node group labels. Label keys must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty. If specified, they must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). The node group must have no more than 32 labelsn.
+ "a_key": "A String",
+ },
+ "name": "A String", # The Node group resource name (https://aip.dev/122).
+ "nodeGroupConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The node group instance group configuration.
+ "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
+ { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
+ "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
+ "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples: https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
+ },
+ ],
+ "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
+ "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
+ "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-balanced" (Persistent Disk Balanced Solid State Drive), "pd-ssd" (Persistent Disk Solid State Drive), or "pd-standard" (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types).
+ "localSsdInterface": "A String", # Optional. Interface type of local SSDs (default is "scsi"). Valid values: "scsi" (Small Computer System Interface), "nvme" (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance).
+ "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 8 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.Note: Local SSD options may vary by machine type and number of vCPUs selected.
+ },
+ "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. Dataproc will use the most recent image from the family: https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
+ "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
+ "A String",
+ ],
+ "instanceReferences": [ # Output only. List of references to Compute Engine instances.
+ { # A reference to a Compute Engine instance.
+ "instanceId": "A String", # The unique identifier of the Compute Engine instance.
+ "instanceName": "A String", # The user-friendly name of the Compute Engine instance.
+ "publicEciesKey": "A String", # The public ECIES key used for sharing data with this instance.
+ "publicKey": "A String", # The public RSA key used for sharing data with this instance.
+ },
+ ],
+ "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
+ "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
+ "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
+ "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
+ "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
+ },
+ "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
+ "numInstances": 42, # Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1.
+ "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
+ },
+ "roles": [ # Required. Node group roles.
+ "A String",
+ ],
+}
+
+ nodeGroupId: string, Optional. An optional node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters.
+ requestId: string, Optional. A unique ID used to identify the request. If the server receives two CreateNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateNodeGroupRequests) with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
+ 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.
+ "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.
+ "error": { # 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). # The error result of the operation in case of failure or cancellation.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "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.
+ },
+ "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}.
+ "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.
+ },
+}
+get(name, x__xgafv=None)
Gets the resource representation for a node group in a cluster. diff --git a/docs/dyn/datastore_v1.projects.html b/docs/dyn/datastore_v1.projects.html index 3e68e4340a8..036218534e1 100644 --- a/docs/dyn/datastore_v1.projects.html +++ b/docs/dyn/datastore_v1.projects.html @@ -259,41 +259,7 @@Method Details
], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "update": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # The entity to update. The entity must already exist. Must have a complete key path. @@ -312,41 +278,7 @@Method Details
], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The update time of the entity that this mutation is being applied to. If this does not match the current update time on the server, the mutation conflicts. @@ -366,41 +298,7 @@Method Details
], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, }, @@ -627,41 +525,7 @@Method Details
], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set. @@ -687,41 +551,7 @@Method Details
], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set. @@ -846,7 +676,25 @@Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -914,7 +762,25 @@Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -954,7 +820,25 @@Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1018,7 +902,25 @@Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1087,7 +989,25 @@Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1168,7 +1088,25 @@Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1208,7 +1146,25 @@Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1271,7 +1227,25 @@Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. @@ -1361,41 +1335,7 @@Method Details
], }, "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. - "a_key": { # A message that can hold any of the supported value types and associated metadata. - "arrayValue": { # An array value. # An array value. Cannot contain another array value. A `Value` instance that sets field `array_value` must not set fields `meaning` or `exclude_from_indexes`. - "values": [ # Values in the array. The order of values in an array is preserved as long as all values have identical settings for 'exclude_from_indexes'. - # Object with schema name: Value - ], - }, - "blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. - "booleanValue": True or False, # A boolean value. - "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. - "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. - "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. - "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. - "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0]. - }, - "integerValue": "A String", # An integer value. - "keyValue": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # A key value. - "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. - "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. - "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. - "projectId": "A String", # The ID of the project to which the entities belong. - }, - "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. - { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. - "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. - "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. - }, - ], - }, - "meaning": 42, # The `meaning` field should only be populated for backwards compatibility. - "nullValue": "A String", # A null value. - "stringValue": "A String", # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes. - "timestampValue": "A String", # A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down. - }, + "a_key": # Object with schema name: Value }, }, "updateTime": "A String", # The time at which the entity was last changed. This field is set for `FULL` entity results. If this entity is missing, this field will not be set. @@ -1436,7 +1376,25 @@Method Details
"blobValue": "A String", # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. "booleanValue": True or False, # A boolean value. "doubleValue": 3.14, # A double value. - "entityValue": # Object with schema name: Entity # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "entityValue": { # A Datastore data object. An entity is limited to 1 megabyte when stored. That _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this message. # An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read-only key. + "key": { # A unique identifier for an entity. If a key's partition ID or any of its path kinds or names are reserved/read-only, the key is reserved/read-only. A reserved/read-only key is forbidden in certain documented contexts. # The entity's key. An entity must have a key, unless otherwise documented (for example, an entity in `Value.entity_value` may have no key). An entity's kind is its key path's last element's kind, or null if it has no key. + "partitionId": { # A partition ID identifies a grouping of entities. The grouping is always by project and namespace, however the namespace ID may be empty. A partition ID contains several dimensions: project ID and namespace ID. Partition dimensions: - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match regex `[A-Za-z\d\.\-_]{1,100}` If the value of any dimension matches regex `__.*__`, the partition is reserved/read-only. A reserved/read-only partition ID is forbidden in certain documented contexts. Foreign partition IDs (in which the project ID does not match the context project ID ) are discouraged. Reads and writes of foreign partition IDs may fail if the project is not in an active state. # Entities are partitioned into subsets, currently identified by a project ID and namespace ID. Queries are scoped to a single partition. + "databaseId": "A String", # If not empty, the ID of the database to which the entities belong. + "namespaceId": "A String", # If not empty, the ID of the namespace to which the entities belong. + "projectId": "A String", # The ID of the project to which the entities belong. + }, + "path": [ # The entity path. An entity path consists of one or more elements composed of a kind and a string or numerical identifier, which identify entities. The first element identifies a _root entity_, the second element identifies a _child_ of the root entity, the third element identifies a child of the second entity, and so forth. The entities identified by all prefixes of the path are called the element's _ancestors_. An entity path is always fully complete: *all* of the entity's ancestors are required to be in the path along with the entity identifier itself. The only exception is that in some documented cases, the identifier in the last path element (for the entity) itself may be omitted. For example, the last path element of the key of `Mutation.insert` may have no identifier. A path can never be empty, and a path can have at most 100 elements. + { # A (kind, ID/name) pair used to construct a key path. If either name or ID is set, the element is complete. If neither is set, the element is incomplete. + "id": "A String", # The auto-allocated ID of the entity. Never equal to zero. Values less than zero are discouraged and may not be supported in the future. + "kind": "A String", # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + "name": "A String", # The name of the entity. A name matching regex `__.*__` is reserved/read-only. A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are encoded as `__bytes__` where `` is the base-64 encoding of the bytes. + }, + ], + }, + "properties": { # The entity's properties. The map's keys are property names. A property name matching regex `__.*__` is reserved. A reserved property name is forbidden in certain documented contexts. The name must not contain more than 500 characters. The name cannot be `""`. + "a_key": # Object with schema name: Value + }, + }, "excludeFromIndexes": True or False, # If the value should be excluded from all indexes including those defined explicitly. "geoPointValue": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # A geo point value representing a point on the surface of Earth. "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0]. diff --git a/docs/dyn/datastream_v1.projects.locations.privateConnections.html b/docs/dyn/datastream_v1.projects.locations.privateConnections.html index 502418dd6a1..5320d35e919 100644 --- a/docs/dyn/datastream_v1.projects.locations.privateConnections.html +++ b/docs/dyn/datastream_v1.projects.locations.privateConnections.html @@ -83,7 +83,7 @@Instance Methods
close()Close httplib2 connections.
-
+create(parent, body=None, privateConnectionId=None, requestId=None, x__xgafv=None)create(parent, body=None, force=None, privateConnectionId=None, requestId=None, x__xgafv=None)Use this method to create a private connectivity configuration.
@@ -104,7 +104,7 @@
delete(name, force=None, requestId=None, x__xgafv=None)Method Details
create(parent, body=None, privateConnectionId=None, requestId=None, x__xgafv=None)
+ create(parent, body=None, force=None, privateConnectionId=None, requestId=None, x__xgafv=None)
Use this method to create a private connectivity configuration. Args: @@ -136,6 +136,7 @@Method Details
}, } + force: boolean, Optional. If set to true, will skip validations. privateConnectionId: string, Required. The private connectivity identifier. requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. diff --git a/docs/dyn/datastream_v1.projects.locations.streams.html b/docs/dyn/datastream_v1.projects.locations.streams.html index 48f8b069b3a..3c0cb511227 100644 --- a/docs/dyn/datastream_v1.projects.locations.streams.html +++ b/docs/dyn/datastream_v1.projects.locations.streams.html @@ -198,7 +198,7 @@Method Details
"bigqueryDestinationConfig": { # BigQuery destination configuration. "dataFreshness": "A String", # The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost. "singleTargetDataset": { # A single target dataset to which all data will be streamed. # Single destination dataset. - "datasetId": "A String", + "datasetId": "A String", # The dataset ID of the target dataset. }, "sourceHierarchyDatasets": { # Destination datasets are created so that hierarchy of the destination data objects matches the source hierarchy. # Source hierarchy datasets. "datasetTemplate": { # Dataset template used for dynamic dataset creation. @@ -568,7 +568,7 @@Method Details
"bigqueryDestinationConfig": { # BigQuery destination configuration. "dataFreshness": "A String", # The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost. "singleTargetDataset": { # A single target dataset to which all data will be streamed. # Single destination dataset. - "datasetId": "A String", + "datasetId": "A String", # The dataset ID of the target dataset. }, "sourceHierarchyDatasets": { # Destination datasets are created so that hierarchy of the destination data objects matches the source hierarchy. # Source hierarchy datasets. "datasetTemplate": { # Dataset template used for dynamic dataset creation. @@ -877,7 +877,7 @@Method Details
"bigqueryDestinationConfig": { # BigQuery destination configuration. "dataFreshness": "A String", # The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost. "singleTargetDataset": { # A single target dataset to which all data will be streamed. # Single destination dataset. - "datasetId": "A String", + "datasetId": "A String", # The dataset ID of the target dataset. }, "sourceHierarchyDatasets": { # Destination datasets are created so that hierarchy of the destination data objects matches the source hierarchy. # Source hierarchy datasets. "datasetTemplate": { # Dataset template used for dynamic dataset creation. @@ -1193,7 +1193,7 @@Method Details
"bigqueryDestinationConfig": { # BigQuery destination configuration. "dataFreshness": "A String", # The guaranteed data freshness (in seconds) when querying tables created by the stream. Editing this field will only affect new tables created in the future, but existing tables will not be impacted. Lower values mean that queries will return fresher data, but may result in higher cost. "singleTargetDataset": { # A single target dataset to which all data will be streamed. # Single destination dataset. - "datasetId": "A String", + "datasetId": "A String", # The dataset ID of the target dataset. }, "sourceHierarchyDatasets": { # Destination datasets are created so that hierarchy of the destination data objects matches the source hierarchy. # Source hierarchy datasets. "datasetTemplate": { # Dataset template used for dynamic dataset creation. diff --git a/docs/dyn/firestore_v1.projects.databases.documents.html b/docs/dyn/firestore_v1.projects.databases.documents.html index b63abfbebc0..59b6a8ec429 100644 --- a/docs/dyn/firestore_v1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1.projects.databases.documents.html @@ -990,14 +990,14 @@Method Details
Args: parent: string, Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` (required) - collectionId: string, Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. (required) + collectionId: string, Optional. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. This is optional, and when not provided, Firestore will list documents from all collections under the provided `parent`. (required) mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) - orderBy: string, The order to sort results by. For example: `priority desc, name`. - pageSize: integer, The maximum number of documents to return. - pageToken: string, The `next_page_token` value returned from a previous List request, if any. - readTime: string, Reads documents as they were at the given time. This may not be older than 270 seconds. - showMissing: boolean, If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set. Requests with `show_missing` may not specify `where` or `order_by`. - transaction: string, Reads documents in a transaction. + orderBy: string, Optional. The optional ordering of the documents to return. For example: `priority desc, __name__ desc`. This mirrors the `ORDER BY` used in Firestore queries but in a string representation. When absent, documents are ordered based on `__name__ ASC`. + pageSize: integer, Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value. + pageToken: string, Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of `page_size`) must match the values set in the request that generated the page token. + readTime: string, Perform the read at the provided time. This may not be older than 270 seconds. + showMissing: boolean, If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. + transaction: string, Perform the read as part of an already active transaction. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1040,7 +1040,7 @@Method Details
"updateTime": "A String", # Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query. }, ], - "nextPageToken": "A String", # The next page token. + "nextPageToken": "A String", # A token to retrieve the next page of documents. If this field is omitted, there are no subsequent pages. }
create(parent, body=None, databaseId=None, x__xgafv=None)
Create a database.
+
+ delete(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None)
Deletes a database.
exportDocuments(name, body=None, x__xgafv=None)
Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import
@@ -165,6 +168,44 @@delete(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None)
+ Deletes a database.
+
+Args:
+ name: string, Required. A name of the form `projects/{project_id}/databases/{database_id}` (required)
+ allowMissing: boolean, If set to true and the Database is not found, the request will succeed but no action will be taken.
+ etag: string, The current etag of the Database. If an etag is provided and does not match the current etag of the database, deletion will be blocked and a FAILED_PRECONDITION error will be returned.
+ validateOnly: boolean, If set, validate the request and preview the response, but do not actually delete the database.
+ 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.
+ "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.
+ "error": { # 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). # The error result of the operation in case of failure or cancellation.
+ "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.
+ },
+ ],
+ "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.
+ },
+ "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.
+ },
+ "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}`.
+ "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.
+ },
+}
+exportDocuments(name, body=None, x__xgafv=None)
Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import @@ -178,9 +219,6 @@Method Details
"collectionIds": [ # Which collection ids to export. Unspecified means all collections. "A String", ], - "namespaceIds": [ # An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. - "A String", - ], "outputUriPrefix": "A String", # The output URI. Currently only supports Google Cloud Storage URIs of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time. } @@ -252,9 +290,6 @@Method Details
"A String", ], "inputUriPrefix": "A String", # Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix. - "namespaceIds": [ # An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. - "A String", - ], } x__xgafv: string, V1 error format. diff --git a/docs/dyn/firestore_v1beta1.projects.databases.documents.html b/docs/dyn/firestore_v1beta1.projects.databases.documents.html index 1ad60465739..b595ddaa386 100644 --- a/docs/dyn/firestore_v1beta1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1beta1.projects.databases.documents.html @@ -990,14 +990,14 @@Method Details
Args: parent: string, Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` (required) - collectionId: string, Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. (required) + collectionId: string, Optional. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. This is optional, and when not provided, Firestore will list documents from all collections under the provided `parent`. (required) mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) - orderBy: string, The order to sort results by. For example: `priority desc, name`. - pageSize: integer, The maximum number of documents to return. - pageToken: string, The `next_page_token` value returned from a previous List request, if any. - readTime: string, Reads documents as they were at the given time. This may not be older than 270 seconds. - showMissing: boolean, If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set. Requests with `show_missing` may not specify `where` or `order_by`. - transaction: string, Reads documents in a transaction. + orderBy: string, Optional. The optional ordering of the documents to return. For example: `priority desc, __name__ desc`. This mirrors the `ORDER BY` used in Firestore queries but in a string representation. When absent, documents are ordered based on `__name__ ASC`. + pageSize: integer, Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value. + pageToken: string, Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of `page_size`) must match the values set in the request that generated the page token. + readTime: string, Perform the read at the provided time. This may not be older than 270 seconds. + showMissing: boolean, If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`. + transaction: string, Perform the read as part of an already active transaction. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1040,7 +1040,7 @@Method Details
"updateTime": "A String", # Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query. }, ], - "nextPageToken": "A String", # The next page token. + "nextPageToken": "A String", # A token to retrieve the next page of documents. If this field is omitted, there are no subsequent pages. }
+ identities()
+
Returns the identities Resource.
+ +
+ keypairs()
+
Returns the keypairs Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
+ close()
Close httplib2 connections.
+
+ create(userId, body=None, x__xgafv=None)
Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+ delete(userId, cseEmailAddress, x__xgafv=None)
Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the CreateCseIdentity method to create another identity with the same configuration. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+ get(userId, cseEmailAddress, x__xgafv=None)
Retrieves a client-side encryption identity configuration. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+ list(userId, pageSize=None, pageToken=None, x__xgafv=None)
Lists the client-side encrypted identities for an authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+ +Retrieves the next page of results.
+
+ patch(userId, emailAddress, body=None, x__xgafv=None)
Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's [S/MIME certificate profiles](https://support.google.com/a/answer/7300887?hl=en). [Beta](https://workspace.google.com/terms/service-terms/index.html).
+close()
+ Close httplib2 connections.+
create(userId, body=None, x__xgafv=None)
+ Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+Args:
+ userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
+ "emailAddress": "A String", # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
+ "primaryKeyPairId": "A String", # If a key pair is associated, the identifier of the key pair, CseKeyPair.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
+ "emailAddress": "A String", # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
+ "primaryKeyPairId": "A String", # If a key pair is associated, the identifier of the key pair, CseKeyPair.
+}
+delete(userId, cseEmailAddress, x__xgafv=None)
+ Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the CreateCseIdentity method to create another identity with the same configuration. [Beta](https://workspace.google.com/terms/service-terms/index.html). + +Args: + userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required) + cseEmailAddress: string, The primary email address associated with the client-side encryption identity configuration that's removed. (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format ++
get(userId, cseEmailAddress, x__xgafv=None)
+ Retrieves a client-side encryption identity configuration. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+Args:
+ userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+ cseEmailAddress: string, The primary email address associated with the client-side encryption identity configuration that's retrieved. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
+ "emailAddress": "A String", # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
+ "primaryKeyPairId": "A String", # If a key pair is associated, the identifier of the key pair, CseKeyPair.
+}
+list(userId, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists the client-side encrypted identities for an authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+Args:
+ userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+ pageSize: integer, The number of identities to return. If not provided, the page size will default to 20 entries.
+ pageToken: string, Pagination token indicating which page of identities to return. If the token is not supplied, then the API will return the first page of results.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "cseIdentities": [ # One page of the list of CSE identities configured for the user.
+ { # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
+ "emailAddress": "A String", # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
+ "primaryKeyPairId": "A String", # If a key pair is associated, the identifier of the key pair, CseKeyPair.
+ },
+ ],
+ "nextPageToken": "A String", # Pagination token to be passed to a subsequent ListCseIdentities call in order to retrieve the next page of identities. If this value is not returned or is the empty string, then no further pages remain.
+}
+list_next()
+ 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. ++
patch(userId, emailAddress, body=None, x__xgafv=None)
+ Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's [S/MIME certificate profiles](https://support.google.com/a/answer/7300887?hl=en). [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+Args:
+ userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+ emailAddress: string, The email address of the client-side encryption identity to update. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
+ "emailAddress": "A String", # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
+ "primaryKeyPairId": "A String", # If a key pair is associated, the identifier of the key pair, CseKeyPair.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
+ "emailAddress": "A String", # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
+ "primaryKeyPairId": "A String", # If a key pair is associated, the identifier of the key pair, CseKeyPair.
+}
+
+ close()
Close httplib2 connections.
+
+ create(userId, body=None, x__xgafv=None)
Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+ disable(userId, keyPairId, body=None, x__xgafv=None)
Turns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the key pair. After 30 days, you can permanently delete the key pair by using the ObliterateCseKeyPair method. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+ enable(userId, keyPairId, body=None, x__xgafv=None)
Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+ get(userId, keyPairId, x__xgafv=None)
Retrieves an existing client-side encryption key pair. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+ list(userId, pageSize=None, pageToken=None, x__xgafv=None)
Lists client-side encryption key pairs for an authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+ +Retrieves the next page of results.
+
+ obliterate(userId, keyPairId, body=None, x__xgafv=None)
Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+close()
+ Close httplib2 connections.+
create(userId, body=None, x__xgafv=None)
+ Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+Args:
+ userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # [Beta](https://workspace.google.com/terms/service-terms/index.html). A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
+ "disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
+ "enablementState": "A String", # Output only. The current state of the key pair.
+ "keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
+ "pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
+ "pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
+ "privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
+ { # Metadata for a private key instance.
+ "kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
+ "kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
+ "kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
+ },
+ "privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
+ },
+ ],
+ "subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # [Beta](https://workspace.google.com/terms/service-terms/index.html). A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
+ "disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
+ "enablementState": "A String", # Output only. The current state of the key pair.
+ "keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
+ "pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
+ "pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
+ "privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
+ { # Metadata for a private key instance.
+ "kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
+ "kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
+ "kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
+ },
+ "privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
+ },
+ ],
+ "subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
+ "A String",
+ ],
+}
+disable(userId, keyPairId, body=None, x__xgafv=None)
+ Turns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the key pair. After 30 days, you can permanently delete the key pair by using the ObliterateCseKeyPair method. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+Args:
+ userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+ keyPairId: string, The identifier of the key pair to turn off. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Requests to turn off a client-side encryption key pair.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # [Beta](https://workspace.google.com/terms/service-terms/index.html). A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
+ "disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
+ "enablementState": "A String", # Output only. The current state of the key pair.
+ "keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
+ "pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
+ "pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
+ "privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
+ { # Metadata for a private key instance.
+ "kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
+ "kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
+ "kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
+ },
+ "privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
+ },
+ ],
+ "subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
+ "A String",
+ ],
+}
+enable(userId, keyPairId, body=None, x__xgafv=None)
+ Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+Args:
+ userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+ keyPairId: string, The identifier of the key pair to turn on. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Requests to turn on a client-side encryption key pair.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # [Beta](https://workspace.google.com/terms/service-terms/index.html). A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
+ "disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
+ "enablementState": "A String", # Output only. The current state of the key pair.
+ "keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
+ "pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
+ "pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
+ "privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
+ { # Metadata for a private key instance.
+ "kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
+ "kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
+ "kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
+ },
+ "privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
+ },
+ ],
+ "subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
+ "A String",
+ ],
+}
+get(userId, keyPairId, x__xgafv=None)
+ Retrieves an existing client-side encryption key pair. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+Args:
+ userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+ keyPairId: string, The identifier of the key pair to retrieve. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # [Beta](https://workspace.google.com/terms/service-terms/index.html). A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
+ "disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
+ "enablementState": "A String", # Output only. The current state of the key pair.
+ "keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
+ "pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
+ "pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
+ "privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
+ { # Metadata for a private key instance.
+ "kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
+ "kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
+ "kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
+ },
+ "privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
+ },
+ ],
+ "subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
+ "A String",
+ ],
+}
+list(userId, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists client-side encryption key pairs for an authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+Args:
+ userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+ pageSize: integer, The number of key pairs to return. If not provided, the page size will default to 20 entries.
+ pageToken: string, Pagination token indicating which page of key pairs to return. If the token is not supplied, then the API will return the first page of results.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ {
+ "cseKeyPairs": [ # One page of the list of CSE key pairs installed for the user.
+ { # [Beta](https://workspace.google.com/terms/service-terms/index.html). A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
+ "disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
+ "enablementState": "A String", # Output only. The current state of the key pair.
+ "keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
+ "pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
+ "pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
+ "privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
+ { # Metadata for a private key instance.
+ "kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
+ "kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
+ "kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
+ },
+ "privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
+ },
+ ],
+ "subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
+ "A String",
+ ],
+ },
+ ],
+ "nextPageToken": "A String", # Pagination token to be passed to a subsequent ListCseKeyPairs call in order to retrieve the next page of key pairs. If this value is not returned, then no further pages remain.
+}
+list_next()
+ 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. ++
obliterate(userId, keyPairId, body=None, x__xgafv=None)
+ Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+Args:
+ userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+ keyPairId: string, The identifier of the key pair to obliterate. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to obliterate a CSE key pair.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+
+ cse()
+
Returns the cse Resource.
+ diff --git a/docs/dyn/index.md b/docs/dyn/index.md index f2b78b44cf9..90d1c6e3d41 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -365,6 +365,10 @@ * [v1b3](http://googleapis.github.io/google-api-python-client/docs/dyn/dataflow_v1b3.html) +## dataform +* [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/dataform_v1beta1.html) + + ## datafusion * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/datafusion_v1.html) * [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/datafusion_v1beta1.html) @@ -658,6 +662,7 @@ ## integrations +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/integrations_v1.html) * [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/integrations_v1alpha.html) diff --git a/docs/dyn/integrations_v1.callback.html b/docs/dyn/integrations_v1.callback.html new file mode 100644 index 00000000000..9a1b5ffeb04 --- /dev/null +++ b/docs/dyn/integrations_v1.callback.html @@ -0,0 +1,117 @@ + + + +
+ close()
Close httplib2 connections.
+ +Receives the auth code and auth config id to combine that with the client id and secret to retrieve access tokens from the token endpoint. Returns either a success or error message when it's done.
+close()
+ Close httplib2 connections.+
generateToken(code=None, gcpProjectId=None, product=None, redirectUri=None, state=None, x__xgafv=None)
+ Receives the auth code and auth config id to combine that with the client id and secret to retrieve access tokens from the token endpoint. Returns either a success or error message when it's done.
+
+Args:
+ code: string, The auth code for the given request
+ gcpProjectId: string, The gcp project id of the request
+ product: string, Which product sends the request
+ Allowed values
+ UNSPECIFIED_PRODUCT -
+ IP -
+ APIGEE -
+ SECURITY -
+ redirectUri: string, Redirect uri of the auth code request
+ state: string, The auth config id for the given request
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Returns success or error message
+ "message": "A String", # The message that notifies the user if the request succeeded or not.
+}
+
+ close()
Close httplib2 connections.
+ +Enumerates the regions for which Connector Platform is provisioned.
+close()
+ Close httplib2 connections.+
enumerate(x__xgafv=None)
+ Enumerates the regions for which Connector Platform is provisioned.
+
+Args:
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response containing all provisioned regions for Connector Platform.
+ "regions": [ # All regions where Connector Platform is provisioned.
+ "A String",
+ ],
+}
+
+ callback()
+
Returns the callback Resource.
+ +
+ connectorPlatformRegions()
+
Returns the connectorPlatformRegions Resource.
+ +
+ projects()
+
Returns the projects Resource.
+ +
+ close()
Close httplib2 connections.
+ +Create a BatchHttpRequest object based on the discovery document.
+close()
+ Close httplib2 connections.+
new_batch_http_request()
+ Create a BatchHttpRequest object based on the discovery document. + + Args: + callback: callable, A callback to be called for each response, of the + form callback(id, response, exception). The first parameter is the + request id, and the second is the deserialized response object. The + third is an apiclient.errors.HttpError exception object if an HTTP + error occurred while processing the request, or None if no error + occurred. + + Returns: + A BatchHttpRequest object based on the discovery document. ++
+ locations()
+
Returns the locations Resource.
+ +
+ close()
Close httplib2 connections.
+
+ getClientmetadata(parent, x__xgafv=None)
Gets the metadata info for the requested client
+close()
+ Close httplib2 connections.+
getClientmetadata(parent, x__xgafv=None)
+ Gets the metadata info for the requested client
+
+Args:
+ parent: string, Required. Required: The ID of the GCP Project to be provisioned. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for the GetClientMetadata rpc
+ "properties": { # Metadata information for the given project # Required. Required: The client configuration that was requested
+ "ipEnablementState": "A String", # An enum value of what the enablement state is for the given project
+ "provisionedRegions": [ # A list of provisioned regions on the current project
+ "A String",
+ ],
+ },
+}
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates an Apps Script project.
+
+ link(parent, body=None, x__xgafv=None)
Links a existing Apps Script project.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates an Apps Script project.
+
+Args:
+ parent: string, Required. The project that the executed integration belongs to. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for CreateAppsScriptProject rpc call.
+ "appsScriptProject": "A String", # The name of the Apps Script project to be created.
+ "authConfigId": "A String", # The auth config id necessary to fetch the necessary credentials to create the project for external clients
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for CreateAppsScriptProject rpc call.
+ "projectId": "A String", # The created AppsScriptProject ID.
+}
+link(parent, body=None, x__xgafv=None)
+ Links a existing Apps Script project.
+
+Args:
+ parent: string, Required. The project that the executed integration belongs to. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for LinkAppsScriptProject rpc call.
+ "scriptId": "A String", # The id of the Apps Script project to be linked.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for LinkAppsScriptProject rpc call.
+ "scriptId": "A String", # The id of the linked Apps Script project.
+}
+
+ close()
Close httplib2 connections.
+ +Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.
+ +Deletes an auth config.
+ +Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
+ +Retrieves the next page of results.
+ +Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.
+close()
+ Close httplib2 connections.+
create(parent, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, x__xgafv=None)
+ Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.
+
+Args:
+ parent: string, Required. "projects/{project}/locations/{location}" format. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The AuthConfig resource use to hold channels and connection config data.
+ "certificateId": "A String", # Certificate id for client certificate
+ "createTime": "A String", # Output only. The timestamp when the auth config is created.
+ "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "credentialType": "A String", # Credential type of the encrypted credential.
+ "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+ "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+ "token": "A String", # The token for the auth type.
+ "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+ },
+ "credentialType": "A String", # Credential type associated with auth config.
+ "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+ "jwt": "A String", # The token calculated by the header, payload and signature.
+ "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+ "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+ "secret": "A String", # User's pre-shared secret to sign the token.
+ },
+ "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+ "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+ "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+ "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "clientId": "A String", # The client's id.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "password": "A String", # The user's password.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "username": "A String", # The user's username.
+ },
+ "oidcToken": { # OIDC Token # Google OIDC ID Token
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+ "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+ "token": "A String", # ID token obtained for the service account
+ "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+ },
+ "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+ },
+ "usernameAndPassword": { # Username and password pair. # Username and password credential
+ "password": "A String", # Password to be used
+ "username": "A String", # Username to be used
+ },
+ },
+ "description": "A String", # A description of the auth config.
+ "displayName": "A String", # The name of the auth config.
+ "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+ "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+ "A String",
+ ],
+ "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+ "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+ "reason": "A String", # The reason / details of the current status.
+ "state": "A String", # The status of the auth config.
+ "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+ "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+ "visibility": "A String", # The visibility of the auth config.
+}
+
+ clientCertificate_encryptedPrivateKey: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ clientCertificate_passphrase: string, 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ clientCertificate_sslCertificate: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The AuthConfig resource use to hold channels and connection config data.
+ "certificateId": "A String", # Certificate id for client certificate
+ "createTime": "A String", # Output only. The timestamp when the auth config is created.
+ "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "credentialType": "A String", # Credential type of the encrypted credential.
+ "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+ "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+ "token": "A String", # The token for the auth type.
+ "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+ },
+ "credentialType": "A String", # Credential type associated with auth config.
+ "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+ "jwt": "A String", # The token calculated by the header, payload and signature.
+ "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+ "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+ "secret": "A String", # User's pre-shared secret to sign the token.
+ },
+ "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+ "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+ "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+ "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "clientId": "A String", # The client's id.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "password": "A String", # The user's password.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "username": "A String", # The user's username.
+ },
+ "oidcToken": { # OIDC Token # Google OIDC ID Token
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+ "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+ "token": "A String", # ID token obtained for the service account
+ "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+ },
+ "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+ },
+ "usernameAndPassword": { # Username and password pair. # Username and password credential
+ "password": "A String", # Password to be used
+ "username": "A String", # Username to be used
+ },
+ },
+ "description": "A String", # A description of the auth config.
+ "displayName": "A String", # The name of the auth config.
+ "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+ "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+ "A String",
+ ],
+ "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+ "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+ "reason": "A String", # The reason / details of the current status.
+ "state": "A String", # The status of the auth config.
+ "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+ "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+ "visibility": "A String", # The visibility of the auth config.
+}
+delete(name, x__xgafv=None)
+ Deletes an auth config.
+
+Args:
+ name: string, Required. The name that is associated with the AuthConfig. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+get(name, x__xgafv=None)
+ Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.
+
+Args:
+ name: string, Required. The name that is associated with the AuthConfig. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The AuthConfig resource use to hold channels and connection config data.
+ "certificateId": "A String", # Certificate id for client certificate
+ "createTime": "A String", # Output only. The timestamp when the auth config is created.
+ "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "credentialType": "A String", # Credential type of the encrypted credential.
+ "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+ "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+ "token": "A String", # The token for the auth type.
+ "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+ },
+ "credentialType": "A String", # Credential type associated with auth config.
+ "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+ "jwt": "A String", # The token calculated by the header, payload and signature.
+ "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+ "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+ "secret": "A String", # User's pre-shared secret to sign the token.
+ },
+ "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+ "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+ "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+ "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "clientId": "A String", # The client's id.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "password": "A String", # The user's password.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "username": "A String", # The user's username.
+ },
+ "oidcToken": { # OIDC Token # Google OIDC ID Token
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+ "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+ "token": "A String", # ID token obtained for the service account
+ "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+ },
+ "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+ },
+ "usernameAndPassword": { # Username and password pair. # Username and password credential
+ "password": "A String", # Password to be used
+ "username": "A String", # Username to be used
+ },
+ },
+ "description": "A String", # A description of the auth config.
+ "displayName": "A String", # The name of the auth config.
+ "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+ "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+ "A String",
+ ],
+ "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+ "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+ "reason": "A String", # The reason / details of the current status.
+ "state": "A String", # The status of the auth config.
+ "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+ "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+ "visibility": "A String", # The visibility of the auth config.
+}
+list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
+ Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
+
+Args:
+ parent: string, Required. The client, which owns this collection of AuthConfigs. (required)
+ filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
+ pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
+ pageToken: string, The token returned in the previous response.
+ readMask: string, The mask which specifies fields that need to be returned in the AuthConfig's response.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response to list AuthConfigs.
+ "authConfigs": [ # The list of AuthConfigs retrieved.
+ { # The AuthConfig resource use to hold channels and connection config data.
+ "certificateId": "A String", # Certificate id for client certificate
+ "createTime": "A String", # Output only. The timestamp when the auth config is created.
+ "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "credentialType": "A String", # Credential type of the encrypted credential.
+ "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+ "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+ "token": "A String", # The token for the auth type.
+ "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+ },
+ "credentialType": "A String", # Credential type associated with auth config.
+ "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+ "jwt": "A String", # The token calculated by the header, payload and signature.
+ "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+ "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+ "secret": "A String", # User's pre-shared secret to sign the token.
+ },
+ "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+ "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+ "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+ "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "clientId": "A String", # The client's id.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "password": "A String", # The user's password.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "username": "A String", # The user's username.
+ },
+ "oidcToken": { # OIDC Token # Google OIDC ID Token
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+ "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+ "token": "A String", # ID token obtained for the service account
+ "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+ },
+ "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+ },
+ "usernameAndPassword": { # Username and password pair. # Username and password credential
+ "password": "A String", # Password to be used
+ "username": "A String", # Username to be used
+ },
+ },
+ "description": "A String", # A description of the auth config.
+ "displayName": "A String", # The name of the auth config.
+ "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+ "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+ "A String",
+ ],
+ "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+ "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+ "reason": "A String", # The reason / details of the current status.
+ "state": "A String", # The status of the auth config.
+ "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+ "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+ "visibility": "A String", # The visibility of the auth config.
+ },
+ ],
+ "nextPageToken": "A String", # The token used to retrieve the next page of results.
+}
+list_next()
+ 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. ++
patch(name, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, updateMask=None, x__xgafv=None)
+ Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.
+
+Args:
+ name: string, Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The AuthConfig resource use to hold channels and connection config data.
+ "certificateId": "A String", # Certificate id for client certificate
+ "createTime": "A String", # Output only. The timestamp when the auth config is created.
+ "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "credentialType": "A String", # Credential type of the encrypted credential.
+ "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+ "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+ "token": "A String", # The token for the auth type.
+ "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+ },
+ "credentialType": "A String", # Credential type associated with auth config.
+ "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+ "jwt": "A String", # The token calculated by the header, payload and signature.
+ "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+ "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+ "secret": "A String", # User's pre-shared secret to sign the token.
+ },
+ "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+ "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+ "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+ "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "clientId": "A String", # The client's id.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "password": "A String", # The user's password.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "username": "A String", # The user's username.
+ },
+ "oidcToken": { # OIDC Token # Google OIDC ID Token
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+ "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+ "token": "A String", # ID token obtained for the service account
+ "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+ },
+ "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+ },
+ "usernameAndPassword": { # Username and password pair. # Username and password credential
+ "password": "A String", # Password to be used
+ "username": "A String", # Username to be used
+ },
+ },
+ "description": "A String", # A description of the auth config.
+ "displayName": "A String", # The name of the auth config.
+ "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+ "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+ "A String",
+ ],
+ "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+ "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+ "reason": "A String", # The reason / details of the current status.
+ "state": "A String", # The status of the auth config.
+ "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+ "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+ "visibility": "A String", # The visibility of the auth config.
+}
+
+ clientCertificate_encryptedPrivateKey: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ clientCertificate_passphrase: string, 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ clientCertificate_sslCertificate: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ updateMask: string, Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The AuthConfig resource use to hold channels and connection config data.
+ "certificateId": "A String", # Certificate id for client certificate
+ "createTime": "A String", # Output only. The timestamp when the auth config is created.
+ "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "credentialType": "A String", # Credential type of the encrypted credential.
+ "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+ "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+ "token": "A String", # The token for the auth type.
+ "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+ },
+ "credentialType": "A String", # Credential type associated with auth config.
+ "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+ "jwt": "A String", # The token calculated by the header, payload and signature.
+ "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+ "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+ "secret": "A String", # User's pre-shared secret to sign the token.
+ },
+ "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+ "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+ "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+ "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "clientId": "A String", # The client's id.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "password": "A String", # The user's password.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "username": "A String", # The user's username.
+ },
+ "oidcToken": { # OIDC Token # Google OIDC ID Token
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+ "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+ "token": "A String", # ID token obtained for the service account
+ "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+ },
+ "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+ },
+ "usernameAndPassword": { # Username and password pair. # Username and password credential
+ "password": "A String", # Password to be used
+ "username": "A String", # Username to be used
+ },
+ },
+ "description": "A String", # A description of the auth config.
+ "displayName": "A String", # The name of the auth config.
+ "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+ "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+ "A String",
+ ],
+ "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+ "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+ "reason": "A String", # The reason / details of the current status.
+ "state": "A String", # The status of the auth config.
+ "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+ "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+ "visibility": "A String", # The visibility of the auth config.
+}
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.
+ +Delete a certificate
+ +Get a certificates in the specified project.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
List all the certificates that match the filter. Restrict to certificate of current client only.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.
+
+Args:
+ parent: string, Required. "projects/{project}/locations/{location}" format. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The certificate definition
+ "certificateStatus": "A String", # Status of the certificate
+ "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+ "description": "A String", # Description of the certificate
+ "displayName": "A String", # Name of the certificate
+ "name": "A String", # Output only. Auto generated primary key
+ "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+ "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ },
+ "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+ "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+ "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The certificate definition
+ "certificateStatus": "A String", # Status of the certificate
+ "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+ "description": "A String", # Description of the certificate
+ "displayName": "A String", # Name of the certificate
+ "name": "A String", # Output only. Auto generated primary key
+ "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+ "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ },
+ "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+ "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+ "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+delete(name, x__xgafv=None)
+ Delete a certificate
+
+Args:
+ name: string, Required. The name that is associated with the Certificate. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+get(name, x__xgafv=None)
+ Get a certificates in the specified project.
+
+Args:
+ name: string, Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The certificate definition
+ "certificateStatus": "A String", # Status of the certificate
+ "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+ "description": "A String", # Description of the certificate
+ "displayName": "A String", # Name of the certificate
+ "name": "A String", # Output only. Auto generated primary key
+ "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+ "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ },
+ "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+ "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+ "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
+ List all the certificates that match the filter. Restrict to certificate of current client only.
+
+Args:
+ parent: string, Required. The client, which owns this collection of Certificates. (required)
+ filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
+ pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
+ pageToken: string, The token returned in the previous response.
+ readMask: string, The mask which specifies fields that need to be returned in the Certificate's response.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response to list Certificates.
+ "certificates": [ # The list of Certificates retrieved.
+ { # The certificate definition
+ "certificateStatus": "A String", # Status of the certificate
+ "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+ "description": "A String", # Description of the certificate
+ "displayName": "A String", # Name of the certificate
+ "name": "A String", # Output only. Auto generated primary key
+ "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+ "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ },
+ "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+ "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+ "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+ },
+ ],
+ "nextPageToken": "A String", # The token used to retrieve the next page of results.
+}
+list_next()
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.
+
+Args:
+ name: string, Output only. Auto generated primary key (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The certificate definition
+ "certificateStatus": "A String", # Status of the certificate
+ "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+ "description": "A String", # Description of the certificate
+ "displayName": "A String", # Name of the certificate
+ "name": "A String", # Output only. Auto generated primary key
+ "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+ "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ },
+ "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+ "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+ "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+
+ updateMask: string, Field mask specifying the fields in the above Certificate that have been modified and need to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The certificate definition
+ "certificateStatus": "A String", # Status of the certificate
+ "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+ "description": "A String", # Description of the certificate
+ "displayName": "A String", # Name of the certificate
+ "name": "A String", # Output only. Auto generated primary key
+ "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+ "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ },
+ "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+ "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+ "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+
+ close()
Close httplib2 connections.
+
+ deprovision(parent, body=None, x__xgafv=None)
Perform the deprovisioning steps to disable a user GCP project to use IP and purge all related data in a wipeout-compliant way.
+
+ provision(parent, body=None, x__xgafv=None)
Perform the provisioning steps to enable a user GCP project to use IP. If GCP project already registered on IP end via Apigee Integration, provisioning will fail.
+close()
+ Close httplib2 connections.+
deprovision(parent, body=None, x__xgafv=None)
+ Perform the deprovisioning steps to disable a user GCP project to use IP and purge all related data in a wipeout-compliant way.
+
+Args:
+ parent: string, Required. Required: The ID of the GCP Project to be deprovisioned. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for the Deprovision rpc
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+provision(parent, body=None, x__xgafv=None)
+ Perform the provisioning steps to enable a user GCP project to use IP. If GCP project already registered on IP end via Apigee Integration, provisioning will fail.
+
+Args:
+ parent: string, Required. Required: The ID of the GCP Project to be provisioned. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for the Provision rpc
+ "cloudKmsConfig": { # Configuration information for Client's Cloud KMS information # Required. Required: Cloud KMS config for AuthModule to encrypt/decrypt credentials.
+ "key": "A String", # Required. A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location.
+ "keyVersion": "A String", # Optional. Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data.
+ "kmsLocation": "A String", # Required. Location name of the key ring, e.g. "us-west1".
+ "kmsRing": "A String", # Required. A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location.
+ },
+ "createSampleWorkflows": True or False, # Optional. Indicates if sample workflow should be created along with provisioning
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates an cloud function project.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates an cloud function project.
+
+Args:
+ parent: string, Required. The project that the executed integration belongs to. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for Creating Cloud Function rpc call.
+ "functionName": "A String", # The function name of CF to be created
+ "functionRegion": "A String", # The function region of CF to be created
+ "projectId": "A String", # Indicates the id of the GCP project that the function will be created in.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for Creating Cloud Function rpc call.
+ "triggerUrl": "A String", # The trigger url that will be returned
+}
+Returns the runtimeActionSchemas Resource.
+ + +Returns the runtimeEntitySchemas Resource.
+ +
+ close()
Close httplib2 connections.
+
+ getConnectionSchemaMetadata(name, x__xgafv=None)
Lists the available entities and actions associated with a Connection.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Connections in a given project and location.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
getConnectionSchemaMetadata(name, x__xgafv=None)
+ Lists the available entities and actions associated with a Connection.
+
+Args:
+ name: string, Required. ConnectionSchemaMetadata name. Format: projects/{project}/locations/{location}/connections/{connection}/connectionSchemaMetadata (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Metadata of runtime connection schema.
+ "actions": [ # List of actions.
+ "A String",
+ ],
+ "entities": [ # List of entity names.
+ "A String",
+ ],
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists Connections in a given project and location.
+
+Args:
+ parent: string, Required. Parent resource of the Connection, of the form: `projects/*/locations/*` (required)
+ filter: string, Filter.
+ orderBy: string, Order by parameters.
+ pageSize: integer, Page size.
+ pageToken: string, Page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response containing Connections listed by region.
+ "connections": [ # Connections.
+ { # Connection represents an instance of connector.
+ "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
+ "additionalVariables": [ # List containing additional auth configs.
+ { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
+ "boolValue": True or False, # Value is a bool.
+ "intValue": "A String", # Value is an integer
+ "key": "A String", # Key of the config variable.
+ "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
+ "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ "stringValue": "A String", # Value is a string.
+ },
+ ],
+ "authType": "A String", # The type of authentication configured.
+ "oauth2ClientCredentials": { # Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. # Oauth2ClientCredentials.
+ "clientId": "A String", # The client identifier.
+ "clientSecret": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the client secret.
+ "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ },
+ "oauth2JwtBearer": { # Parameters to support JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication. See https://tools.ietf.org/html/rfc7523 for more details. # Oauth2JwtBearer.
+ "clientKey": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing a PKCS#8 PEM-encoded private key associated with the Client Certificate. This private key will be used to sign JWTs used for the jwt-bearer authorization grant. Specified in the form as: `projects/*/secrets/*/versions/*`.
+ "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ "jwtClaims": { # JWT claims used for the jwt-bearer authorization grant. # JwtClaims providers fields to generate the token.
+ "audience": "A String", # Value for the "aud" claim.
+ "issuer": "A String", # Value for the "iss" claim.
+ "subject": "A String", # Value for the "sub" claim.
+ },
+ },
+ "sshPublicKey": { # Parameters to support Ssh public key Authentication. # SSH Public Key.
+ "certType": "A String", # Format of SSH Client cert.
+ "sshClientCert": { # Secret provides a reference to entries in Secret Manager. # SSH Client Cert. It should contain both public and private key.
+ "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ "sshClientCertPass": { # Secret provides a reference to entries in Secret Manager. # Password (passphrase) for ssh client certificate if it has one.
+ "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ "username": "A String", # The user account used to authenticate.
+ },
+ "userPassword": { # Parameters to support Username and Password Authentication. # UserPassword.
+ "password": { # Secret provides a reference to entries in Secret Manager. # Secret version reference containing the password.
+ "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ "username": "A String", # Username.
+ },
+ },
+ "configVariables": [ # Optional. Configuration for configuring the connection with an external system.
+ { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
+ "boolValue": True or False, # Value is a bool.
+ "intValue": "A String", # Value is an integer
+ "key": "A String", # Key of the config variable.
+ "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
+ "secretVersion": "A String", # The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
+ },
+ "stringValue": "A String", # Value is a string.
+ },
+ ],
+ "connectorVersion": "A String", # Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource.
+ "createTime": "A String", # Output only. Created time.
+ "description": "A String", # Optional. Description of the resource.
+ "destinationConfigs": [ # Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
+ { # Define the Connectors target endpoint.
+ "destinations": [ # The destinations for the key.
+ {
+ "host": "A String", # For publicly routable host.
+ "port": 42, # The port is the target port number that is accepted by the destination.
+ "serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
+ },
+ ],
+ "key": "A String", # The key is the destination identifier that is supported by the Connector.
+ },
+ ],
+ "envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}
+ "imageLocation": "A String", # Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName}
+ "labels": { # Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
+ "a_key": "A String",
+ },
+ "lockConfig": { # Determines whether or no a connection is locked. If locked, a reason must be specified. # Optional. Configuration that indicates whether or not the Connection can be edited.
+ "locked": True or False, # Indicates whether or not the connection is locked.
+ "reason": "A String", # Describes why a connection is locked.
+ },
+ "name": "A String", # Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection}
+ "nodeConfig": { # Configuration for the connection. # Optional. Configuration for the connection.
+ "maxNodeCount": 42, # Maximum number of nodes in the runtime nodes.
+ "minNodeCount": 42, # Minimum number of nodes in the runtime nodes.
+ },
+ "serviceAccount": "A String", # Optional. Service account needed for runtime plane to access GCP resources.
+ "serviceDirectory": "A String", # Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors"
+ "status": { # ConnectionStatus indicates the state of the connection. # Output only. Current status of the connection.
+ "description": "A String", # Description.
+ "state": "A String", # State.
+ "status": "A String", # Status provides detailed information for the state.
+ },
+ "suspended": True or False, # Optional. Suspended indicates if a user has suspended a connection or not.
+ "updateTime": "A String", # Output only. Updated time.
+ },
+ ],
+ "nextPageToken": "A String", # Next page token.
+}
+list_next()
+ 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. ++
+ close()
Close httplib2 connections.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.
+
+Args:
+ parent: string, Required. Parent resource of RuntimeActionSchema. Format: projects/{project}/locations/{location}/connections/{connection} (required)
+ filter: string, Filter. Only the action field with literal equality operator is supported.
+ pageSize: integer, Page size.
+ pageToken: string, Page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for listing RuntimeActionSchemas for a specific Connection.
+ "nextPageToken": "A String", # Next page token.
+ "runtimeActionSchemas": [ # Runtime action schemas.
+ { # Metadata of an action, including schemas for its inputs and outputs.
+ "action": "A String", # Name of the action.
+ "inputSchema": "A String", # Input parameter schema for the action.
+ "outputSchema": "A String", # Output parameter schema for the action.
+ },
+ ],
+}
+list_next()
+ 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. ++
+ close()
Close httplib2 connections.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the JSON schemas for the properties of runtime entities, filtered by entity name.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists the JSON schemas for the properties of runtime entities, filtered by entity name.
+
+Args:
+ parent: string, Required. Parent resource of RuntimeEntitySchema. Format: projects/{project}/locations/{location}/connections/{connection} (required)
+ filter: string, Filter. Only the entity field with literal equality operator is supported.
+ pageSize: integer, Page size.
+ pageToken: string, Page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for listing RuntimeEntitySchemas for a specific Connection.
+ "nextPageToken": "A String", # Next page token.
+ "runtimeEntitySchemas": [ # Runtime entity schemas.
+ { # Metadata of an entity, including a schema for its properties.
+ "arrayFieldSchema": "A String", # The above schema, but for an array of the associated entity.
+ "entity": "A String", # Name of the entity.
+ "fieldSchema": "A String", # List of fields in the entity.
+ },
+ ],
+}
+list_next()
+ 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. ++
Returns the appsScriptProjects Resource.
+ +
+ authConfigs()
+
Returns the authConfigs Resource.
+ +
+ certificates()
+
Returns the certificates Resource.
+ +
+ clients()
+
Returns the clients Resource.
+ +
+ cloudFunctions()
+
Returns the cloudFunctions Resource.
+ +
+ connections()
+
Returns the connections Resource.
+ +
+ integrations()
+
Returns the integrations Resource.
+ +
+ products()
+
Returns the products Resource.
+ +
+ sfdcInstances()
+
Returns the sfdcInstances Resource.
+ +
+ close()
Close httplib2 connections.
+
+ getClients(parent, x__xgafv=None)
Gets the client configuration for the given project and location resource name
+
+ listTaskEntities(parent, x__xgafv=None)
This is a UI only method and will be moved away. Returns a list of common tasks.
+close()
+ Close httplib2 connections.+
getClients(parent, x__xgafv=None)
+ Gets the client configuration for the given project and location resource name
+
+Args:
+ parent: string, Required. Required: The ID of the GCP Project to be provisioned. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for the GetClient rpc
+ "client": { # The configuration information for the Client # Required. Required: The client configuration that was requested
+ "billingType": "A String", # Indicates the billing type of the client
+ "clientState": "A String", # Indicates the activity state the client
+ "cloudKmsConfig": { # Configuration information for Client's Cloud KMS information # Cloud KMS config for Auth Module to encrypt/decrypt credentials.
+ "key": "A String", # Required. A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location.
+ "keyVersion": "A String", # Optional. Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data.
+ "kmsLocation": "A String", # Required. Location name of the key ring, e.g. "us-west1".
+ "kmsRing": "A String", # Required. A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location.
+ },
+ "cloudLoggingConfig": { # Config info for Cloud Logging # Determines the cloud logging configuration for the project
+ "bucket": "A String", # Cloud bucket name for the project.
+ "enableCloudLogging": True or False, # This field determines whether the logs should be sent to cloud logging api
+ },
+ "createTime": "A String", # The timestamp when the client was first created.
+ "description": "A String", # Description of what the client is used for
+ "id": "A String", # Globally unique ID (project_id + region)
+ "p4ServiceAccount": "A String", # The P4SA account associated with this client
+ "projectId": "A String", # The GCP project id of the client associated with
+ "region": "A String", # The region the client is linked to.
+ },
+}
+listTaskEntities(parent, x__xgafv=None)
+ This is a UI only method and will be moved away. Returns a list of common tasks.
+
+Args:
+ parent: string, Required. The location resource of the request. This is not going to be used but preserve the field for future. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This is a UI only method and will be moved away. Response for ListTaskEntities.
+ "taskEntities": [ # The list of the tasks.
+ { # Contains a task's metadata and associated information. Next available id: 7
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ ],
+}
+
+ suspensions()
+
Returns the suspensions Resource.
+ +
+ close()
Close httplib2 connections.
+
+ download(name, x__xgafv=None)
Download the execution.
+ +Get an execution in the specified project.
+ +Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
download(name, x__xgafv=None)
+ Download the execution.
+
+Args:
+ name: string, Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for downloading an execution.
+ "content": "A String", # The content of downloaded execution.
+}
+get(name, x__xgafv=None)
+ Get an execution in the specified project.
+
+Args:
+ name: string, Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The Execution resource contains detailed information of an individual integration execution.
+ "createTime": "A String", # Output only. Created time of the execution.
+ "directSubExecutions": [ # Direct sub executions of the following Execution.
+ # Object with schema name: GoogleCloudIntegrationsV1alphaExecution
+ ],
+ "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10 # The execution info about this event.
+ "eventAttemptStats": [
+ {
+ "endTime": "A String", # The end time of the event execution for current attempt.
+ "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "eventExecutionSnapshot": [
+ { # Contains the snapshot of the event execution for a given checkpoint. Next available id: 13
+ "checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
+ "conditionResults": [ # All of the computed conditions that been calculated.
+ { # Contains the combined condition calculation results.
+ "currentTaskNumber": "A String", # the current task number.
+ "nextTaskNumber": "A String", # the next task number.
+ "result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
+ },
+ ],
+ "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
+ "eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
+ "eventExecutionSnapshotMetadata": {
+ "eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
+ "taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
+ "taskName": "A String", # the task name associated with this snapshot. Could be empty.
+ "taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
+ },
+ "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "exceedMaxSize": True or False, # indicate whether snapshot exceeded maximum size before clean up
+ "snapshotTime": "A String", # Indicates when this snapshot is taken.
+ "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+ { # Contains the details of the execution of this task. Next available id: 11
+ "taskAttemptStats": [
+ {
+ "endTime": "A String", # The end time of the task execution for current attempt.
+ "startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "taskExecutionState": "A String",
+ "taskNumber": "A String", # Pointer to the task config it used for execution.
+ },
+ ],
+ "taskName": "A String", # The task name associated with this snapshot. Could be empty.
+ },
+ ],
+ "eventExecutionState": "A String",
+ "eventRetriesFromBeginningCount": 42, # Indicates the number of times the execution has restarted from the beginning.
+ "logFilePath": "A String", # The log file path (aka. cns address) for this event.
+ "networkAddress": "A String", # The network address (aka. bns address) that indicates where the event executor is running.
+ "nextExecutionTime": "A String", # Next scheduled execution time in case the execution status was RETRY_ON_HOLD.
+ "ryeLockUnheldCount": 42, # Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/
+ },
+ "executionDetails": { # Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics. # Detailed info of this execution.
+ "attemptStats": [ # List of Start and end time of the execution attempts.
+ { # Status for the execution attempt.
+ "endTime": "A String", # The end time of the event execution for current attempt.
+ "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "executionSnapshots": [ # List of snapshots taken during the execution.
+ { # Contains the snapshot of the execution for a given checkpoint.
+ "checkpointTaskNumber": "A String", # Indicates "after which checkpoint task's execution" this snapshot is taken.
+ "executionSnapshotMetadata": { # Metadata of the execution snapshot. # Metadata of the execution snapshot.
+ "executionAttempt": 42, # the execution attempt number this snapshot belongs to.
+ "task": "A String", # the task name associated with this snapshot.
+ "taskAttempt": 42, # the task attempt number this snapshot belongs to.
+ "taskNumber": "A String", # The task number associated with this snapshot.
+ },
+ "params": { # Parameters used during the execution.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+ { # Contains the details of the execution of this task.
+ "taskAttemptStats": [ # Status for the current task execution attempt.
+ { # Status for the execution attempt.
+ "endTime": "A String", # The end time of the event execution for current attempt.
+ "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "taskExecutionState": "A String", # The execution state of this task.
+ "taskNumber": "A String", # Pointer to the task config it used for execution.
+ },
+ ],
+ },
+ ],
+ "state": "A String", # Status of the execution.
+ },
+ "executionMethod": "A String", # The ways user posts this event.
+ "name": "A String", # Auto-generated primary key.
+ "requestParameters": { # Event parameters come in as part of the request.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "requestParams": [ # Event parameters come in as part of the request.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ "responseParameters": { # Event parameters returned as part of the response.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "responseParams": [ # Event parameters come out as part of the response.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ "triggerId": "A String", # The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
+ "updateTime": "A String", # Output only. Last modified time of the execution.
+}
+list(parent, filter=None, filterParams_customFilter=None, filterParams_endTime=None, filterParams_eventStatuses=None, filterParams_executionId=None, filterParams_parameterKey=None, filterParams_parameterPairKey=None, filterParams_parameterPairValue=None, filterParams_parameterType=None, filterParams_parameterValue=None, filterParams_startTime=None, filterParams_taskStatuses=None, filterParams_workflowName=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, refreshAcl=None, truncateParams=None, x__xgafv=None)
+ Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.
+
+Args:
+ parent: string, Required. The parent resource name of the integration execution. (required)
+ filter: string, Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: "parameter_value" HAS \"parameter1\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND event_execution_state=\"FAILED\"
+ filterParams_customFilter: string, Optional user-provided custom filter.
+ filterParams_endTime: string, End timestamp.
+ filterParams_eventStatuses: string, List of possible event statuses. (repeated)
+ filterParams_executionId: string, Execution id.
+ filterParams_parameterKey: string, Param key. DEPRECATED. User parameter_pair_key instead.
+ filterParams_parameterPairKey: string, Param key in the key value pair filter.
+ filterParams_parameterPairValue: string, Param value in the key value pair filter.
+ filterParams_parameterType: string, Param type.
+ filterParams_parameterValue: string, Param value. DEPRECATED. User parameter_pair_value instead.
+ filterParams_startTime: string, Start timestamp.
+ filterParams_taskStatuses: string, List of possible task statuses. (repeated)
+ filterParams_workflowName: string, Workflow name.
+ orderBy: string, Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".
+ pageSize: integer, Optional. The size of entries in the response.
+ pageToken: string, Optional. The token returned in the previous response.
+ readMask: string, Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.
+ refreshAcl: boolean, Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.
+ truncateParams: boolean, Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for listing the integration execution data.
+ "executionInfos": [ # Required. The detailed information of requested executions.
+ { # Contains all the execution details for a workflow instance. Next available id: 24
+ "clientId": "A String", # The event data user sends as request.
+ "createTime": "A String", # Auto-generated.
+ "errorCode": { # Registered ids for errors, as "oneof" enums. Each task or logical grouping of tasks may share the same enum. # Final error-code if event failed.
+ "commonErrorCode": "A String",
+ },
+ "errors": [ # Errors, warnings, and informationals associated with the workflow/task. The order in which the errors were added by the workflow/task is maintained.
+ { # An error, warning, or information message associated with a workflow.
+ "errorCode": { # Registered ids for errors, as "oneof" enums. Each task or logical grouping of tasks may share the same enum. # The associated error-code, which can be a common or internal code.
+ "commonErrorCode": "A String",
+ },
+ "errorMessage": "A String", # The full text of the error message, including any parameters that were thrown along with the exception.
+ "severity": "A String", # The severity of the error: ERROR|WARN|INFO.
+ "taskNumber": 42, # The task try-number, in which, the error occurred. If zero, the error happened at the event level.
+ },
+ ],
+ "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10 # The execution info about this event.
+ "eventAttemptStats": [
+ {
+ "endTime": "A String", # The end time of the event execution for current attempt.
+ "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "eventExecutionSnapshot": [ # After snapshot migration, this field will no longer be populated, but old execution snapshots will still be accessible.
+ {
+ "checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
+ "conditionResults": [ # All of the computed conditions that been calculated.
+ { # Contains the combined condition calculation results.
+ "currentTaskNumber": "A String", # the current task number.
+ "nextTaskNumber": "A String", # the next task number.
+ "result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
+ },
+ ],
+ "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
+ "eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
+ "eventExecutionSnapshotMetadata": {
+ "eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
+ "taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
+ "taskName": "A String", # the task name associated with this snapshot. Could be empty.
+ "taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
+ },
+ "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "snapshotTime": "A String", # Indicates when this snapshot is taken.
+ "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+ { # Contains the details of the execution of this task. Next available id: 11
+ "taskAttemptStats": [
+ {
+ "endTime": "A String", # The end time of the task execution for current attempt.
+ "startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "taskExecutionState": "A String",
+ "taskNumber": "A String", # Pointer to the task config it used for execution.
+ },
+ ],
+ "taskName": "A String", # The task name associated with this snapshot. Could be empty.
+ },
+ ],
+ "eventExecutionState": "A String", # The execution state of this event.
+ "eventRetriesFromBeginningCount": 42, # Indicates the number of times the execution has restarted from the beginning.
+ "logFilePath": "A String", # The log file path (aka. cns address) for this event.
+ "networkAddress": "A String", # The network address (aka. bns address) that indicates where the event executor is running.
+ "nextExecutionTime": "A String", # Next scheduled execution time in case the execution status was RETRY_ON_HOLD.
+ "ryeLockUnheldCount": 42, # Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/
+ },
+ "eventExecutionInfoId": "A String", # Auto-generated primary key.
+ "executionTraceInfo": { # Message that helps aggregate all sub-executions triggered by one execution and keeps track of child-parent relationships. # Execution trace info to aggregate parent-child executions.
+ "parentEventExecutionInfoId": "A String", # Parent event execution info id that triggers the current execution through SubWorkflowExecutorTask.
+ "traceId": "A String", # Used to aggregate ExecutionTraceInfo.
+ },
+ "lastModifiedTime": "A String", # Auto-generated.
+ "postMethod": "A String", # The ways user posts this event.
+ "product": "A String", # Which Google product the execution_info belongs to. If not set, the execution_info belongs to Integration Platform by default.
+ "requestId": "A String", # Optional. This is used to de-dup incoming request.
+ "requestParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Event parameters come in as part of the request.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "responseParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Event parameters come out as part of the response.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "snapshotNumber": "A String", # Workflow snapshot number.
+ "tenant": "A String", # Tenant this event is created. Used to reschedule the event to correct tenant.
+ "triggerId": "A String", # The trigger id of the workflow trigger config. If both trigger_id and client_id is present, the workflow is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
+ "workflowId": "A String", # Required. Pointer to the workflow it is executing.
+ "workflowName": "A String", # Name of the workflow.
+ "workflowRetryBackoffIntervalSeconds": "A String", # Time interval in seconds to schedule retry of workflow in manifold when workflow is already running
+ },
+ ],
+ "executions": [ # The detailed information of requested executions
+ { # The Execution resource contains detailed information of an individual integration execution.
+ "createTime": "A String", # Output only. Created time of the execution.
+ "directSubExecutions": [ # Direct sub executions of the following Execution.
+ # Object with schema name: GoogleCloudIntegrationsV1alphaExecution
+ ],
+ "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10 # The execution info about this event.
+ "eventAttemptStats": [
+ {
+ "endTime": "A String", # The end time of the event execution for current attempt.
+ "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "eventExecutionSnapshot": [
+ { # Contains the snapshot of the event execution for a given checkpoint. Next available id: 13
+ "checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
+ "conditionResults": [ # All of the computed conditions that been calculated.
+ { # Contains the combined condition calculation results.
+ "currentTaskNumber": "A String", # the current task number.
+ "nextTaskNumber": "A String", # the next task number.
+ "result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
+ },
+ ],
+ "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
+ "eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
+ "eventExecutionSnapshotMetadata": {
+ "eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
+ "taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
+ "taskName": "A String", # the task name associated with this snapshot. Could be empty.
+ "taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
+ },
+ "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "exceedMaxSize": True or False, # indicate whether snapshot exceeded maximum size before clean up
+ "snapshotTime": "A String", # Indicates when this snapshot is taken.
+ "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+ { # Contains the details of the execution of this task. Next available id: 11
+ "taskAttemptStats": [
+ {
+ "endTime": "A String", # The end time of the task execution for current attempt.
+ "startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "taskExecutionState": "A String",
+ "taskNumber": "A String", # Pointer to the task config it used for execution.
+ },
+ ],
+ "taskName": "A String", # The task name associated with this snapshot. Could be empty.
+ },
+ ],
+ "eventExecutionState": "A String",
+ "eventRetriesFromBeginningCount": 42, # Indicates the number of times the execution has restarted from the beginning.
+ "logFilePath": "A String", # The log file path (aka. cns address) for this event.
+ "networkAddress": "A String", # The network address (aka. bns address) that indicates where the event executor is running.
+ "nextExecutionTime": "A String", # Next scheduled execution time in case the execution status was RETRY_ON_HOLD.
+ "ryeLockUnheldCount": 42, # Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/
+ },
+ "executionDetails": { # Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics. # Detailed info of this execution.
+ "attemptStats": [ # List of Start and end time of the execution attempts.
+ { # Status for the execution attempt.
+ "endTime": "A String", # The end time of the event execution for current attempt.
+ "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "executionSnapshots": [ # List of snapshots taken during the execution.
+ { # Contains the snapshot of the execution for a given checkpoint.
+ "checkpointTaskNumber": "A String", # Indicates "after which checkpoint task's execution" this snapshot is taken.
+ "executionSnapshotMetadata": { # Metadata of the execution snapshot. # Metadata of the execution snapshot.
+ "executionAttempt": 42, # the execution attempt number this snapshot belongs to.
+ "task": "A String", # the task name associated with this snapshot.
+ "taskAttempt": 42, # the task attempt number this snapshot belongs to.
+ "taskNumber": "A String", # The task number associated with this snapshot.
+ },
+ "params": { # Parameters used during the execution.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+ { # Contains the details of the execution of this task.
+ "taskAttemptStats": [ # Status for the current task execution attempt.
+ { # Status for the execution attempt.
+ "endTime": "A String", # The end time of the event execution for current attempt.
+ "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "taskExecutionState": "A String", # The execution state of this task.
+ "taskNumber": "A String", # Pointer to the task config it used for execution.
+ },
+ ],
+ },
+ ],
+ "state": "A String", # Status of the execution.
+ },
+ "executionMethod": "A String", # The ways user posts this event.
+ "name": "A String", # Auto-generated primary key.
+ "requestParameters": { # Event parameters come in as part of the request.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "requestParams": [ # Event parameters come in as part of the request.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ "responseParameters": { # Event parameters returned as part of the response.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "responseParams": [ # Event parameters come out as part of the response.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ "triggerId": "A String", # The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
+ "updateTime": "A String", # Output only. Last modified time of the execution.
+ },
+ ],
+ "nextPageToken": "A String", # The token used to retrieve the next page results.
+}
+list_next()
+ 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. ++
+ close()
Close httplib2 connections.
+
+ lift(name, body=None, x__xgafv=None)
* Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
* Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
+ +Retrieves the next page of results.
+
+ resolve(name, body=None, x__xgafv=None)
* Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.
+close()
+ Close httplib2 connections.+
lift(name, body=None, x__xgafv=None)
+ * Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
+
+Args:
+ name: string, Required. The resource that the suspension belongs to. "projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}" format. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for lift Suspension
+ "suspensionResult": "A String", # User passed in suspension result and will be used to control workflow execution branching behavior by setting up corresponnding edge condition with suspension result. For example, if you want to lift the suspension, you can pass "Approved", or if you want to reject the suspension and terminate workfloe execution, you can pass "Rejected" and terminate the workflow execution with configuring the edge condition.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response of lift Suspense
+ "eventExecutionInfoId": "A String", # Execution Id that will be returned
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ * Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
+
+Args:
+ parent: string, Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name} (required)
+ filter: string, Standard filter field.
+ orderBy: string, Field name to order by.
+ pageSize: integer, Maximum number of entries in the response.
+ pageToken: string, Token to retrieve a specific page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for Suspensions.ListSuspensions.
+ "nextPageToken": "A String", # Token to retrieve the next page of results.
+ "suspensions": [ # The suspensions for the relevant execution which the caller has permissions to view and resolve.
+ { # A record representing a suspension.
+ "approvalConfig": { # Configurations for approving the Suspension. # Controls the notifications and approval permissions for this suspension.
+ "customMessage": "A String", # Information to provide for recipients.
+ "emailAddresses": [ # Email addresses to send approval request to.
+ "A String",
+ ],
+ "expiration": { # Expiration configs for the approval request. # Indicates the next steps when no external actions happen on the suspension.
+ "expireTime": "A String", # Output only. Time after which the suspension expires, if no action taken.
+ "liftWhenExpired": True or False, # Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.
+ "remindTime": "A String", # Time after the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.
+ },
+ },
+ "audit": { # Contains when and by whom the suspension was resolved. # Metadata pertaining to the resolution of this suspension.
+ "resolveTime": "A String", # Time at which this suspension was resolved.
+ "resolver": "A String", # Email address of the person who resolved this suspension.
+ },
+ "createTime": "A String", # Output only. Auto-generated.
+ "eventExecutionInfoId": "A String", # Required. ID of the associated execution.
+ "integration": "A String", # Required. The name of the originating integration.
+ "lastModifyTime": "A String", # Output only. Auto-generated.
+ "name": "A String", # Resource name for suspensions suspension/{suspension_id}
+ "state": "A String", # Required. State of this suspension, indicating what action a resolver has taken.
+ "suspensionConfig": { # Controls the notifications and resolver permissions for this suspension.
+ "customMessage": "A String", # Optional information to provide recipients of the suspension in addition to the resolution URL, typically containing relevant parameter values from the originating workflow.
+ "notifications": [
+ {
+ "buganizerNotification": {
+ "assigneeEmailAddress": "A String", # Whom to assign the new bug. Optional.
+ "componentId": "A String", # ID of the buganizer component within which to create a new issue. Required.
+ "templateId": "A String", # ID of the buganizer template to use. Optional.
+ "title": "A String", # Title of the issue to be created. Required.
+ },
+ "emailAddress": { # Email address along with optional name and tokens. These tokens will be substituted for the variables in the form of [{var_name}], where var_name could be any string of no more than 32 bytes.
+ "email": "A String", # Required.
+ "name": "A String",
+ "tokens": [
+ {
+ "name": "A String",
+ "value": "A String",
+ },
+ ],
+ },
+ "escalatorQueue": "A String",
+ "pubsubTopic": "A String",
+ "request": { # If the out-of-the-box email/pubsub notifications are not suitable and custom logic is required, fire a workflow containing all info needed to notify users to resume execution.
+ "postToQueueWithTriggerIdRequest": { # Use this request to post all workflows associated with a given trigger id. Next available id: 10 # Request to fire an event containing the SuspensionInfo message.
+ "clientId": "A String", # Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the {@link TriggerConfig}. For Api Trigger, the client id is required and will be validated against the allowed clients.
+ "ignoreErrorIfNoActiveWorkflow": True or False, # Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested trigger_id or client_id is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each workflow execution. Optional.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "priority": "A String", # The request priority this request should be processed at. For internal users:
+ "requestId": "A String", # Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned. Must have no more than 36 characters and contain only alphanumeric characters and hyphens.
+ "scheduledTime": "A String", # Optional. Time in milliseconds since epoch when the given event would be scheduled.
+ "testMode": True or False, # Optional. Sets test mode in {@link enterprise/crm/eventbus/event_message.proto}.
+ "triggerId": "A String", # Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required.
+ "workflowName": "A String", # Optional. If provided, the workflow_name is used to filter all the matched workflows having same trigger_id+client_id. A combination of trigger_id, client_id and workflow_name identifies a unique workflow.
+ },
+ "suspensionInfoEventParameterKey": "A String", # In the fired event, set the SuspensionInfo message as the value for this key.
+ },
+ },
+ ],
+ "suspensionExpiration": { # Indicates the next steps when no external actions happen on the suspension.
+ "expireAfterMs": 42, # Milliseconds after which the suspension expires, if no action taken.
+ "liftWhenExpired": True or False, # Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.
+ "remindAfterMs": 42, # Milliseconds after which the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.
+ },
+ "whoMayResolve": [ # Identities able to resolve this suspension.
+ { # LINT.IfChange
+ "gaiaIdentity": { # Represents a Gaia identity for a person or service account.
+ "emailAddress": "A String",
+ "gaiaId": "A String",
+ },
+ "googleGroup": {
+ "emailAddress": "A String",
+ "gaiaId": "A String",
+ },
+ "loasRole": "A String",
+ "mdbGroup": "A String",
+ },
+ ],
+ },
+ "taskId": "A String", # Required. Task id of the associated SuspensionTask.
+ },
+ ],
+}
+list_next()
+ 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. ++
resolve(name, body=None, x__xgafv=None)
+ * Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.
+
+Args:
+ name: string, Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for [Suspensions.ResolveSuspensions].
+ "suspension": { # A record representing a suspension. # Suspension, containing the event_execution_info_id, task_id, and state to set on the corresponding suspension record.
+ "approvalConfig": { # Configurations for approving the Suspension. # Controls the notifications and approval permissions for this suspension.
+ "customMessage": "A String", # Information to provide for recipients.
+ "emailAddresses": [ # Email addresses to send approval request to.
+ "A String",
+ ],
+ "expiration": { # Expiration configs for the approval request. # Indicates the next steps when no external actions happen on the suspension.
+ "expireTime": "A String", # Output only. Time after which the suspension expires, if no action taken.
+ "liftWhenExpired": True or False, # Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.
+ "remindTime": "A String", # Time after the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.
+ },
+ },
+ "audit": { # Contains when and by whom the suspension was resolved. # Metadata pertaining to the resolution of this suspension.
+ "resolveTime": "A String", # Time at which this suspension was resolved.
+ "resolver": "A String", # Email address of the person who resolved this suspension.
+ },
+ "createTime": "A String", # Output only. Auto-generated.
+ "eventExecutionInfoId": "A String", # Required. ID of the associated execution.
+ "integration": "A String", # Required. The name of the originating integration.
+ "lastModifyTime": "A String", # Output only. Auto-generated.
+ "name": "A String", # Resource name for suspensions suspension/{suspension_id}
+ "state": "A String", # Required. State of this suspension, indicating what action a resolver has taken.
+ "suspensionConfig": { # Controls the notifications and resolver permissions for this suspension.
+ "customMessage": "A String", # Optional information to provide recipients of the suspension in addition to the resolution URL, typically containing relevant parameter values from the originating workflow.
+ "notifications": [
+ {
+ "buganizerNotification": {
+ "assigneeEmailAddress": "A String", # Whom to assign the new bug. Optional.
+ "componentId": "A String", # ID of the buganizer component within which to create a new issue. Required.
+ "templateId": "A String", # ID of the buganizer template to use. Optional.
+ "title": "A String", # Title of the issue to be created. Required.
+ },
+ "emailAddress": { # Email address along with optional name and tokens. These tokens will be substituted for the variables in the form of [{var_name}], where var_name could be any string of no more than 32 bytes.
+ "email": "A String", # Required.
+ "name": "A String",
+ "tokens": [
+ {
+ "name": "A String",
+ "value": "A String",
+ },
+ ],
+ },
+ "escalatorQueue": "A String",
+ "pubsubTopic": "A String",
+ "request": { # If the out-of-the-box email/pubsub notifications are not suitable and custom logic is required, fire a workflow containing all info needed to notify users to resume execution.
+ "postToQueueWithTriggerIdRequest": { # Use this request to post all workflows associated with a given trigger id. Next available id: 10 # Request to fire an event containing the SuspensionInfo message.
+ "clientId": "A String", # Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the {@link TriggerConfig}. For Api Trigger, the client id is required and will be validated against the allowed clients.
+ "ignoreErrorIfNoActiveWorkflow": True or False, # Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested trigger_id or client_id is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each workflow execution. Optional.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "priority": "A String", # The request priority this request should be processed at. For internal users:
+ "requestId": "A String", # Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned. Must have no more than 36 characters and contain only alphanumeric characters and hyphens.
+ "scheduledTime": "A String", # Optional. Time in milliseconds since epoch when the given event would be scheduled.
+ "testMode": True or False, # Optional. Sets test mode in {@link enterprise/crm/eventbus/event_message.proto}.
+ "triggerId": "A String", # Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required.
+ "workflowName": "A String", # Optional. If provided, the workflow_name is used to filter all the matched workflows having same trigger_id+client_id. A combination of trigger_id, client_id and workflow_name identifies a unique workflow.
+ },
+ "suspensionInfoEventParameterKey": "A String", # In the fired event, set the SuspensionInfo message as the value for this key.
+ },
+ },
+ ],
+ "suspensionExpiration": { # Indicates the next steps when no external actions happen on the suspension.
+ "expireAfterMs": 42, # Milliseconds after which the suspension expires, if no action taken.
+ "liftWhenExpired": True or False, # Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.
+ "remindAfterMs": 42, # Milliseconds after which the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.
+ },
+ "whoMayResolve": [ # Identities able to resolve this suspension.
+ { # LINT.IfChange
+ "gaiaIdentity": { # Represents a Gaia identity for a person or service account.
+ "emailAddress": "A String",
+ "gaiaId": "A String",
+ },
+ "googleGroup": {
+ "emailAddress": "A String",
+ "gaiaId": "A String",
+ },
+ "loasRole": "A String",
+ "mdbGroup": "A String",
+ },
+ ],
+ },
+ "taskId": "A String", # Required. Task id of the associated SuspensionTask.
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for Suspensions.ResolveSuspensions.
+}
+
+ close()
Close httplib2 connections.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists the snapshots of a given integration executions. This RPC is not being used.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
+ Lists the snapshots of a given integration executions. This RPC is not being used.
+
+Args:
+ parent: string, Required. The parent resource name of the integration execution. (required)
+ filter: string, Currently supports filter by `execution_info_id` or `execution_snapshot_id`.
+ pageSize: integer, Number of entries to be returned in a page.
+ pageToken: string, The token used to retrieve the next page results.
+ readMask: string, View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution snapshot will be filled and returned.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for listing the integration execution snapshot.
+ "executionSnapshots": [ # Required. The detailed information for the execution snapshot.
+ { # Contains the snapshot of the event execution for a given checkpoint. Next available id: 13
+ "checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
+ "conditionResults": [ # All of the computed conditions that been calculated.
+ { # Contains the combined condition calculation results.
+ "currentTaskNumber": "A String", # the current task number.
+ "nextTaskNumber": "A String", # the next task number.
+ "result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
+ },
+ ],
+ "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
+ "eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
+ "eventExecutionSnapshotMetadata": {
+ "eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
+ "taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
+ "taskName": "A String", # the task name associated with this snapshot. Could be empty.
+ "taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
+ },
+ "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "exceedMaxSize": True or False, # indicate whether snapshot exceeded maximum size before clean up
+ "snapshotTime": "A String", # Indicates when this snapshot is taken.
+ "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+ { # Contains the details of the execution of this task. Next available id: 11
+ "taskAttemptStats": [
+ {
+ "endTime": "A String", # The end time of the task execution for current attempt.
+ "startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "taskExecutionState": "A String",
+ "taskNumber": "A String", # Pointer to the task config it used for execution.
+ },
+ ],
+ "taskName": "A String", # The task name associated with this snapshot. Could be empty.
+ },
+ ],
+ "nextPageToken": "A String", # The token returned in the previous response.
+}
+list_next()
+ 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. ++
+ executions()
+
Returns the executions Resource.
+ + +Returns the executionsnapshots Resource.
+ +
+ versions()
+
Returns the versions Resource.
+ +
+ close()
Close httplib2 connections.
+ +Delete the selected integration and all versions inside
+
+ execute(name, body=None, x__xgafv=None)
Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of all integrations in the specified project.
+ +Retrieves the next page of results.
+
+ monitorexecutionstats(parent, body=None, x__xgafv=None)
Get execution stats
+
+ schedule(name, body=None, x__xgafv=None)
Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
+
+ test(name, body=None, x__xgafv=None)
Execute the integration in draft state
+close()
+ Close httplib2 connections.+
delete(name, x__xgafv=None)
+ Delete the selected integration and all versions inside
+
+Args:
+ name: string, Required. The location resource of the request. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+execute(name, body=None, x__xgafv=None)
+ Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.
+
+Args:
+ name: string, Required. The integration resource name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request for executing an integration.
+ "doNotPropagateError": True or False, # Optional. Flag to determine how to should propagate errors. If this flag is set to be true, it will not throw an exception. Instead, it will return a {@link ExecuteIntegrationsResponse} with an execution id and error messages as PostWithTriggerIdExecutionException in {@link EventParameters}. The flag is set to be false by default.
+ "executionId": "A String", # Optional. The id of the ON_HOLD execution to be resumed.
+ "inputParameters": { # Optional. Input parameters used by integration execution.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "parameterEntries": [ # Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. Passed in as parameters to each integration execution. Redacted
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "requestId": "A String", # Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
+ "triggerId": "A String", # Required. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id). The trigger_id is in the format of `api_trigger/TRIGGER_NAME`.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response for executing an integration.
+ "eventParameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Details for the integration that were executed.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "executionFailed": True or False, # Is true if any execution in the integration failed. False otherwise.
+ "executionId": "A String", # The id of the execution corresponding to this run of integration.
+ "outputParameters": { # OUTPUT parameters in format of Map. Where Key is the name of the parameter. Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.
+ "a_key": "", # Properties of the object.
+ },
+ "parameterEntries": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Returns the list of all integrations in the specified project.
+
+Args:
+ parent: string, Required. Project and location from which the integrations should be listed. Format: projects/{project} (required)
+ filter: string, Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
+ orderBy: string, The results would be returned in order you specified here. Supported sort keys are: Descending sort order by "last_modified_time", "created_time", "snapshot_number". Ascending sort order by the integration name.
+ pageSize: integer, The page size for the resquest.
+ pageToken: string, The page token for the resquest.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for ListIntegrations.
+ "integrations": [ # The integrations which match the request.
+ { # The integration definition.
+ "active": True or False, # Required. If any integration version is published.
+ "description": "A String", # Optional.
+ "name": "A String", # Required. The resource name of the integration.
+ "updateTime": "A String", # Output only. Auto-generated.
+ },
+ ],
+ "nextPageToken": "A String", # The next page token for the response.
+}
+list_next()
+ 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. ++
monitorexecutionstats(parent, body=None, x__xgafv=None)
+ Get execution stats
+
+Args:
+ parent: string, Required. The parent resource name: {parent=projects/*/locations/*}. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request to get data for monarch connector config.
+ "duration": "A String", # How long the series data range: "1h","1d",etc.
+ "endTime": "A String", # Final time to query over, or the current time if left unset.
+ "mashQuery": { # The MashQuery for searching data, set both queries for Join Operation. # Required. Query for searching data in monarch.
+ "firstQuery": { # The components for constructing MashQuery. # Required. The components for constructing a mash query. Set "point_operation" if this is a single query
+ "borgTaskMetric": "A String", # Required. The metric for monarch.BorgTask.
+ "dataFilters": [ # Optional. optional, filters on fetched data, "metric:client_id" not supported.
+ "A String",
+ ],
+ "fetchFilters": [ # Optional. optional, filters for Fetch Raw, "metric:client_id" not supported.
+ "A String",
+ ],
+ "groupBy": { # MashQuery GroupBy parameters. # Optional. optional, GroupBy variables.
+ "fields": [ # Optional. optional, metrics list for GroupBy.
+ "A String",
+ ],
+ "reducer": "A String", # Optional. optional, reduce function for GroupBy.
+ },
+ "pointOperation": "A String", # Optional. optional, Point Operation on single query or joined query.
+ "timeDelta": "A String", # Required. Window time delta.
+ },
+ "operationMode": { # Operation between 2 query # Optional. optional, only set when joining 2 queries. By default join 2 queries with join operation.
+ "joinConfig": { # Join Operation # Optional. join operation
+ },
+ "operationType": "A String", # Optional. optional operation types.
+ "unionConfig": { # Union operation # Optional. union operation
+ "reducer": "A String", # Optional. optional, reduce function
+ },
+ },
+ "secondQuery": { # The components for constructing MashQuery. # Optional. optional, only set when joining 2 queries. Set "point_operation" for joined query.
+ "borgTaskMetric": "A String", # Required. The metric for monarch.BorgTask.
+ "dataFilters": [ # Optional. optional, filters on fetched data, "metric:client_id" not supported.
+ "A String",
+ ],
+ "fetchFilters": [ # Optional. optional, filters for Fetch Raw, "metric:client_id" not supported.
+ "A String",
+ ],
+ "groupBy": { # MashQuery GroupBy parameters. # Optional. optional, GroupBy variables.
+ "fields": [ # Optional. optional, metrics list for GroupBy.
+ "A String",
+ ],
+ "reducer": "A String", # Optional. optional, reduce function for GroupBy.
+ },
+ "pointOperation": "A String", # Optional. optional, Point Operation on single query or joined query.
+ "timeDelta": "A String", # Required. Window time delta.
+ },
+ },
+ "metricFieldTable": True or False, # Returns a table of all possible metric field values within the specified duration, ignoring any data samples. Useful for autocomplete functionality.
+ "outputPeriod": "A String", # The output period for the query. Must be set if there is a window operation within the query and unset otherwise.
+ "responseTemplate": "A String", # Required. Template for response.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response for getting Execution stats.
+ "aplosSeriesListData": { # Data used for Aplos charts that accept multiple Series. # List of points.
+ "series": [
+ {
+ "data": { # Data used to render an Aplos Series card.
+ "rows": [ # A single Series Row
+ { # Aplos series row is exactly two columns labeled x and y.
+ "x": {
+ "booleanValue": True or False,
+ "doubleValue": 3.14,
+ "empty": { # 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); }
+ },
+ "longValue": "A String",
+ "stringValue": "A String",
+ },
+ "y": {
+ "booleanValue": True or False,
+ "doubleValue": 3.14,
+ "empty": { # 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); }
+ },
+ "longValue": "A String",
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "name": "A String",
+ },
+ ],
+ },
+ "tableData": { # The generic data format returned from all connectors. # Data in form of table.
+ "headers": [ # Ordered list of column headers.
+ "A String",
+ ],
+ "rows": [ # Ordered list of table rows.
+ {
+ "cells": [ # Ordered list of cell values within a row.
+ {
+ "booleanValue": True or False,
+ "doubleValue": 3.14,
+ "empty": { # 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); }
+ },
+ "longValue": "A String",
+ "stringValue": "A String",
+ },
+ ],
+ },
+ ],
+ },
+}
+schedule(name, body=None, x__xgafv=None)
+ Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
+
+Args:
+ name: string, The integration resource name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request for scheduling an integration.
+ "inputParameters": { # Optional. Input parameters used by integration execution.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "parameterEntries": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each integration execution.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "requestId": "A String", # This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
+ "scheduleTime": "A String", # The time that the integration should be executed. If the time is less or equal to the current time, the integration is executed immediately.
+ "triggerId": "A String", # Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id)
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response for executing an integration.
+ "executionInfoIds": [ # The execution info id for the executed integrations.
+ "A String",
+ ],
+}
+test(name, body=None, x__xgafv=None)
+ Execute the integration in draft state
+
+Args:
+ name: string, Output only. Auto-generated primary key. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request for testing an integration.
+ "clientId": "A String", # Required. This is used to identify the client on whose behalf the event will be executed.
+ "deadlineSecondsTime": "A String", # Optional. custom deadline of the rpc
+ "inputParameters": { # Optional. Input parameters used during integration execution.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "integrationVersion": { # The integration version definition. # Required. integration config to execute the workflow
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. Passed in as parameters to each integration execution.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "testMode": True or False, # Optional. Can be specified in the event request, otherwise false (default). If true, enables tasks with condition "test_mode = true". If false, disables tasks with condition "test_mode = true" if global test mode (set by platform) is also false {@link EventBusConfig}.
+ "triggerId": "A String", # Required. The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response for testing an integration.
+ "eventParameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Details for the integration that were executed.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "executionFailed": True or False, # Is true if any execution in the integration failed. False otherwise.
+ "executionId": "A String", # The id of the execution corresponding to this run of integration.
+ "parameterEntries": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ "parameters": { # Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+}
+
+ archive(name, body=None, x__xgafv=None)
Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, newIntegration=None, x__xgafv=None)
Create a integration with a draft version in the specified project.
+
+ deactivate(name, body=None, x__xgafv=None)
Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
+ +Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.
+
+ download(name, fileFormat=None, x__xgafv=None)
Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.
+ +Get a integration in the specified project.
+ +Returns the list of all integration versions in the specified project.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Update a integration with a draft version in the specified project.
+
+ publish(name, body=None, x__xgafv=None)
This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.
+
+ unpublish(name, body=None, x__xgafv=None)
Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
+
+ upload(parent, body=None, x__xgafv=None)
Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.
+
+ validate(name, body=None, x__xgafv=None)
Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.
+archive(name, body=None, x__xgafv=None)
+ Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
+
+Args:
+ name: string, Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for ArchiveIntegrationVersion.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for ArchiveIntegrationVersion.
+}
+close()
+ Close httplib2 connections.+
create(parent, body=None, newIntegration=None, x__xgafv=None)
+ Create a integration with a draft version in the specified project.
+
+Args:
+ parent: string, Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The integration version definition.
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+ newIntegration: boolean, Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to `false` and no existing integration is found, a new draft integration will still be created.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The integration version definition.
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+deactivate(name, body=None, x__xgafv=None)
+ Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
+
+Args:
+ name: string, Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for DeactivateIntegrationVersion.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for DeactivateIntegrationVersion.
+}
+delete(name, x__xgafv=None)
+ Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.
+
+Args:
+ name: string, Required. The version to delete. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+download(name, fileFormat=None, x__xgafv=None)
+ Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.
+
+Args:
+ name: string, Required. The version to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ fileFormat: string, File format for download request.
+ Allowed values
+ FILE_FORMAT_UNSPECIFIED - Unspecified file format
+ JSON - JSON File Format
+ YAML - YAML File Format
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for DownloadIntegrationVersion.
+ "content": "A String", # String representation of the integration version.
+}
+get(name, x__xgafv=None)
+ Get a integration in the specified project.
+
+Args:
+ name: string, Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The integration version definition.
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+list(parent, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Returns the list of all integration versions in the specified project.
+
+Args:
+ parent: string, Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client". (required)
+ fieldMask: string, The field mask which specifies the particular data to be returned.
+ filter: string, Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
+ orderBy: string, The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for "last_modified_time", "created_time", "snapshot_number" Ascending sort order for "name".
+ pageSize: integer, The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for ListIntegrationVersions.
+ "integrationVersions": [ # The integrations which match the request.
+ { # The integration version definition.
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "noPermission": True or False, # Whether the user has no permission on the version or not.
+}
+list_next()
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Update a integration with a draft version in the specified project.
+
+Args:
+ name: string, Output only. Auto-generated primary key. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The integration version definition.
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+ updateMask: string, Field mask specifying the fields in the above integration that have been modified and need to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The integration version definition.
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+publish(name, body=None, x__xgafv=None)
+ This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.
+
+Args:
+ name: string, Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for PublishIntegrationVersion.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for PublishIntegrationVersion.
+}
+unpublish(name, body=None, x__xgafv=None)
+ Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
+
+Args:
+ name: string, Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for UnpublishIntegrationVersion.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+upload(parent, body=None, x__xgafv=None)
+ Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.
+
+Args:
+ parent: string, Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for UploadIntegrationVersion.
+ "content": "A String", # The textproto of the integration_version.
+ "fileFormat": "A String", # File format for upload request.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for UploadIntegrationVersion.
+ "integrationVersion": { # The integration version definition. # The uploaded integration.
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+ },
+}
+validate(name, body=None, x__xgafv=None)
+ Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.
+
+Args:
+ name: string, Required. The version to validate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for ValidateIntegrationVersion.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for ValidateIntegrationVersion.
+}
+
+ close()
Close httplib2 connections.
+ +Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.
+ +Deletes an auth config.
+ +Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
+ +Retrieves the next page of results.
+ +Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.
+close()
+ Close httplib2 connections.+
create(parent, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, x__xgafv=None)
+ Creates an auth config record. Fetch corresponding credentials for specific auth types, e.g. access token for OAuth 2.0, JWT token for JWT. Encrypt the auth config with Cloud KMS and store the encrypted credentials in Spanner. Returns the encrypted auth config.
+
+Args:
+ parent: string, Required. "projects/{project}/locations/{location}" format. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The AuthConfig resource use to hold channels and connection config data.
+ "certificateId": "A String", # Certificate id for client certificate
+ "createTime": "A String", # Output only. The timestamp when the auth config is created.
+ "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "credentialType": "A String", # Credential type of the encrypted credential.
+ "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+ "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+ "token": "A String", # The token for the auth type.
+ "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+ },
+ "credentialType": "A String", # Credential type associated with auth config.
+ "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+ "jwt": "A String", # The token calculated by the header, payload and signature.
+ "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+ "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+ "secret": "A String", # User's pre-shared secret to sign the token.
+ },
+ "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+ "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+ "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+ "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "clientId": "A String", # The client's id.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "password": "A String", # The user's password.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "username": "A String", # The user's username.
+ },
+ "oidcToken": { # OIDC Token # Google OIDC ID Token
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+ "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+ "token": "A String", # ID token obtained for the service account
+ "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+ },
+ "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+ },
+ "usernameAndPassword": { # Username and password pair. # Username and password credential
+ "password": "A String", # Password to be used
+ "username": "A String", # Username to be used
+ },
+ },
+ "description": "A String", # A description of the auth config.
+ "displayName": "A String", # The name of the auth config.
+ "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+ "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+ "A String",
+ ],
+ "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+ "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+ "reason": "A String", # The reason / details of the current status.
+ "state": "A String", # The status of the auth config.
+ "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+ "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+ "visibility": "A String", # The visibility of the auth config.
+}
+
+ clientCertificate_encryptedPrivateKey: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ clientCertificate_passphrase: string, 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ clientCertificate_sslCertificate: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The AuthConfig resource use to hold channels and connection config data.
+ "certificateId": "A String", # Certificate id for client certificate
+ "createTime": "A String", # Output only. The timestamp when the auth config is created.
+ "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "credentialType": "A String", # Credential type of the encrypted credential.
+ "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+ "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+ "token": "A String", # The token for the auth type.
+ "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+ },
+ "credentialType": "A String", # Credential type associated with auth config.
+ "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+ "jwt": "A String", # The token calculated by the header, payload and signature.
+ "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+ "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+ "secret": "A String", # User's pre-shared secret to sign the token.
+ },
+ "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+ "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+ "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+ "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "clientId": "A String", # The client's id.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "password": "A String", # The user's password.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "username": "A String", # The user's username.
+ },
+ "oidcToken": { # OIDC Token # Google OIDC ID Token
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+ "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+ "token": "A String", # ID token obtained for the service account
+ "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+ },
+ "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+ },
+ "usernameAndPassword": { # Username and password pair. # Username and password credential
+ "password": "A String", # Password to be used
+ "username": "A String", # Username to be used
+ },
+ },
+ "description": "A String", # A description of the auth config.
+ "displayName": "A String", # The name of the auth config.
+ "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+ "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+ "A String",
+ ],
+ "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+ "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+ "reason": "A String", # The reason / details of the current status.
+ "state": "A String", # The status of the auth config.
+ "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+ "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+ "visibility": "A String", # The visibility of the auth config.
+}
+delete(name, x__xgafv=None)
+ Deletes an auth config.
+
+Args:
+ name: string, Required. The name that is associated with the AuthConfig. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+get(name, x__xgafv=None)
+ Gets a complete auth config. If the auth config doesn't exist, Code.NOT_FOUND exception will be thrown. Returns the decrypted auth config.
+
+Args:
+ name: string, Required. The name that is associated with the AuthConfig. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The AuthConfig resource use to hold channels and connection config data.
+ "certificateId": "A String", # Certificate id for client certificate
+ "createTime": "A String", # Output only. The timestamp when the auth config is created.
+ "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "credentialType": "A String", # Credential type of the encrypted credential.
+ "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+ "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+ "token": "A String", # The token for the auth type.
+ "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+ },
+ "credentialType": "A String", # Credential type associated with auth config.
+ "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+ "jwt": "A String", # The token calculated by the header, payload and signature.
+ "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+ "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+ "secret": "A String", # User's pre-shared secret to sign the token.
+ },
+ "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+ "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+ "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+ "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "clientId": "A String", # The client's id.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "password": "A String", # The user's password.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "username": "A String", # The user's username.
+ },
+ "oidcToken": { # OIDC Token # Google OIDC ID Token
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+ "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+ "token": "A String", # ID token obtained for the service account
+ "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+ },
+ "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+ },
+ "usernameAndPassword": { # Username and password pair. # Username and password credential
+ "password": "A String", # Password to be used
+ "username": "A String", # Username to be used
+ },
+ },
+ "description": "A String", # A description of the auth config.
+ "displayName": "A String", # The name of the auth config.
+ "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+ "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+ "A String",
+ ],
+ "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+ "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+ "reason": "A String", # The reason / details of the current status.
+ "state": "A String", # The status of the auth config.
+ "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+ "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+ "visibility": "A String", # The visibility of the auth config.
+}
+list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
+ Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.
+
+Args:
+ parent: string, Required. The client, which owns this collection of AuthConfigs. (required)
+ filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
+ pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
+ pageToken: string, The token returned in the previous response.
+ readMask: string, The mask which specifies fields that need to be returned in the AuthConfig's response.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response to list AuthConfigs.
+ "authConfigs": [ # The list of AuthConfigs retrieved.
+ { # The AuthConfig resource use to hold channels and connection config data.
+ "certificateId": "A String", # Certificate id for client certificate
+ "createTime": "A String", # Output only. The timestamp when the auth config is created.
+ "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "credentialType": "A String", # Credential type of the encrypted credential.
+ "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+ "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+ "token": "A String", # The token for the auth type.
+ "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+ },
+ "credentialType": "A String", # Credential type associated with auth config.
+ "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+ "jwt": "A String", # The token calculated by the header, payload and signature.
+ "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+ "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+ "secret": "A String", # User's pre-shared secret to sign the token.
+ },
+ "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+ "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+ "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+ "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "clientId": "A String", # The client's id.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "password": "A String", # The user's password.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "username": "A String", # The user's username.
+ },
+ "oidcToken": { # OIDC Token # Google OIDC ID Token
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+ "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+ "token": "A String", # ID token obtained for the service account
+ "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+ },
+ "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+ },
+ "usernameAndPassword": { # Username and password pair. # Username and password credential
+ "password": "A String", # Password to be used
+ "username": "A String", # Username to be used
+ },
+ },
+ "description": "A String", # A description of the auth config.
+ "displayName": "A String", # The name of the auth config.
+ "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+ "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+ "A String",
+ ],
+ "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+ "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+ "reason": "A String", # The reason / details of the current status.
+ "state": "A String", # The status of the auth config.
+ "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+ "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+ "visibility": "A String", # The visibility of the auth config.
+ },
+ ],
+ "nextPageToken": "A String", # The token used to retrieve the next page of results.
+}
+list_next()
+ 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. ++
patch(name, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, updateMask=None, x__xgafv=None)
+ Updates an auth config. If credential is updated, fetch the encrypted auth config from Spanner, decrypt with Cloud KMS key, update the credential fields, re-encrypt with Cloud KMS key and update the Spanner record. For other fields, directly update the Spanner record. Returns the encrypted auth config.
+
+Args:
+ name: string, Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The AuthConfig resource use to hold channels and connection config data.
+ "certificateId": "A String", # Certificate id for client certificate
+ "createTime": "A String", # Output only. The timestamp when the auth config is created.
+ "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "credentialType": "A String", # Credential type of the encrypted credential.
+ "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+ "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+ "token": "A String", # The token for the auth type.
+ "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+ },
+ "credentialType": "A String", # Credential type associated with auth config.
+ "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+ "jwt": "A String", # The token calculated by the header, payload and signature.
+ "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+ "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+ "secret": "A String", # User's pre-shared secret to sign the token.
+ },
+ "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+ "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+ "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+ "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "clientId": "A String", # The client's id.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "password": "A String", # The user's password.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "username": "A String", # The user's username.
+ },
+ "oidcToken": { # OIDC Token # Google OIDC ID Token
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+ "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+ "token": "A String", # ID token obtained for the service account
+ "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+ },
+ "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+ },
+ "usernameAndPassword": { # Username and password pair. # Username and password credential
+ "password": "A String", # Password to be used
+ "username": "A String", # Username to be used
+ },
+ },
+ "description": "A String", # A description of the auth config.
+ "displayName": "A String", # The name of the auth config.
+ "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+ "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+ "A String",
+ ],
+ "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+ "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+ "reason": "A String", # The reason / details of the current status.
+ "state": "A String", # The status of the auth config.
+ "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+ "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+ "visibility": "A String", # The visibility of the auth config.
+}
+
+ clientCertificate_encryptedPrivateKey: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ clientCertificate_passphrase: string, 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ clientCertificate_sslCertificate: string, The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ updateMask: string, Field mask specifying the fields in the above AuthConfig that have been modified and need to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The AuthConfig resource use to hold channels and connection config data.
+ "certificateId": "A String", # Certificate id for client certificate
+ "createTime": "A String", # Output only. The timestamp when the auth config is created.
+ "creatorEmail": "A String", # The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "credentialType": "A String", # Credential type of the encrypted credential.
+ "decryptedCredential": { # Defines parameters for a single, canonical credential. # Raw auth credentials.
+ "authToken": { # The credentials to authenticate a user agent with a server that is put in HTTP Authorization request header. # Auth token credential
+ "token": "A String", # The token for the auth type.
+ "type": "A String", # Authentication type, e.g. "Basic", "Bearer", etc.
+ },
+ "credentialType": "A String", # Credential type associated with auth config.
+ "jwt": { # Represents JSON web token(JWT), which is a compact, URL-safe means of representing claims to be transferred between two parties, enabling the claims to be digitally signed or integrity protected. # JWT credential
+ "jwt": "A String", # The token calculated by the header, payload and signature.
+ "jwtHeader": "A String", # Identifies which algorithm is used to generate the signature.
+ "jwtPayload": "A String", # Contains a set of claims. The JWT specification defines seven Registered Claim Names which are the standard fields commonly included in tokens. Custom claims are usually also included, depending on the purpose of the token.
+ "secret": "A String", # User's pre-shared secret to sign the token.
+ },
+ "oauth2AuthorizationCode": { # The OAuth Type where the client sends request with the client id and requested scopes to auth endpoint. User sees a consent screen and auth code is received at specified redirect url afterwards. The auth code is then combined with the client id and secret and sent to the token endpoint in exchange for the access and refresh token. The refresh token can be used to fetch new access tokens. # The api_key and oauth2_implicit are not covered in v1 and will be picked up once v1 is implemented. ApiKey api_key = 3; OAuth2 authorization code credential
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # The access token received from the token endpoint.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "applyReauthPolicy": True or False, # Indicates if the user has opted in Google Reauth Policy. If opted in, the refresh token will be valid for 20 hours, after which time users must re-authenticate in order to obtain a new one.
+ "authCode": "A String", # The Auth Code that is used to initially retrieve the access token.
+ "authEndpoint": "A String", # The auth url endpoint to send the auth code request to.
+ "authParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The auth parameters sent along with the auth code request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "clientId": "A String", # The client's id.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token url endpoint to send the token request to.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # The token parameters sent along with the token request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ClientCredentials": { # For client credentials grant, the client sends a POST request with grant_type as 'client_credentials' to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2Implicit oauth2_implicit = 5; OAuth2 client credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ },
+ "oauth2ResourceOwnerCredentials": { # For resource owner credentials grant, the client will ask the user for their authorization credentials (ususally a username and password) and send a POST request to the authorization server. The authorization server will respond with a JSON object containing the access token. # OAuth2 resource owner credentials
+ "accessToken": { # The access token represents the authorization of a specific application to access specific parts of a user’s data. # Access token fetched from the authorization server.
+ "accessToken": "A String", # The access token encapsulating the security identity of a process or thread.
+ "accessTokenExpireTime": "A String", # Required. The approximate time until the access token retrieved is valid.
+ "refreshToken": "A String", # If the access token will expire, use the refresh token to obtain another access token.
+ "refreshTokenExpireTime": "A String", # The approximate time until the refresh token retrieved is valid.
+ "tokenType": "A String", # Only support "bearer" token in v1 as bearer token is the predominant type used with OAuth 2.0.
+ },
+ "clientId": "A String", # The client's ID.
+ "clientSecret": "A String", # The client's secret.
+ "password": "A String", # The user's password.
+ "requestType": "A String", # Represent how to pass parameters to fetch access token
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "tokenEndpoint": "A String", # The token endpoint is used by the client to obtain an access token by presenting its authorization grant or refresh token.
+ "tokenParams": { # A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified. # Token parameters for the auth request.
+ "entries": [ # A list of parameter map entries.
+ { # Entry is a pair of key and value.
+ "key": { # Field represents either the key or value in an entry. # Key of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ "value": { # Field represents either the key or value in an entry. # Value of the map entry.
+ "literalValue": { # The type of the parameter. # Passing a literal value.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "referenceKey": "A String", # Referencing one of the Integration variables.
+ },
+ },
+ ],
+ "keyType": "A String", # Option to specify key type for all entries of the map. If provided then field types for all entries must conform to this.
+ "valueType": "A String", # Option to specify value type for all entries of the map. If provided then field types for all entries must conform to this.
+ },
+ "username": "A String", # The user's username.
+ },
+ "oidcToken": { # OIDC Token # Google OIDC ID Token
+ "audience": "A String", # Audience to be used when generating OIDC token. The audience claim identifies the recipients that the JWT is intended for.
+ "serviceAccountEmail": "A String", # The service account email to be used as the identity for the token.
+ "token": "A String", # ID token obtained for the service account
+ "tokenExpireTime": "A String", # The approximate time until the token retrieved is valid.
+ },
+ "serviceAccountCredentials": { # Represents the service account which can be used to generate access token for authenticating the service call. # Service account credential
+ "scope": "A String", # A space-delimited list of requested scope permissions.
+ "serviceAccount": "A String", # Name of the service account that has the permission to make the request.
+ },
+ "usernameAndPassword": { # Username and password pair. # Username and password credential
+ "password": "A String", # Password to be used
+ "username": "A String", # Username to be used
+ },
+ },
+ "description": "A String", # A description of the auth config.
+ "displayName": "A String", # The name of the auth config.
+ "encryptedCredential": "A String", # Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key.
+ "expiryNotificationDuration": [ # User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours.
+ "A String",
+ ],
+ "lastModifierEmail": "A String", # The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}.
+ "overrideValidTime": "A String", # User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings.
+ "reason": "A String", # The reason / details of the current status.
+ "state": "A String", # The status of the auth config.
+ "updateTime": "A String", # Output only. The timestamp when the auth config is modified.
+ "validTime": "A String", # The time until the auth config is valid. Empty or max value is considered the auth config won't expire.
+ "visibility": "A String", # The visibility of the auth config.
+}
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.
+ +Delete a certificate
+ +Get a certificates in the specified project.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
List all the certificates that match the filter. Restrict to certificate of current client only.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates a new certificate. The certificate will be registered to the trawler service and will be encrypted using cloud KMS and stored in Spanner Returns the certificate.
+
+Args:
+ parent: string, Required. "projects/{project}/locations/{location}" format. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The certificate definition
+ "certificateStatus": "A String", # Status of the certificate
+ "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+ "description": "A String", # Description of the certificate
+ "displayName": "A String", # Name of the certificate
+ "name": "A String", # Output only. Auto generated primary key
+ "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+ "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ },
+ "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+ "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+ "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The certificate definition
+ "certificateStatus": "A String", # Status of the certificate
+ "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+ "description": "A String", # Description of the certificate
+ "displayName": "A String", # Name of the certificate
+ "name": "A String", # Output only. Auto generated primary key
+ "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+ "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ },
+ "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+ "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+ "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+delete(name, x__xgafv=None)
+ Delete a certificate
+
+Args:
+ name: string, Required. The name that is associated with the Certificate. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+get(name, x__xgafv=None)
+ Get a certificates in the specified project.
+
+Args:
+ name: string, Required. The certificate to retrieve. Format: projects/{project}/locations/{location}/certificates/{certificate} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The certificate definition
+ "certificateStatus": "A String", # Status of the certificate
+ "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+ "description": "A String", # Description of the certificate
+ "displayName": "A String", # Name of the certificate
+ "name": "A String", # Output only. Auto generated primary key
+ "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+ "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ },
+ "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+ "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+ "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
+ List all the certificates that match the filter. Restrict to certificate of current client only.
+
+Args:
+ parent: string, Required. The client, which owns this collection of Certificates. (required)
+ filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
+ pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
+ pageToken: string, The token returned in the previous response.
+ readMask: string, The mask which specifies fields that need to be returned in the Certificate's response.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response to list Certificates.
+ "certificates": [ # The list of Certificates retrieved.
+ { # The certificate definition
+ "certificateStatus": "A String", # Status of the certificate
+ "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+ "description": "A String", # Description of the certificate
+ "displayName": "A String", # Name of the certificate
+ "name": "A String", # Output only. Auto generated primary key
+ "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+ "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ },
+ "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+ "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+ "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+ },
+ ],
+ "nextPageToken": "A String", # The token used to retrieve the next page of results.
+}
+list_next()
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates the certificate by id. If new certificate file is updated, it will register with the trawler service, re-encrypt with cloud KMS and update the Spanner record. Other fields will directly update the Spanner record. Returns the Certificate.
+
+Args:
+ name: string, Output only. Auto generated primary key (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The certificate definition
+ "certificateStatus": "A String", # Status of the certificate
+ "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+ "description": "A String", # Description of the certificate
+ "displayName": "A String", # Name of the certificate
+ "name": "A String", # Output only. Auto generated primary key
+ "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+ "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ },
+ "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+ "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+ "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+
+ updateMask: string, Field mask specifying the fields in the above Certificate that have been modified and need to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The certificate definition
+ "certificateStatus": "A String", # Status of the certificate
+ "credentialId": "A String", # Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY
+ "description": "A String", # Description of the certificate
+ "displayName": "A String", # Name of the certificate
+ "name": "A String", # Output only. Auto generated primary key
+ "rawCertificate": { # Contains client certificate information # Input only. Raw client certificate which would be registered with trawler
+ "encryptedPrivateKey": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ "passphrase": "A String", # 'passphrase' should be left unset if private key is not encrypted. Note that 'passphrase' is not the password for web server, but an extra layer of security to protected private key.
+ "sslCertificate": "A String", # The ssl certificate encoded in PEM format. This string must include the begin header and end footer lines. For example, -----BEGIN CERTIFICATE----- MIICTTCCAbagAwIBAgIJAPT0tSKNxan/MA0GCSqGSIb3DQEBCwUAMCoxFzAVBgNV BAoTDkdvb2dsZSBURVNUSU5HMQ8wDQYDVQQDEwZ0ZXN0Q0EwHhcNMTUwMTAxMDAw MDAwWhcNMjUwMTAxMDAwMDAwWjAuMRcwFQYDVQQKEw5Hb29nbGUgVEVTVElORzET MBEGA1UEAwwKam9lQGJhbmFuYTCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA vDYFgMgxi5W488d9J7UpCInl0NXmZQpJDEHE4hvkaRlH7pnC71H0DLt0/3zATRP1 JzY2+eqBmbGl4/sgZKYv8UrLnNyQNUTsNx1iZAfPUflf5FwgVsai8BM0pUciq1NB xD429VFcrGZNucvFLh72RuRFIKH8WUpiK/iZNFkWhZ0CAwEAAaN3MHUwDgYDVR0P AQH/BAQDAgWgMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAMBgNVHRMB Af8EAjAAMBkGA1UdDgQSBBCVgnFBCWgL/iwCqnGrhTPQMBsGA1UdIwQUMBKAEKey Um2o4k2WiEVA0ldQvNYwDQYJKoZIhvcNAQELBQADgYEAYK986R4E3L1v+Q6esBtW JrUwA9UmJRSQr0N5w3o9XzarU37/bkjOP0Fw0k/A6Vv1n3vlciYfBFaBIam1qRHr 5dMsYf4CZS6w50r7hyzqyrwDoyNxkLnd2PdcHT/sym1QmflsjEs7pejtnohO6N2H wQW6M0H7Zt8claGRla4fKkg= -----END CERTIFICATE-----
+ },
+ "requestorId": "A String", # Immutable. Requestor ID to be used to register certificate with trawler
+ "validEndTime": "A String", # Output only. The timestamp after which certificate will expire
+ "validStartTime": "A String", # Output only. The timestamp after which certificate will be valid
+}
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates an cloud function project.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates an cloud function project.
+
+Args:
+ parent: string, Required. The project that the executed integration belongs to. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for Creating Cloud Function rpc call.
+ "functionName": "A String", # The function name of CF to be created
+ "functionRegion": "A String", # The function region of CF to be created
+ "projectId": "A String", # Indicates the id of the GCP project that the function will be created in.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for Creating Cloud Function rpc call.
+ "triggerUrl": "A String", # The trigger url that will be returned
+}
+
+ authConfigs()
+
Returns the authConfigs Resource.
+ +
+ certificates()
+
Returns the certificates Resource.
+ +
+ cloudFunctions()
+
Returns the cloudFunctions Resource.
+ +
+ integrations()
+
Returns the integrations Resource.
+ +
+ sfdcInstances()
+
Returns the sfdcInstances Resource.
+ +
+ close()
Close httplib2 connections.
+
+ createBundle(parent, body=None, x__xgafv=None)
PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Create a bundle.
+
+ listTaskEntities(parent, x__xgafv=None)
This is a UI only method and will be moved away. Returns a list of common tasks.
+close()
+ Close httplib2 connections.+
createBundle(parent, body=None, x__xgafv=None)
+ PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Create a bundle.
+
+Args:
+ parent: string, Required. The location resource of the request. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Request to create a new Bundle.
+ "bundleId": "A String", # Required. name of the bundle that will be created
+ "integrations": [ # A list of integrations that can be executed by the bundle
+ "A String",
+ ],
+ "secondaryCustomerOrgId": "A String", # Optional. The prefix for the SA, it should be in the format "o". This is an optional field, and if empty service account will be created per project, where we are creating bundle. This should only be used as the org ID for which we want to run the integrations in the bundle.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for create bundle.
+ "config": { # This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time. # It contains the bundle data
+ "integrations": [ # A bundle of integrations that can be executed by the task at runtime.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Output only. The service account created and owned by IP and added to the customers GCP project.
+ },
+ "triggerId": "A String", # trigger_id of the bundle task
+}
+listTaskEntities(parent, x__xgafv=None)
+ This is a UI only method and will be moved away. Returns a list of common tasks.
+
+Args:
+ parent: string, Required. The location resource of the request. This is not going to be used but preserve the field for future. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This is a UI only method and will be moved away. Response for ListTaskEntities.
+ "taskEntities": [ # The list of the tasks.
+ { # Contains a task's metadata and associated information. Next available id: 7
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ ],
+}
+
+ suspensions()
+
Returns the suspensions Resource.
+ +
+ cancel(name, body=None, x__xgafv=None)
Cancellation of an execution
+
+ close()
Close httplib2 connections.
+
+ download(name, x__xgafv=None)
Download the execution.
+ +Get an execution in the specified project.
+ +Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.
+ +Retrieves the next page of results.
+cancel(name, body=None, x__xgafv=None)
+ Cancellation of an execution
+
+Args:
+ name: string, Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for cancelling an execution.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for cancelling an execution.
+ "isCanceled": True or False, # True if cancellation performed successfully
+}
+close()
+ Close httplib2 connections.+
download(name, x__xgafv=None)
+ Download the execution.
+
+Args:
+ name: string, Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for downloading an execution.
+ "content": "A String", # The content of downloaded execution.
+}
+get(name, x__xgafv=None)
+ Get an execution in the specified project.
+
+Args:
+ name: string, Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The Execution resource contains detailed information of an individual integration execution.
+ "createTime": "A String", # Output only. Created time of the execution.
+ "directSubExecutions": [ # Direct sub executions of the following Execution.
+ # Object with schema name: GoogleCloudIntegrationsV1alphaExecution
+ ],
+ "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10 # The execution info about this event.
+ "eventAttemptStats": [
+ {
+ "endTime": "A String", # The end time of the event execution for current attempt.
+ "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "eventExecutionSnapshot": [
+ { # Contains the snapshot of the event execution for a given checkpoint. Next available id: 13
+ "checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
+ "conditionResults": [ # All of the computed conditions that been calculated.
+ { # Contains the combined condition calculation results.
+ "currentTaskNumber": "A String", # the current task number.
+ "nextTaskNumber": "A String", # the next task number.
+ "result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
+ },
+ ],
+ "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
+ "eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
+ "eventExecutionSnapshotMetadata": {
+ "eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
+ "taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
+ "taskName": "A String", # the task name associated with this snapshot. Could be empty.
+ "taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
+ },
+ "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "exceedMaxSize": True or False, # indicate whether snapshot exceeded maximum size before clean up
+ "snapshotTime": "A String", # Indicates when this snapshot is taken.
+ "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+ { # Contains the details of the execution of this task. Next available id: 11
+ "taskAttemptStats": [
+ {
+ "endTime": "A String", # The end time of the task execution for current attempt.
+ "startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "taskExecutionState": "A String",
+ "taskNumber": "A String", # Pointer to the task config it used for execution.
+ },
+ ],
+ "taskName": "A String", # The task name associated with this snapshot. Could be empty.
+ },
+ ],
+ "eventExecutionState": "A String",
+ "eventRetriesFromBeginningCount": 42, # Indicates the number of times the execution has restarted from the beginning.
+ "logFilePath": "A String", # The log file path (aka. cns address) for this event.
+ "networkAddress": "A String", # The network address (aka. bns address) that indicates where the event executor is running.
+ "nextExecutionTime": "A String", # Next scheduled execution time in case the execution status was RETRY_ON_HOLD.
+ "ryeLockUnheldCount": 42, # Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/
+ },
+ "executionDetails": { # Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics. # Detailed info of this execution.
+ "attemptStats": [ # List of Start and end time of the execution attempts.
+ { # Status for the execution attempt.
+ "endTime": "A String", # The end time of the event execution for current attempt.
+ "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "executionSnapshots": [ # List of snapshots taken during the execution.
+ { # Contains the snapshot of the execution for a given checkpoint.
+ "checkpointTaskNumber": "A String", # Indicates "after which checkpoint task's execution" this snapshot is taken.
+ "executionSnapshotMetadata": { # Metadata of the execution snapshot. # Metadata of the execution snapshot.
+ "executionAttempt": 42, # the execution attempt number this snapshot belongs to.
+ "task": "A String", # the task name associated with this snapshot.
+ "taskAttempt": 42, # the task attempt number this snapshot belongs to.
+ "taskNumber": "A String", # The task number associated with this snapshot.
+ },
+ "params": { # Parameters used during the execution.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+ { # Contains the details of the execution of this task.
+ "taskAttemptStats": [ # Status for the current task execution attempt.
+ { # Status for the execution attempt.
+ "endTime": "A String", # The end time of the event execution for current attempt.
+ "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "taskExecutionState": "A String", # The execution state of this task.
+ "taskNumber": "A String", # Pointer to the task config it used for execution.
+ },
+ ],
+ },
+ ],
+ "state": "A String", # Status of the execution.
+ },
+ "executionMethod": "A String", # The ways user posts this event.
+ "name": "A String", # Auto-generated primary key.
+ "requestParameters": { # Event parameters come in as part of the request.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "requestParams": [ # Event parameters come in as part of the request.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ "responseParameters": { # Event parameters returned as part of the response.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "responseParams": [ # Event parameters come out as part of the response.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ "triggerId": "A String", # The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
+ "updateTime": "A String", # Output only. Last modified time of the execution.
+}
+list(parent, filter=None, filterParams_customFilter=None, filterParams_endTime=None, filterParams_eventStatuses=None, filterParams_executionId=None, filterParams_parameterKey=None, filterParams_parameterPairKey=None, filterParams_parameterPairValue=None, filterParams_parameterType=None, filterParams_parameterValue=None, filterParams_startTime=None, filterParams_taskStatuses=None, filterParams_workflowName=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, refreshAcl=None, truncateParams=None, x__xgafv=None)
+ Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.
+
+Args:
+ parent: string, Required. The parent resource name of the integration execution. (required)
+ filter: string, Optional. Standard filter field, we support filtering on all fields in EventExecutionParamIndexes table. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterKey, ParameterValue, ParameterType support for HAS For example: "parameter_value" HAS \"parameter1\" Also supports operators like AND, OR, NOT For example, trigger_id=\"id1\" AND event_execution_state=\"FAILED\"
+ filterParams_customFilter: string, Optional user-provided custom filter.
+ filterParams_endTime: string, End timestamp.
+ filterParams_eventStatuses: string, List of possible event statuses. (repeated)
+ filterParams_executionId: string, Execution id.
+ filterParams_parameterKey: string, Param key. DEPRECATED. User parameter_pair_key instead.
+ filterParams_parameterPairKey: string, Param key in the key value pair filter.
+ filterParams_parameterPairValue: string, Param value in the key value pair filter.
+ filterParams_parameterType: string, Param type.
+ filterParams_parameterValue: string, Param value. DEPRECATED. User parameter_pair_value instead.
+ filterParams_startTime: string, Start timestamp.
+ filterParams_taskStatuses: string, List of possible task statuses. (repeated)
+ filterParams_workflowName: string, Workflow name.
+ orderBy: string, Optional. The results would be returned in order you specified here. Currently supporting "last_modified_time" and "create_time".
+ pageSize: integer, Optional. The size of entries in the response.
+ pageToken: string, Optional. The token returned in the previous response.
+ readMask: string, Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.
+ refreshAcl: boolean, Optional. If true, the service will use the most recent acl information to list event execution infos and renew the acl cache. Note that fetching the most recent acl is synchronous, so it will increase RPC call latency.
+ truncateParams: boolean, Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for listing the integration execution data.
+ "executionInfos": [ # Required. The detailed information of requested executions.
+ { # Contains all the execution details for a workflow instance. Next available id: 24
+ "clientId": "A String", # The event data user sends as request.
+ "createTime": "A String", # Auto-generated.
+ "errorCode": { # Registered ids for errors, as "oneof" enums. Each task or logical grouping of tasks may share the same enum. # Final error-code if event failed.
+ "commonErrorCode": "A String",
+ },
+ "errors": [ # Errors, warnings, and informationals associated with the workflow/task. The order in which the errors were added by the workflow/task is maintained.
+ { # An error, warning, or information message associated with a workflow.
+ "errorCode": { # Registered ids for errors, as "oneof" enums. Each task or logical grouping of tasks may share the same enum. # The associated error-code, which can be a common or internal code.
+ "commonErrorCode": "A String",
+ },
+ "errorMessage": "A String", # The full text of the error message, including any parameters that were thrown along with the exception.
+ "severity": "A String", # The severity of the error: ERROR|WARN|INFO.
+ "taskNumber": 42, # The task try-number, in which, the error occurred. If zero, the error happened at the event level.
+ },
+ ],
+ "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10 # The execution info about this event.
+ "eventAttemptStats": [
+ {
+ "endTime": "A String", # The end time of the event execution for current attempt.
+ "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "eventExecutionSnapshot": [ # After snapshot migration, this field will no longer be populated, but old execution snapshots will still be accessible.
+ {
+ "checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
+ "conditionResults": [ # All of the computed conditions that been calculated.
+ { # Contains the combined condition calculation results.
+ "currentTaskNumber": "A String", # the current task number.
+ "nextTaskNumber": "A String", # the next task number.
+ "result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
+ },
+ ],
+ "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
+ "eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
+ "eventExecutionSnapshotMetadata": {
+ "eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
+ "taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
+ "taskName": "A String", # the task name associated with this snapshot. Could be empty.
+ "taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
+ },
+ "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "snapshotTime": "A String", # Indicates when this snapshot is taken.
+ "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+ { # Contains the details of the execution of this task. Next available id: 11
+ "taskAttemptStats": [
+ {
+ "endTime": "A String", # The end time of the task execution for current attempt.
+ "startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "taskExecutionState": "A String",
+ "taskNumber": "A String", # Pointer to the task config it used for execution.
+ },
+ ],
+ "taskName": "A String", # The task name associated with this snapshot. Could be empty.
+ },
+ ],
+ "eventExecutionState": "A String", # The execution state of this event.
+ "eventRetriesFromBeginningCount": 42, # Indicates the number of times the execution has restarted from the beginning.
+ "logFilePath": "A String", # The log file path (aka. cns address) for this event.
+ "networkAddress": "A String", # The network address (aka. bns address) that indicates where the event executor is running.
+ "nextExecutionTime": "A String", # Next scheduled execution time in case the execution status was RETRY_ON_HOLD.
+ "ryeLockUnheldCount": 42, # Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/
+ },
+ "eventExecutionInfoId": "A String", # Auto-generated primary key.
+ "executionTraceInfo": { # Message that helps aggregate all sub-executions triggered by one execution and keeps track of child-parent relationships. # Execution trace info to aggregate parent-child executions.
+ "parentEventExecutionInfoId": "A String", # Parent event execution info id that triggers the current execution through SubWorkflowExecutorTask.
+ "traceId": "A String", # Used to aggregate ExecutionTraceInfo.
+ },
+ "lastModifiedTime": "A String", # Auto-generated.
+ "postMethod": "A String", # The ways user posts this event.
+ "product": "A String", # Which Google product the execution_info belongs to. If not set, the execution_info belongs to Integration Platform by default.
+ "requestId": "A String", # Optional. This is used to de-dup incoming request.
+ "requestParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Event parameters come in as part of the request.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "responseParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Event parameters come out as part of the response.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "snapshotNumber": "A String", # Workflow snapshot number.
+ "tenant": "A String", # Tenant this event is created. Used to reschedule the event to correct tenant.
+ "triggerId": "A String", # The trigger id of the workflow trigger config. If both trigger_id and client_id is present, the workflow is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
+ "workflowId": "A String", # Required. Pointer to the workflow it is executing.
+ "workflowName": "A String", # Name of the workflow.
+ "workflowRetryBackoffIntervalSeconds": "A String", # Time interval in seconds to schedule retry of workflow in manifold when workflow is already running
+ },
+ ],
+ "executions": [ # The detailed information of requested executions
+ { # The Execution resource contains detailed information of an individual integration execution.
+ "createTime": "A String", # Output only. Created time of the execution.
+ "directSubExecutions": [ # Direct sub executions of the following Execution.
+ # Object with schema name: GoogleCloudIntegrationsV1alphaExecution
+ ],
+ "eventExecutionDetails": { # Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10 # The execution info about this event.
+ "eventAttemptStats": [
+ {
+ "endTime": "A String", # The end time of the event execution for current attempt.
+ "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "eventExecutionSnapshot": [
+ { # Contains the snapshot of the event execution for a given checkpoint. Next available id: 13
+ "checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
+ "conditionResults": [ # All of the computed conditions that been calculated.
+ { # Contains the combined condition calculation results.
+ "currentTaskNumber": "A String", # the current task number.
+ "nextTaskNumber": "A String", # the next task number.
+ "result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
+ },
+ ],
+ "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
+ "eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
+ "eventExecutionSnapshotMetadata": {
+ "eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
+ "taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
+ "taskName": "A String", # the task name associated with this snapshot. Could be empty.
+ "taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
+ },
+ "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "exceedMaxSize": True or False, # indicate whether snapshot exceeded maximum size before clean up
+ "snapshotTime": "A String", # Indicates when this snapshot is taken.
+ "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+ { # Contains the details of the execution of this task. Next available id: 11
+ "taskAttemptStats": [
+ {
+ "endTime": "A String", # The end time of the task execution for current attempt.
+ "startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "taskExecutionState": "A String",
+ "taskNumber": "A String", # Pointer to the task config it used for execution.
+ },
+ ],
+ "taskName": "A String", # The task name associated with this snapshot. Could be empty.
+ },
+ ],
+ "eventExecutionState": "A String",
+ "eventRetriesFromBeginningCount": 42, # Indicates the number of times the execution has restarted from the beginning.
+ "logFilePath": "A String", # The log file path (aka. cns address) for this event.
+ "networkAddress": "A String", # The network address (aka. bns address) that indicates where the event executor is running.
+ "nextExecutionTime": "A String", # Next scheduled execution time in case the execution status was RETRY_ON_HOLD.
+ "ryeLockUnheldCount": 42, # Used internally and shouldn't be exposed to users. A counter for the cron job to record how many times this event is in in_process state but don't have a lock consecutively/
+ },
+ "executionDetails": { # Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics. # Detailed info of this execution.
+ "attemptStats": [ # List of Start and end time of the execution attempts.
+ { # Status for the execution attempt.
+ "endTime": "A String", # The end time of the event execution for current attempt.
+ "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "executionSnapshots": [ # List of snapshots taken during the execution.
+ { # Contains the snapshot of the execution for a given checkpoint.
+ "checkpointTaskNumber": "A String", # Indicates "after which checkpoint task's execution" this snapshot is taken.
+ "executionSnapshotMetadata": { # Metadata of the execution snapshot. # Metadata of the execution snapshot.
+ "executionAttempt": 42, # the execution attempt number this snapshot belongs to.
+ "task": "A String", # the task name associated with this snapshot.
+ "taskAttempt": 42, # the task attempt number this snapshot belongs to.
+ "taskNumber": "A String", # The task number associated with this snapshot.
+ },
+ "params": { # Parameters used during the execution.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+ { # Contains the details of the execution of this task.
+ "taskAttemptStats": [ # Status for the current task execution attempt.
+ { # Status for the execution attempt.
+ "endTime": "A String", # The end time of the event execution for current attempt.
+ "startTime": "A String", # The start time of the event execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "taskExecutionState": "A String", # The execution state of this task.
+ "taskNumber": "A String", # Pointer to the task config it used for execution.
+ },
+ ],
+ },
+ ],
+ "state": "A String", # Status of the execution.
+ },
+ "executionMethod": "A String", # The ways user posts this event.
+ "name": "A String", # Auto-generated primary key.
+ "requestParameters": { # Event parameters come in as part of the request.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "requestParams": [ # Event parameters come in as part of the request.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ "responseParameters": { # Event parameters returned as part of the response.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "responseParams": [ # Event parameters come out as part of the response.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ "triggerId": "A String", # The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
+ "updateTime": "A String", # Output only. Last modified time of the execution.
+ },
+ ],
+ "nextPageToken": "A String", # The token used to retrieve the next page results.
+}
+list_next()
+ 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. ++
+ close()
Close httplib2 connections.
+
+ lift(name, body=None, x__xgafv=None)
* Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
* Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
+ +Retrieves the next page of results.
+
+ resolve(name, body=None, x__xgafv=None)
* Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.
+close()
+ Close httplib2 connections.+
lift(name, body=None, x__xgafv=None)
+ * Lifts suspension for advanced suspension task. Fetch corresponding suspension with provided suspension Id, resolve suspension, and set up suspension result for the Suspension Task.
+
+Args:
+ name: string, Required. The resource that the suspension belongs to. "projects/{project}/locations/{location}/products/{product}/integrations/{integration}/executions/{execution}/suspensions/{suspenion}" format. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for lift Suspension
+ "suspensionResult": "A String", # User passed in suspension result and will be used to control workflow execution branching behavior by setting up corresponnding edge condition with suspension result. For example, if you want to lift the suspension, you can pass "Approved", or if you want to reject the suspension and terminate workfloe execution, you can pass "Rejected" and terminate the workflow execution with configuring the edge condition.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response of lift Suspense
+ "eventExecutionInfoId": "A String", # Execution Id that will be returned
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ * Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.
+
+Args:
+ parent: string, Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name} (required)
+ filter: string, Standard filter field.
+ orderBy: string, Field name to order by.
+ pageSize: integer, Maximum number of entries in the response.
+ pageToken: string, Token to retrieve a specific page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for Suspensions.ListSuspensions.
+ "nextPageToken": "A String", # Token to retrieve the next page of results.
+ "suspensions": [ # The suspensions for the relevant execution which the caller has permissions to view and resolve.
+ { # A record representing a suspension.
+ "approvalConfig": { # Configurations for approving the Suspension. # Controls the notifications and approval permissions for this suspension.
+ "customMessage": "A String", # Information to provide for recipients.
+ "emailAddresses": [ # Email addresses to send approval request to.
+ "A String",
+ ],
+ "expiration": { # Expiration configs for the approval request. # Indicates the next steps when no external actions happen on the suspension.
+ "expireTime": "A String", # Output only. Time after which the suspension expires, if no action taken.
+ "liftWhenExpired": True or False, # Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.
+ "remindTime": "A String", # Time after the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.
+ },
+ },
+ "audit": { # Contains when and by whom the suspension was resolved. # Metadata pertaining to the resolution of this suspension.
+ "resolveTime": "A String", # Time at which this suspension was resolved.
+ "resolver": "A String", # Email address of the person who resolved this suspension.
+ },
+ "createTime": "A String", # Output only. Auto-generated.
+ "eventExecutionInfoId": "A String", # Required. ID of the associated execution.
+ "integration": "A String", # Required. The name of the originating integration.
+ "lastModifyTime": "A String", # Output only. Auto-generated.
+ "name": "A String", # Resource name for suspensions suspension/{suspension_id}
+ "state": "A String", # Required. State of this suspension, indicating what action a resolver has taken.
+ "suspensionConfig": { # Controls the notifications and resolver permissions for this suspension.
+ "customMessage": "A String", # Optional information to provide recipients of the suspension in addition to the resolution URL, typically containing relevant parameter values from the originating workflow.
+ "notifications": [
+ {
+ "buganizerNotification": {
+ "assigneeEmailAddress": "A String", # Whom to assign the new bug. Optional.
+ "componentId": "A String", # ID of the buganizer component within which to create a new issue. Required.
+ "templateId": "A String", # ID of the buganizer template to use. Optional.
+ "title": "A String", # Title of the issue to be created. Required.
+ },
+ "emailAddress": { # Email address along with optional name and tokens. These tokens will be substituted for the variables in the form of [{var_name}], where var_name could be any string of no more than 32 bytes.
+ "email": "A String", # Required.
+ "name": "A String",
+ "tokens": [
+ {
+ "name": "A String",
+ "value": "A String",
+ },
+ ],
+ },
+ "escalatorQueue": "A String",
+ "pubsubTopic": "A String",
+ "request": { # If the out-of-the-box email/pubsub notifications are not suitable and custom logic is required, fire a workflow containing all info needed to notify users to resume execution.
+ "postToQueueWithTriggerIdRequest": { # Use this request to post all workflows associated with a given trigger id. Next available id: 10 # Request to fire an event containing the SuspensionInfo message.
+ "clientId": "A String", # Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the {@link TriggerConfig}. For Api Trigger, the client id is required and will be validated against the allowed clients.
+ "ignoreErrorIfNoActiveWorkflow": True or False, # Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested trigger_id or client_id is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each workflow execution. Optional.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "priority": "A String", # The request priority this request should be processed at. For internal users:
+ "requestId": "A String", # Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned. Must have no more than 36 characters and contain only alphanumeric characters and hyphens.
+ "scheduledTime": "A String", # Optional. Time in milliseconds since epoch when the given event would be scheduled.
+ "testMode": True or False, # Optional. Sets test mode in {@link enterprise/crm/eventbus/event_message.proto}.
+ "triggerId": "A String", # Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required.
+ "workflowName": "A String", # Optional. If provided, the workflow_name is used to filter all the matched workflows having same trigger_id+client_id. A combination of trigger_id, client_id and workflow_name identifies a unique workflow.
+ },
+ "suspensionInfoEventParameterKey": "A String", # In the fired event, set the SuspensionInfo message as the value for this key.
+ },
+ },
+ ],
+ "suspensionExpiration": { # Indicates the next steps when no external actions happen on the suspension.
+ "expireAfterMs": 42, # Milliseconds after which the suspension expires, if no action taken.
+ "liftWhenExpired": True or False, # Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.
+ "remindAfterMs": 42, # Milliseconds after which the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.
+ },
+ "whoMayResolve": [ # Identities able to resolve this suspension.
+ { # LINT.IfChange
+ "gaiaIdentity": { # Represents a Gaia identity for a person or service account.
+ "emailAddress": "A String",
+ "gaiaId": "A String",
+ },
+ "googleGroup": {
+ "emailAddress": "A String",
+ "gaiaId": "A String",
+ },
+ "loasRole": "A String",
+ "mdbGroup": "A String",
+ },
+ ],
+ },
+ "taskId": "A String", # Required. Task id of the associated SuspensionTask.
+ },
+ ],
+}
+list_next()
+ 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. ++
resolve(name, body=None, x__xgafv=None)
+ * Resolves (lifts/rejects) any number of suspensions. If the integration is already running, only the status of the suspension is updated. Otherwise, the suspended integration will begin execution again.
+
+Args:
+ name: string, Required. projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_name}/executions/{execution_name}/suspensions/{suspension_id} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for [Suspensions.ResolveSuspensions].
+ "suspension": { # A record representing a suspension. # Suspension, containing the event_execution_info_id, task_id, and state to set on the corresponding suspension record.
+ "approvalConfig": { # Configurations for approving the Suspension. # Controls the notifications and approval permissions for this suspension.
+ "customMessage": "A String", # Information to provide for recipients.
+ "emailAddresses": [ # Email addresses to send approval request to.
+ "A String",
+ ],
+ "expiration": { # Expiration configs for the approval request. # Indicates the next steps when no external actions happen on the suspension.
+ "expireTime": "A String", # Output only. Time after which the suspension expires, if no action taken.
+ "liftWhenExpired": True or False, # Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.
+ "remindTime": "A String", # Time after the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.
+ },
+ },
+ "audit": { # Contains when and by whom the suspension was resolved. # Metadata pertaining to the resolution of this suspension.
+ "resolveTime": "A String", # Time at which this suspension was resolved.
+ "resolver": "A String", # Email address of the person who resolved this suspension.
+ },
+ "createTime": "A String", # Output only. Auto-generated.
+ "eventExecutionInfoId": "A String", # Required. ID of the associated execution.
+ "integration": "A String", # Required. The name of the originating integration.
+ "lastModifyTime": "A String", # Output only. Auto-generated.
+ "name": "A String", # Resource name for suspensions suspension/{suspension_id}
+ "state": "A String", # Required. State of this suspension, indicating what action a resolver has taken.
+ "suspensionConfig": { # Controls the notifications and resolver permissions for this suspension.
+ "customMessage": "A String", # Optional information to provide recipients of the suspension in addition to the resolution URL, typically containing relevant parameter values from the originating workflow.
+ "notifications": [
+ {
+ "buganizerNotification": {
+ "assigneeEmailAddress": "A String", # Whom to assign the new bug. Optional.
+ "componentId": "A String", # ID of the buganizer component within which to create a new issue. Required.
+ "templateId": "A String", # ID of the buganizer template to use. Optional.
+ "title": "A String", # Title of the issue to be created. Required.
+ },
+ "emailAddress": { # Email address along with optional name and tokens. These tokens will be substituted for the variables in the form of [{var_name}], where var_name could be any string of no more than 32 bytes.
+ "email": "A String", # Required.
+ "name": "A String",
+ "tokens": [
+ {
+ "name": "A String",
+ "value": "A String",
+ },
+ ],
+ },
+ "escalatorQueue": "A String",
+ "pubsubTopic": "A String",
+ "request": { # If the out-of-the-box email/pubsub notifications are not suitable and custom logic is required, fire a workflow containing all info needed to notify users to resume execution.
+ "postToQueueWithTriggerIdRequest": { # Use this request to post all workflows associated with a given trigger id. Next available id: 10 # Request to fire an event containing the SuspensionInfo message.
+ "clientId": "A String", # Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the {@link TriggerConfig}. For Api Trigger, the client id is required and will be validated against the allowed clients.
+ "ignoreErrorIfNoActiveWorkflow": True or False, # Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested trigger_id or client_id is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each workflow execution. Optional.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "priority": "A String", # The request priority this request should be processed at. For internal users:
+ "requestId": "A String", # Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned. Must have no more than 36 characters and contain only alphanumeric characters and hyphens.
+ "scheduledTime": "A String", # Optional. Time in milliseconds since epoch when the given event would be scheduled.
+ "testMode": True or False, # Optional. Sets test mode in {@link enterprise/crm/eventbus/event_message.proto}.
+ "triggerId": "A String", # Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required.
+ "workflowName": "A String", # Optional. If provided, the workflow_name is used to filter all the matched workflows having same trigger_id+client_id. A combination of trigger_id, client_id and workflow_name identifies a unique workflow.
+ },
+ "suspensionInfoEventParameterKey": "A String", # In the fired event, set the SuspensionInfo message as the value for this key.
+ },
+ },
+ ],
+ "suspensionExpiration": { # Indicates the next steps when no external actions happen on the suspension.
+ "expireAfterMs": 42, # Milliseconds after which the suspension expires, if no action taken.
+ "liftWhenExpired": True or False, # Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.
+ "remindAfterMs": 42, # Milliseconds after which the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.
+ },
+ "whoMayResolve": [ # Identities able to resolve this suspension.
+ { # LINT.IfChange
+ "gaiaIdentity": { # Represents a Gaia identity for a person or service account.
+ "emailAddress": "A String",
+ "gaiaId": "A String",
+ },
+ "googleGroup": {
+ "emailAddress": "A String",
+ "gaiaId": "A String",
+ },
+ "loasRole": "A String",
+ "mdbGroup": "A String",
+ },
+ ],
+ },
+ "taskId": "A String", # Required. Task id of the associated SuspensionTask.
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for Suspensions.ResolveSuspensions.
+}
+
+ close()
Close httplib2 connections.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists the snapshots of a given integration executions. This RPC is not being used.
+ +Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
+ Lists the snapshots of a given integration executions. This RPC is not being used.
+
+Args:
+ parent: string, Required. The parent resource name of the integration execution. (required)
+ filter: string, Currently supports filter by `execution_info_id` or `execution_snapshot_id`.
+ pageSize: integer, Number of entries to be returned in a page.
+ pageToken: string, The token used to retrieve the next page results.
+ readMask: string, View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution snapshot will be filled and returned.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for listing the integration execution snapshot.
+ "executionSnapshots": [ # Required. The detailed information for the execution snapshot.
+ { # Contains the snapshot of the event execution for a given checkpoint. Next available id: 13
+ "checkpointTaskNumber": "A String", # Indicates "right after which checkpoint task's execution" this snapshot is taken.
+ "conditionResults": [ # All of the computed conditions that been calculated.
+ { # Contains the combined condition calculation results.
+ "currentTaskNumber": "A String", # the current task number.
+ "nextTaskNumber": "A String", # the next task number.
+ "result": True or False, # the result comes out after evaluate the combined condition. True if there's no combined condition specified.
+ },
+ ],
+ "diffParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object that differs from last snapshot.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "eventExecutionInfoId": "A String", # Points to the event execution info this snapshot belongs to.
+ "eventExecutionSnapshotId": "A String", # Auto-generated. Used as primary key for EventExecutionSnapshots table.
+ "eventExecutionSnapshotMetadata": {
+ "eventAttemptNum": 42, # the event attempt number this snapshot belongs to.
+ "taskAttemptNum": 42, # the task attempt number this snapshot belongs to. Could be empty.
+ "taskName": "A String", # the task name associated with this snapshot. Could be empty.
+ "taskNumber": "A String", # The task number associated with this snapshot. Could be empty.
+ },
+ "eventParams": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters in Event object.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "exceedMaxSize": True or False, # indicate whether snapshot exceeded maximum size before clean up
+ "snapshotTime": "A String", # Indicates when this snapshot is taken.
+ "taskExecutionDetails": [ # All of the task execution details at the given point of time.
+ { # Contains the details of the execution of this task. Next available id: 11
+ "taskAttemptStats": [
+ {
+ "endTime": "A String", # The end time of the task execution for current attempt.
+ "startTime": "A String", # The start time of the task execution for current attempt. This could be in the future if it's been scheduled.
+ },
+ ],
+ "taskExecutionState": "A String",
+ "taskNumber": "A String", # Pointer to the task config it used for execution.
+ },
+ ],
+ "taskName": "A String", # The task name associated with this snapshot. Could be empty.
+ },
+ ],
+ "nextPageToken": "A String", # The token returned in the previous response.
+}
+list_next()
+ 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. ++
+ executions()
+
Returns the executions Resource.
+ + +Returns the executionsnapshots Resource.
+ +
+ versions()
+
Returns the versions Resource.
+ +
+ archiveBundle(name, body=None, x__xgafv=None)
PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Soft-deletes the bundle.
+
+ close()
Close httplib2 connections.
+
+ execute(name, body=None, x__xgafv=None)
Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Returns the list of all integrations in the specified project.
+ +Retrieves the next page of results.
+
+ monitorexecutionstats(parent, body=None, x__xgafv=None)
Get execution stats
+
+ schedule(name, body=None, x__xgafv=None)
Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
+
+ test(name, body=None, x__xgafv=None)
Execute the integration in draft state
+archiveBundle(name, body=None, x__xgafv=None)
+ PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Soft-deletes the bundle.
+
+Args:
+ name: string, Required. The bundle to archive. Format: projects/{project}/locations/{location}/integrations/{integration} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for ArchiveBundle.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for ArchiveBundle.
+}
+close()
+ Close httplib2 connections.+
execute(name, body=None, x__xgafv=None)
+ Executes integrations synchronously by passing the trigger id in the request body. The request is not returned until the requested executions are either fulfilled or experienced an error. If the integration name is not specified (passing `-`), all of the associated integration under the given trigger_id will be executed. Otherwise only the specified integration for the given `trigger_id` is executed. This is helpful for execution the integration from UI.
+
+Args:
+ name: string, Required. The integration resource name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request for executing an integration.
+ "doNotPropagateError": True or False, # Optional. Flag to determine how to should propagate errors. If this flag is set to be true, it will not throw an exception. Instead, it will return a {@link ExecuteIntegrationsResponse} with an execution id and error messages as PostWithTriggerIdExecutionException in {@link EventParameters}. The flag is set to be false by default.
+ "executionId": "A String", # Optional. The id of the ON_HOLD execution to be resumed.
+ "inputParameters": { # Optional. Input parameters used by integration execution.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "parameterEntries": [ # Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. Passed in as parameters to each integration execution. Redacted
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "requestId": "A String", # Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
+ "triggerId": "A String", # Required. Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id). The trigger_id is in the format of `api_trigger/TRIGGER_NAME`.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response for executing an integration.
+ "eventParameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Details for the integration that were executed.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "executionFailed": True or False, # Is true if any execution in the integration failed. False otherwise.
+ "executionId": "A String", # The id of the execution corresponding to this run of integration.
+ "outputParameters": { # OUTPUT parameters in format of Map. Where Key is the name of the parameter. Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.
+ "a_key": "", # Properties of the object.
+ },
+ "parameterEntries": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Returns the list of all integrations in the specified project.
+
+Args:
+ parent: string, Required. Project and location from which the integrations should be listed. Format: projects/{project} (required)
+ filter: string, Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
+ orderBy: string, The results would be returned in order you specified here. Supported sort keys are: Descending sort order by "last_modified_time", "created_time", "snapshot_number". Ascending sort order by the integration name.
+ pageSize: integer, The page size for the resquest.
+ pageToken: string, The page token for the resquest.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for ListIntegrations.
+ "integrations": [ # The integrations which match the request.
+ { # The integration definition.
+ "active": True or False, # Required. If any integration version is published.
+ "description": "A String", # Optional.
+ "name": "A String", # Required. The resource name of the integration.
+ "updateTime": "A String", # Output only. Auto-generated.
+ },
+ ],
+ "nextPageToken": "A String", # The next page token for the response.
+}
+list_next()
+ 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. ++
monitorexecutionstats(parent, body=None, x__xgafv=None)
+ Get execution stats
+
+Args:
+ parent: string, Required. The parent resource name: {parent=projects/*/locations/*}. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request to get data for monarch connector config.
+ "duration": "A String", # How long the series data range: "1h","1d",etc.
+ "endTime": "A String", # Final time to query over, or the current time if left unset.
+ "mashQuery": { # The MashQuery for searching data, set both queries for Join Operation. # Required. Query for searching data in monarch.
+ "firstQuery": { # The components for constructing MashQuery. # Required. The components for constructing a mash query. Set "point_operation" if this is a single query
+ "borgTaskMetric": "A String", # Required. The metric for monarch.BorgTask.
+ "dataFilters": [ # Optional. optional, filters on fetched data, "metric:client_id" not supported.
+ "A String",
+ ],
+ "fetchFilters": [ # Optional. optional, filters for Fetch Raw, "metric:client_id" not supported.
+ "A String",
+ ],
+ "groupBy": { # MashQuery GroupBy parameters. # Optional. optional, GroupBy variables.
+ "fields": [ # Optional. optional, metrics list for GroupBy.
+ "A String",
+ ],
+ "reducer": "A String", # Optional. optional, reduce function for GroupBy.
+ },
+ "pointOperation": "A String", # Optional. optional, Point Operation on single query or joined query.
+ "timeDelta": "A String", # Required. Window time delta.
+ },
+ "operationMode": { # Operation between 2 query # Optional. optional, only set when joining 2 queries. By default join 2 queries with join operation.
+ "joinConfig": { # Join Operation # Optional. join operation
+ },
+ "operationType": "A String", # Optional. optional operation types.
+ "unionConfig": { # Union operation # Optional. union operation
+ "reducer": "A String", # Optional. optional, reduce function
+ },
+ },
+ "secondQuery": { # The components for constructing MashQuery. # Optional. optional, only set when joining 2 queries. Set "point_operation" for joined query.
+ "borgTaskMetric": "A String", # Required. The metric for monarch.BorgTask.
+ "dataFilters": [ # Optional. optional, filters on fetched data, "metric:client_id" not supported.
+ "A String",
+ ],
+ "fetchFilters": [ # Optional. optional, filters for Fetch Raw, "metric:client_id" not supported.
+ "A String",
+ ],
+ "groupBy": { # MashQuery GroupBy parameters. # Optional. optional, GroupBy variables.
+ "fields": [ # Optional. optional, metrics list for GroupBy.
+ "A String",
+ ],
+ "reducer": "A String", # Optional. optional, reduce function for GroupBy.
+ },
+ "pointOperation": "A String", # Optional. optional, Point Operation on single query or joined query.
+ "timeDelta": "A String", # Required. Window time delta.
+ },
+ },
+ "metricFieldTable": True or False, # Returns a table of all possible metric field values within the specified duration, ignoring any data samples. Useful for autocomplete functionality.
+ "outputPeriod": "A String", # The output period for the query. Must be set if there is a window operation within the query and unset otherwise.
+ "responseTemplate": "A String", # Required. Template for response.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response for getting Execution stats.
+ "aplosSeriesListData": { # Data used for Aplos charts that accept multiple Series. # List of points.
+ "series": [
+ {
+ "data": { # Data used to render an Aplos Series card.
+ "rows": [ # A single Series Row
+ { # Aplos series row is exactly two columns labeled x and y.
+ "x": {
+ "booleanValue": True or False,
+ "doubleValue": 3.14,
+ "empty": { # 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); }
+ },
+ "longValue": "A String",
+ "stringValue": "A String",
+ },
+ "y": {
+ "booleanValue": True or False,
+ "doubleValue": 3.14,
+ "empty": { # 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); }
+ },
+ "longValue": "A String",
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "name": "A String",
+ },
+ ],
+ },
+ "tableData": { # The generic data format returned from all connectors. # Data in form of table.
+ "headers": [ # Ordered list of column headers.
+ "A String",
+ ],
+ "rows": [ # Ordered list of table rows.
+ {
+ "cells": [ # Ordered list of cell values within a row.
+ {
+ "booleanValue": True or False,
+ "doubleValue": 3.14,
+ "empty": { # 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); }
+ },
+ "longValue": "A String",
+ "stringValue": "A String",
+ },
+ ],
+ },
+ ],
+ },
+}
+schedule(name, body=None, x__xgafv=None)
+ Schedules an integration for execution by passing the trigger id and the scheduled time in the request body.
+
+Args:
+ name: string, The integration resource name. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request for scheduling an integration.
+ "inputParameters": { # Optional. Input parameters used by integration execution.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "parameterEntries": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Passed in as parameters to each integration execution.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "requestId": "A String", # This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
+ "scheduleTime": "A String", # The time that the integration should be executed. If the time is less or equal to the current time, the integration is executed immediately.
+ "triggerId": "A String", # Matched against all {@link TriggerConfig}s across all integrations. i.e. TriggerConfig.trigger_id.equals(trigger_id)
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response for executing an integration.
+ "executionInfoIds": [ # The execution info id for the executed integrations.
+ "A String",
+ ],
+}
+test(name, body=None, x__xgafv=None)
+ Execute the integration in draft state
+
+Args:
+ name: string, Output only. Auto-generated primary key. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request for testing an integration.
+ "clientId": "A String", # Required. This is used to identify the client on whose behalf the event will be executed.
+ "deadlineSecondsTime": "A String", # Optional. custom deadline of the rpc
+ "inputParameters": { # Optional. Input parameters used during integration execution.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ "integrationVersion": { # The integration version definition. # Required. integration config to execute the workflow
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. Passed in as parameters to each integration execution.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "testMode": True or False, # Optional. Can be specified in the event request, otherwise false (default). If true, enables tasks with condition "test_mode = true". If false, disables tasks with condition "test_mode = true" if global test mode (set by platform) is also false {@link EventBusConfig}.
+ "triggerId": "A String", # Required. The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response for testing an integration.
+ "eventParameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Details for the integration that were executed.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "executionFailed": True or False, # Is true if any execution in the integration failed. False otherwise.
+ "executionId": "A String", # The id of the execution corresponding to this run of integration.
+ "parameterEntries": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ "parameters": { # Optional. Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ "a_key": { # The type of the parameter.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+}
+
+ archive(name, body=None, x__xgafv=None)
Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, newIntegration=None, x__xgafv=None)
Create a integration with a draft version in the specified project.
+
+ deactivate(name, body=None, x__xgafv=None)
Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
+ +Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.
+
+ download(name, fileFormat=None, x__xgafv=None)
Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.
+ +Get a integration in the specified project.
+
+ getBundle(name, x__xgafv=None)
PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to get details of the Bundle
+ +Returns the list of all integration versions in the specified project.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Update a integration with a draft version in the specified project.
+
+ publish(name, body=None, x__xgafv=None)
This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.
+
+ takeoverEditLock(integrationVersion, body=None, x__xgafv=None)
Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the `locked_by` and `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.
+
+ unpublish(name, body=None, x__xgafv=None)
Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
+
+ updateBundle(name, body=None, x__xgafv=None)
THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to update the Bundle
+
+ upload(parent, body=None, x__xgafv=None)
Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.
+
+ validate(name, body=None, x__xgafv=None)
Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.
+archive(name, body=None, x__xgafv=None)
+ Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being archived is DRAFT, and if the `locked_by` user is not the same as the user performing the Archive. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Archiving a integration. Currently, there is no unarchive mechanism.
+
+Args:
+ name: string, Required. The version to archive. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for ArchiveIntegrationVersion.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for ArchiveIntegrationVersion.
+}
+close()
+ Close httplib2 connections.+
create(parent, body=None, newIntegration=None, x__xgafv=None)
+ Create a integration with a draft version in the specified project.
+
+Args:
+ parent: string, Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The integration version definition.
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+ newIntegration: boolean, Set this flag to true, if draft version is to be created for a brand new integration. False, if the request is for an existing integration. For backward compatibility reasons, even if this flag is set to `false` and no existing integration is found, a new draft integration will still be created.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The integration version definition.
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+deactivate(name, body=None, x__xgafv=None)
+ Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
+
+Args:
+ name: string, Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for DeactivateIntegrationVersion.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for DeactivateIntegrationVersion.
+}
+delete(name, x__xgafv=None)
+ Soft-deletes the integration. Changes the status of the integration to ARCHIVED. If the integration being ARCHIVED is tagged as "HEAD", the tag is removed from this snapshot and set to the previous non-ARCHIVED snapshot. The PUBLISH_REQUESTED, DUE_FOR_DELETION tags are removed too. This RPC throws an exception if the version being deleted is DRAFT, and if the `locked_by` user is not the same as the user performing the Delete. Audit fields updated include last_modified_timestamp, last_modified_by. Any existing lock is released when Deleting a integration. Currently, there is no undelete mechanism.
+
+Args:
+ name: string, Required. The version to delete. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+download(name, fileFormat=None, x__xgafv=None)
+ Downloads an integration. Retrieves the `IntegrationVersion` for a given `integration_id` and returns the response as a string.
+
+Args:
+ name: string, Required. The version to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ fileFormat: string, File format for download request.
+ Allowed values
+ FILE_FORMAT_UNSPECIFIED - Unspecified file format
+ JSON - JSON File Format
+ YAML - YAML File Format
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for DownloadIntegrationVersion.
+ "content": "A String", # String representation of the integration version.
+}
+get(name, x__xgafv=None)
+ Get a integration in the specified project.
+
+Args:
+ name: string, Required. The version to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The integration version definition.
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+getBundle(name, x__xgafv=None)
+ PROTECT WITH A VISIBILITY LABEL. THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to get details of the Bundle
+
+Args:
+ name: string, Required. The bundle name. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for GetBundle.
+ "config": { # This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time. # It contains the bundle data
+ "integrations": [ # A bundle of integrations that can be executed by the task at runtime.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Output only. The service account created and owned by IP and added to the customers GCP project.
+ },
+}
+list(parent, fieldMask=None, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Returns the list of all integration versions in the specified project.
+
+Args:
+ parent: string, Required. The parent resource where this version will be created. Format: projects/{project}/locations/{location}/integrations/{integration} Specifically, when parent equals: 1. projects//locations//integrations/, Meaning: "List versions (with filter) for a particular integration". 2. projects//locations//integrations/- Meaning: "List versions (with filter) for a client within a particular region". 3. projects//locations/-/integrations/- Meaning: "List versions (with filter) for a client". (required)
+ fieldMask: string, The field mask which specifies the particular data to be returned.
+ filter: string, Filter on fields of IntegrationVersion. Fields can be compared with literal values by use of ":" (containment), "=" (equality), ">" (greater), "<" (less than), >=" (greater than or equal to), "<=" (less than or equal to), and "!=" (inequality) operators. Negation, conjunction, and disjunction are written using NOT, AND, and OR keywords. For example, organization_id=\"1\" AND state=ACTIVE AND description:"test". Filtering cannot be performed on repeated fields like `task_config`.
+ orderBy: string, The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for "last_modified_time", "created_time", "snapshot_number" Ascending sort order for "name".
+ pageSize: integer, The maximum number of versions to return. The service may return fewer than this value. If unspecified, at most 50 versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, A page token, received from a previous `ListIntegrationVersions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIntegrationVersions` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for ListIntegrationVersions.
+ "integrationVersions": [ # The integrations which match the request.
+ { # The integration version definition.
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+ },
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ "noPermission": True or False, # Whether the user has no permission on the version or not.
+}
+list_next()
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Update a integration with a draft version in the specified project.
+
+Args:
+ name: string, Output only. Auto-generated primary key. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The integration version definition.
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+
+ updateMask: string, Field mask specifying the fields in the above integration that have been modified and need to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The integration version definition.
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+}
+publish(name, body=None, x__xgafv=None)
+ This RPC throws an exception if the integration is in ARCHIVED or ACTIVE state. This RPC throws an exception if the version being published is DRAFT, and if the `locked_by` user is not the same as the user performing the Publish. Audit fields updated include last_published_timestamp, last_published_by, last_modified_timestamp, last_modified_by. Any existing lock is on this integration is released.
+
+Args:
+ name: string, Required. The version to publish. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for PublishIntegrationVersion.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for PublishIntegrationVersion.
+}
+takeoverEditLock(integrationVersion, body=None, x__xgafv=None)
+ Clears the `locked_by` and `locked_at_timestamp`in the DRAFT version of this integration. It then performs the same action as the CreateDraftIntegrationVersion (i.e., copies the DRAFT version of the integration as a SNAPSHOT and then creates a new DRAFT version with the `locked_by` set to the `user_taking_over` and the `locked_at_timestamp` set to the current timestamp). Both the `locked_by` and `user_taking_over` are notified via email about the takeover. This RPC throws an exception if the integration is not in DRAFT status or if the `locked_by` and `locked_at_timestamp` fields are not set.The TakeoverEdit lock is treated the same as an edit of the integration, and hence shares ACLs with edit. Audit fields updated include last_modified_timestamp, last_modified_by.
+
+Args:
+ integrationVersion: string, Required. The version to take over edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for TakeoverEditLock.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for TakeoverEditLock.
+ "integrationVersion": { # The integration version definition. # Version after the lock is acquired by the new user.
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+ },
+}
+unpublish(name, body=None, x__xgafv=None)
+ Sets the status of the ACTIVE integration to SNAPSHOT with a new tag "PREVIOUSLY_PUBLISHED" after validating it. The "HEAD" and "PUBLISH_REQUESTED" tags do not change. This RPC throws an exception if the version being snapshot is not ACTIVE. Audit fields added include action, action_by, action_timestamp.
+
+Args:
+ name: string, Required. The version to deactivate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for UnpublishIntegrationVersion.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+updateBundle(name, body=None, x__xgafv=None)
+ THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. RPC to update the Bundle
+
+Args:
+ name: string, Required. Bundle name (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # THIS METHOD WILL BE MOVED TO A SEPARATE SERVICE. Request message for Bundle update
+ "config": { # This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time. # It contains the updated bundle data
+ "integrations": [ # A bundle of integrations that can be executed by the task at runtime.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Output only. The service account created and owned by IP and added to the customers GCP project.
+ },
+}
+
+ 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 Bundle update
+ "config": { # This proto holds the core runner data in the bundle task. It is not expected to be directly edited by the user. Instead, a default value will be provided at the task creation time. # Contains updated bundle config
+ "integrations": [ # A bundle of integrations that can be executed by the task at runtime.
+ "A String",
+ ],
+ "serviceAccount": "A String", # Output only. The service account created and owned by IP and added to the customers GCP project.
+ },
+}
+upload(parent, body=None, x__xgafv=None)
+ Uploads an integration. The content can be a previously downloaded integration. Performs the same function as CreateDraftIntegrationVersion, but accepts input in a string format, which holds the complete representation of the IntegrationVersion content.
+
+Args:
+ parent: string, Required. The version to upload. Format: projects/{project}/locations/{location}/integrations/{integration} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for UploadIntegrationVersion.
+ "content": "A String", # The textproto of the integration_version.
+ "fileFormat": "A String", # File format for upload request.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for UploadIntegrationVersion.
+ "integrationVersion": { # The integration version definition. # The uploaded integration.
+ "createTime": "A String", # Output only. Auto-generated.
+ "databasePersistencePolicy": "A String", # Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index.
+ "description": "A String", # Optional. The integration description.
+ "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+ "dataType": "A String", # Type of the parameter.
+ "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter.
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "searchable": True or False, # Searchable in the execution log or not.
+ },
+ ],
+ "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+ "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution.
+ {
+ "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see go/integration-platform/event_bus/attributes_registry.md. Next available: 8 # Metadata information about the parameters.
+ "dataType": "A String", # Things like URL, Email, Currency, Timestamp (rather than string, int64...)
+ "defaultValue": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Used to define defaults.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isRequired": True or False, # Required for event execution. The validation will be done by the event bus when the event is triggered.
+ "isSearchable": True or False, # Used to indicate if a ParameterEntry should be converted to ParamIndexes for ST-Spanner full-text search. DEPRECATED: use searchable.
+ "logSettings": { # The LogSettings define the logging attributes for an event property. These attributes are used to map the property to the parameter in the log proto. Also used to define scrubbing/truncation behavior and PII information. See go/integration-platform/analytics/logging_task.md for details. # See go/integration-platform/analytics/logging_task.md for details.
+ "logFieldName": "A String", # The name of corresponding logging field of the event property. If omitted, assumes the same name as the event property key.
+ "sanitizeOptions": { # Identifies whether a field contains, or may contain, PII or sensitive data, and how to sanitize the field if it does. If a field's privacy type cannot be determined then it is sanitized (e.g., scrubbed). The specific sanitizer implementation is determined by run-time configuration and environment options (e.g., prod vs. qa). next_id: 5 # Contains the scrubbing options, such as whether to scrub, obfuscate, etc.
+ "isAlreadySanitized": True or False, # If true, the value has already been sanitized and needs no further sanitization. For instance, a D3 customer id is already an obfuscated entity and *might not* need further sanitization.
+ "logType": [ # To which type(s) of logs the sanitize options apply.
+ "A String",
+ ],
+ "privacy": "A String",
+ "sanitizeType": "A String",
+ },
+ "seedPeriod": "A String",
+ "seedScope": "A String",
+ "shorteningLimits": { # Describes string and array limits when writing to logs. When a limit is exceeded the *shortener_type* describes how to shorten the field. next_id: 6 # Contains the field limits for shortening, such as max string length and max array length.
+ "logAction": "A String",
+ "logType": [ # To which type(s) of logs the limits apply.
+ "A String",
+ ],
+ "maxArraySize": 42, # maximum array size. If the array exceds this size, the field (list) is truncated.
+ "maxStringLength": 42, # maximum string length. If the field exceeds this amount the field is shortened.
+ "shortenerType": "A String",
+ },
+ },
+ "searchable": "A String",
+ "taskVisibility": [ # List of tasks that can view this property, if empty then all.
+ "A String",
+ ],
+ },
+ "children": [ # Child parameters nested within this parameter. This field only applies to protobuf parameters
+ # Object with schema name: EnterpriseCrmFrontendsEventbusProtoWorkflowParameterEntry
+ ],
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "inOutType": "A String", # Specifies the input/output type for the parameter.
+ "isTransient": True or False, # Whether this parameter is a transient parameter. go/ip-transient-parameters
+ "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "name": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+ "producedBy": { # Represents a node identifier (type + id). Next highest id: 3 # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param.
+ "elementIdentifier": "A String", # Configuration of the edge.
+ "elementType": "A String", # Destination node where the edge ends. It can only be a task config.
+ },
+ "producer": "A String",
+ "protoDefName": "A String", # The name of the protobuf type if the parameter has a protobuf data type.
+ "protoDefPath": "A String", # If the data type is of type proto or proto array, this field needs to be populated with the fully qualified proto name. This message, for example, would be "enterprise.crm.frontends.eventbus.proto.WorkflowParameterEntry".
+ },
+ ],
+ },
+ "lastModifierEmail": "A String", # Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "lockHolder": "A String", # Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.
+ "name": "A String", # Output only. Auto-generated primary key.
+ "origin": "A String", # Optional. The origin that indicates where this integration is coming from.
+ "parentTemplateId": "A String", # Optional. The id of the template which was used to create this integration_version.
+ "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+ "state": "A String", # Output only. User should not set it as an input.
+ "status": "A String", # Output only. Generated by eventbus. User should not set it as an input.
+ "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "jsonValidationOption": "A String", # Optional. If set, overrides the option configured in the Task implementation class.
+ "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # Optional. The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # Optional. The customized parameters the user can pass to this task.
+ "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+ "booleanValues": [ # Boolean array.
+ True or False,
+ ],
+ },
+ "booleanValue": True or False, # Boolean.
+ "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+ "doubleValues": [ # Double number array.
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14, # Double Number.
+ "intArray": { # This message only contains a field of integer array. # Integer Array.
+ "intValues": [ # Integer array.
+ "A String",
+ ],
+ },
+ "intValue": "A String", # Integer.
+ "jsonValue": "A String", # Json.
+ "stringArray": { # This message only contains a field of string array. # String Array.
+ "stringValues": [ # String array.
+ "A String",
+ ],
+ },
+ "stringValue": "A String", # String.
+ },
+ },
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Optional. Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalTime": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the initial interval in seconds for backoff.
+ "maxRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_INTEGRATION_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "task": "A String", # Optional. The name for the task.
+ "taskExecutionStrategy": "A String", # Optional. The policy dictating the execution strategy of this task.
+ "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+ "taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template
+ },
+ ],
+ "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+ { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. Next available id: 27
+ "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc.
+ { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week).
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique in within the scope of the containing workflow.
+ "clientId": "A String", # Client associated with this alert configuration. Must be a client enabled in one of the containing workflow's triggers.
+ "durationThresholdMs": "A String", # Should be specified only for TASK_AVERAGE_DURATION and TASK_PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # Only count final task attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "createTime": "A String", # Auto-generated.
+ "creatorEmail": "A String", # The creator's email address. Auto-generated from the user's email.
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "disableStrictTypeValidation": True or False, # If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter.
+ "failurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "incomingEdgeCount": 42, # The number of edges leading into this TaskConfig.
+ "jsonValidationOption": "A String", # If set, overrides the option configured in the Task implementation class.
+ "label": "A String", # User-provided label that is attached to this TaskConfig in the UI.
+ "lastModifiedTime": "A String", # Auto-generated.
+ "nextTasks": [ # The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "nextTasksExecutionPolicy": "A String", # The policy dictating the execution of the next set of tasks for the current task.
+ "parameters": { # The customized parameters the user can pass to this task.
+ "a_key": { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ },
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this task config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "precondition": "A String", # Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task.
+ "preconditionLabel": "A String", # Optional. User-provided label that is attached to precondition in the UI.
+ "rollbackStrategy": { # Next available id: 4 # Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. The customized parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same workflow execution.
+ { # Key-value pair of EventBus parameters.
+ "dataType": "A String", # Explicitly getting the type of the parameter.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the workflow definition.
+ "value": { # To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "rollbackTaskImplementationClassName": "A String", # Required. This is the name of the task that needs to be executed upon rollback of this task.
+ "taskNumbersToRollback": [ # Required. These are the tasks numbers of the tasks whose `rollback_strategy.rollback_task_implementation_class_name` needs to be executed upon failure of this task.
+ "A String",
+ ],
+ },
+ "successPolicy": { # Policy that dictates the behavior for the task after it completes successfully. # Determines what action to take upon successful task completion.
+ "finalState": "A String", # State to which the execution snapshot status will be set if the task succeeds.
+ },
+ "synchronousCallFailurePolicy": { # Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a `retry_strategy` of NONE will be applied). # Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post).
+ "intervalInSeconds": "A String", # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the initial interval for backoff.
+ "maxNumRetries": 42, # Required if retry_strategy is FIXED_INTERVAL or LINEAR/EXPONENTIAL_BACKOFF/RESTART_WORKFLOW_WITH_BACKOFF. Defines the number of times the task will be retried if failed.
+ "retryStrategy": "A String", # Defines what happens to the task upon failure.
+ },
+ "taskEntity": { # Contains a task's metadata and associated information. Next available id: 7 # Copy of the task entity that this task config is an instance of.
+ "disabledForVpcSc": True or False, # True if the task has conflict with vpcsc
+ "metadata": { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
+ "activeTaskName": "A String", # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
+ "admins": [
+ { # Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.
+ "googleGroupEmail": "A String",
+ "userEmail": "A String",
+ },
+ ],
+ "category": "A String",
+ "codeSearchLink": "A String", # The Code Search link to the Task Java file.
+ "defaultJsonValidationOption": "A String", # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.
+ "defaultSpec": "A String", # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
+ "description": "A String", # In a few sentences, describe the purpose and usage of the task.
+ "descriptiveName": "A String", # The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")
+ "docMarkdown": "A String", # Snippet of markdown documentation to embed in the RHP for this task.
+ "externalCategory": "A String",
+ "externalCategorySequence": 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
+ "externalDocHtml": "A String", # External-facing documention embedded in the RHP for this task.
+ "externalDocLink": "A String", # Doc link for external-facing documentation (separate from g3doc).
+ "externalDocMarkdown": "A String", # DEPRECATED: Use external_doc_html.
+ "g3DocLink": "A String", # URL to the associated G3 Doc for the task if available
+ "iconLink": "A String", # URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format. See go/icons.
+ "isDeprecated": True or False, # The deprecation status of the current task. Default value is false;
+ "name": "A String", # The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.
+ "standaloneExternalDocHtml": "A String", # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
+ "status": "A String", # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
+ "system": "A String",
+ "tags": [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.
+ "A String",
+ ],
+ },
+ "paramSpecs": { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
+ "parameters": [
+ { # Key-value pair of EventBus task parameters. Next id: 13
+ "className": "A String", # The FQCN of the Java object this represents. A string, for example, would be "java.lang.String". If this is "java.lang.Object", the parameter can be of any type.
+ "collectionElementClassName": "A String", # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is "java.lang.Object", the parameter is a collection of any type.
+ "config": { # Optional fields, such as help text and other useful info.
+ "descriptivePhrase": "A String", # A short phrase to describe what this parameter contains.
+ "helpText": "A String", # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
+ "hideDefaultValue": True or False, # Whether the default value is hidden in the UI.
+ "inputDisplayOption": "A String",
+ "isHidden": True or False, # Whether this field is hidden in the UI.
+ "label": "A String", # A user-friendly label for the parameter.
+ "parameterNameOption": "A String",
+ "subSectionLabel": "A String", # A user-friendly label for subSection under which the parameter will be displayed.
+ "uiPlaceholderText": "A String", # Placeholder text which will appear in the UI input form for this parameter.
+ },
+ "dataType": "A String", # The data type of the parameter.
+ "defaultValue": { # To support various types of parameter values. Next available id: 14 # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "jsonValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ "isDeprecated": True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
+ "isOutput": True or False,
+ "jsonSchema": "A String", # If the data_type is JSON_VALUE, then this will define its schema.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given task. These parameters must be predefined in the workflow definition.
+ "protoDef": { # Populated if this represents a proto or proto array.
+ "fullName": "A String", # The fully-qualified proto name. This message, for example, would be "enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition".
+ "path": "A String", # Path to the proto file that contains the message type's definition.
+ },
+ "required": True or False, # If set, the user must provide an input value for this parameter.
+ "validationRule": { # Rule used to validate inputs (individual values and collection elements) for this parameter.
+ "doubleRange": { # Range used to validate doubles and floats.
+ "max": 3.14, # The inclusive maximum of the acceptable range.
+ "min": 3.14, # The inclusive minimum of the acceptable range.
+ },
+ "intRange": { # Range used to validate longs and ints.
+ "max": "A String", # The inclusive maximum of the acceptable range.
+ "min": "A String", # The inclusive minimum of the acceptable range.
+ },
+ "stringRegex": { # Rule used to validate strings.
+ "exclusive": True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
+ "regex": "A String", # The regex applied to the input value(s).
+ },
+ },
+ },
+ ],
+ },
+ "stats": { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
+ "dimensions": { # Dimensions that these stats have been aggregated on.
+ "clientId": "A String",
+ "enumFilterType": "A String", # Whether to include or exclude the enums matching the regex.
+ "errorEnumString": "A String",
+ "retryAttempt": "A String",
+ "taskName": "A String",
+ "taskNumber": "A String",
+ "triggerId": "A String", # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
+ "warningEnumString": "A String",
+ "workflowId": "A String",
+ "workflowName": "A String",
+ },
+ "durationInSeconds": 3.14, # Average duration in seconds.
+ "errorRate": 3.14, # Average error rate.
+ "qps": 3.14, # Queries per second.
+ "warningRate": 3.14, # Average warning rate.
+ },
+ "taskType": "A String", # Defines the type of the task
+ "uiConfig": { # Task authors would use this type to configure the UI for a particular task by specifying what UI config modules should be included to compose the UI. Learn more about config module framework: go/integration-platform-config-module-framework # UI configuration for this task Also associated with the METADATA mask.
+ "taskUiModuleConfigs": [ # Configurations of included config modules.
+ { # Task author would use this type to configure a config module.
+ "moduleId": "A String", # ID of the config module.
+ },
+ ],
+ },
+ },
+ "taskExecutionStrategy": "A String", # The policy dictating the execution strategy of this task.
+ "taskName": "A String", # The name for the task.
+ "taskNumber": "A String", # REQUIRED: the identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_number`).
+ "taskSpec": "A String", # A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Please refer to go/eventbus-task-spec-example for detailed usage example.
+ "taskTemplateName": "A String", # Used to define task-template name if task is of type task-template
+ "taskType": "A String", # Defines the type of the task
+ },
+ ],
+ "teardown": { # Optional. Contains a graph of tasks that will be executed before putting the event in a terminal state (SUCCEEDED/FAILED/FATAL), regardless of success or failure, similar to "finally" in code.
+ "teardownTaskConfigs": [ # Required.
+ {
+ "creatorEmail": "A String", # The creator's email address.
+ "name": "A String", # Required. Unique identifier of the teardown task within this Config. We use this field as the identifier to find next teardown tasks.
+ "nextTeardownTask": { # The teardown task that is next in line to be executed. We support only sequential execution of teardown tasks (i.e. no branching).
+ "name": "A String", # Required. Name of the next teardown task.
+ },
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # The parameters the user can pass to this task.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "properties": { # LINT.IfChange This message is used for storing key value pair properties for each Event / Task in the EventBus. Please see go/cloud-crm-eng/platform/event_bus.md for more details.
+ "properties": [ # An unordered list of property entries.
+ { # Key-value pair of EventBus property.
+ "key": "A String", # Key is used to retrieve the corresponding property value. This should be unique for a given fired event. The Tasks should be aware of the keys used while firing the events for them to be able to retrieve the values.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "teardownTaskImplementationClassName": "A String", # Required. Implementation class name.
+ },
+ ],
+ },
+ "triggerConfigs": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger.
+ "alertConfig": [ # Optional. An alert threshold configuration for the [trigger + client + integration] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + integration] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event.
+ "aggregationPeriod": "A String", # The period over which the metric value should be aggregated and evaluated. Format is , where integer should be a positive integer and unit should be one of (s,m,h,d,w) meaning (second, minute, hour, day, week). For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertThreshold": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "disableAlert": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this integration alert.
+ "displayName": "A String", # Name of the alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the integration.
+ "durationThreshold": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "metricType": "A String", # The type of metric.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. # The metric value, above or below which the alert should be triggered.
+ "absolute": "A String", # Absolute value threshold.
+ "percentage": 42, # Percentage threshold.
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+ "label": "A String", # Optional. The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Optional. Dictates how next tasks will be executed.
+ "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give additional business context about the task.
+ "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskId": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerId": "A String", # Optional. The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+ "triggerType": "A String", # Optional. Type of trigger
+ },
+ ],
+ "triggerConfigsInternal": [ # Optional. Trigger configurations.
+ { # Configuration detail of a trigger. Next available id: 17
+ "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published.
+ { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. See go/eventbus-alert-config-examples for examples of the different alerts that can be configured.
+ "aggregationPeriod": "A String", # For an EXPECTED_MIN threshold, this aggregation_period must be lesser than 24 hours.
+ "alertDisabled": True or False, # Set to false by default. When set to true, the metrics are not aggregated or pushed to Monarch for this workflow alert.
+ "alertName": "A String", # A name to identify this alert. This will be displayed in the alert subject. If set, this name should be unique within the scope of the workflow.
+ "clientId": "A String", # Client associated with this alert configuration.
+ "durationThresholdMs": "A String", # Should be specified only for *AVERAGE_DURATION and *PERCENTILE_DURATION metrics. This member should be used to specify what duration value the metrics should exceed for the alert to trigger.
+ "errorEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ "metricType": "A String",
+ "numAggregationPeriods": 42, # For how many contiguous aggregation periods should the expected min or max be violated for the alert to be fired.
+ "onlyFinalAttempt": True or False, # For either events or tasks, depending on the type of alert, count only final attempts, not retries.
+ "playbookUrl": "A String", # Link to a playbook for resolving the issue that triggered this alert.
+ "thresholdType": "A String", # The threshold type, whether lower(expected_min) or upper(expected_max), for which this alert is being configured. If value falls below expected_min or exceeds expected_max, an alert will be fired.
+ "thresholdValue": { # The threshold value of the metric, above or below which the alert should be triggered. See EventAlertConfig or TaskAlertConfig for the different alert metric types in each case. For the *RATE metrics, one or both of these fields may be set. Zero is the default value and can be left at that. For *PERCENTILE_DURATION metrics, one or both of these fields may be set, and also, the duration threshold value should be specified in the threshold_duration_ms member below. For *AVERAGE_DURATION metrics, these fields should not be set at all. A different member, threshold_duration_ms, must be set in the EventAlertConfig or the TaskAlertConfig. See go/eventbus-alert-config-examples # The metric value, above or below which the alert should be triggered. See go/eventbus-alert-config-examples.
+ "absolute": "A String",
+ "percentage": 42,
+ },
+ "warningEnumList": { # List of error enums for alerts.
+ "enumStrings": [
+ "A String",
+ ],
+ "filterType": "A String",
+ },
+ },
+ ],
+ "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration
+ "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+ "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+ "location": "A String", # Required. The location where associated cloud scheduler job will be created
+ "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+ },
+ "description": "A String", # User-provided description intended to give more business context about the task.
+ "enabledClients": [ # Required. The list of client ids which are enabled to execute the workflow using this trigger. In other words, these clients have the workflow execution privledges for this trigger. For API trigger, the client id in the incoming request is validated against the list of enabled clients. For non-API triggers, one workflow execution is triggered on behalf of each enabled client.
+ "A String",
+ ],
+ "label": "A String", # The user created label for a particular trigger.
+ "nextTasksExecutionPolicy": "A String", # Dictates how next tasks will be executed.
+ "pauseWorkflowExecutions": True or False, # Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.
+ "position": { # Represents two-dimensional positions. # Optional. Informs the front-end application where to draw this trigger config on the UI.
+ "x": 42,
+ "y": 42,
+ },
+ "properties": { # Configurable properties of the trigger, not to be confused with workflow parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Cloud Pubsub triggers.
+ "a_key": "A String",
+ },
+ "startTasks": [ # Set of tasks numbers from where the workflow execution is started by this trigger. If this is empty, then workflow is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same workflow execution graph).
+ { # The task that is next in line to be executed, if the condition specified evaluated to true.
+ "combinedConditions": [ # Combined condition for this task to become an eligible next task. Each of these combined_conditions are joined with logical OR. DEPRECATED: use `condition`
+ { # This message recursively combines constituent conditions using logical AND.
+ "conditions": [ # A set of individual constituent conditions.
+ { # Condition that uses `operator` to evaluate the key against the value.
+ "eventPropertyKey": "A String", # Key that's evaluated against the `value`. Please note the data type of the runtime value associated with the key should match the data type of `value`, else an IllegalArgumentException is thrown.
+ "operator": "A String", # Operator used to evaluate the condition. Please note that an operator with an inappropriate key/value operand will result in IllegalArgumentException, e.g. CONTAINS with boolean key/value pair.
+ "value": { # Used for define type for values. Currently supported value types include int, string, double, array, and any proto message. # Value that's checked for the key.
+ "booleanValue": True or False,
+ "doubleArray": {
+ "values": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "stringArray": {
+ "values": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ ],
+ "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+ "description": "A String", # User-provided description intended to give more business context about the next task edge or condition.
+ "label": "A String", # User-provided label that is attached to this edge in the UI.
+ "taskConfigId": "A String", # ID of the next task.
+ "taskNumber": "A String", # Task number of the next task.
+ },
+ ],
+ "triggerCriteria": { # Optional. When set, Eventbus will run the task specified in the trigger_criteria and validate the result using the trigger_criteria.condition, and only execute the workflow when result is true.
+ "condition": "A String", # Required. Standard filter expression, when true the workflow will be executed. If there's no trigger_criteria_task_implementation_class_name specified, the condition will be validated directly.
+ "parameters": { # LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see go/integration-platform/event_bus.md for more details. Next id: 4 # Optional. To be used in TaskConfig for the implementation class.
+ "parameters": [ # Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.
+ { # Key-value pair of EventBus parameters.
+ "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+ "value": { # LINT.IfChange To support various types of parameter values. Next available id: 14 # Values for the defined keys. Each value can either be string, int, double or any proto message.
+ "booleanArray": {
+ "booleanValues": [
+ True or False,
+ ],
+ },
+ "booleanValue": True or False,
+ "doubleArray": {
+ "doubleValues": [
+ 3.14,
+ ],
+ },
+ "doubleValue": 3.14,
+ "intArray": {
+ "intValues": [
+ "A String",
+ ],
+ },
+ "intValue": "A String",
+ "protoArray": {
+ "protoValues": [
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+ "protoValue": {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "serializedObjectValue": {
+ "objectValue": "A String",
+ },
+ "stringArray": {
+ "stringValues": [
+ "A String",
+ ],
+ },
+ "stringValue": "A String",
+ },
+ },
+ ],
+ },
+ "triggerCriteriaTaskImplementationClassName": "A String", # Optional. Implementation class name. The class should implement the “TypedTask” interface.
+ },
+ "triggerId": "A String", # The backend trigger ID.
+ "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the workflow on UI.
+ "triggerType": "A String",
+ },
+ ],
+ "updateTime": "A String", # Output only. Auto-generated.
+ "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+ },
+}
+validate(name, body=None, x__xgafv=None)
+ Validates the given integration. If the id doesn't exist, a NotFoundException is thrown. If validation fails a CanonicalCodeException is thrown. If there was no failure an empty response is returned.
+
+Args:
+ name: string, Required. The version to validate. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{version} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request for ValidateIntegrationVersion.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response for ValidateIntegrationVersion.
+}
+
+ sfdcChannels()
+
Returns the sfdcChannels Resource.
+ +
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
+ +Deletes an sfdc instance.
+ +Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
+
+Args:
+ parent: string, Required. "projects/{project}/locations/{location}" format. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The SfdcInstance resource use to hold channels and connection config data.
+ "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Time when the instance is created
+ "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+ "description": "A String", # A description of the sfdc instance.
+ "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+ "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+ "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+ "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The SfdcInstance resource use to hold channels and connection config data.
+ "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Time when the instance is created
+ "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+ "description": "A String", # A description of the sfdc instance.
+ "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+ "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+ "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+ "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+delete(name, x__xgafv=None)
+ Deletes an sfdc instance.
+
+Args:
+ name: string, Required. The name that is associated with the SfdcInstance. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+get(name, x__xgafv=None)
+ Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
+
+Args:
+ name: string, Required. The name that is associated with the SfdcInstance. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The SfdcInstance resource use to hold channels and connection config data.
+ "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Time when the instance is created
+ "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+ "description": "A String", # A description of the sfdc instance.
+ "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+ "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+ "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+ "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
+ Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
+
+Args:
+ parent: string, Required. The client, which owns this collection of SfdcInstances. (required)
+ filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
+ pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
+ pageToken: string, The token returned in the previous response.
+ readMask: string, The mask which specifies fields that need to be returned in the SfdcInstance's response.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response to list SfdcInstances.
+ "nextPageToken": "A String", # The token used to retrieve the next page of results.
+ "sfdcInstances": [ # The list of SfdcInstances retrieved.
+ { # The SfdcInstance resource use to hold channels and connection config data.
+ "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Time when the instance is created
+ "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+ "description": "A String", # A description of the sfdc instance.
+ "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+ "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+ "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+ "updateTime": "A String", # Output only. Time when the instance was last updated
+ },
+ ],
+}
+list_next()
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
+
+Args:
+ name: string, Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The SfdcInstance resource use to hold channels and connection config data.
+ "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Time when the instance is created
+ "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+ "description": "A String", # A description of the sfdc instance.
+ "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+ "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+ "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+ "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+ updateMask: string, Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The SfdcInstance resource use to hold channels and connection config data.
+ "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Time when the instance is created
+ "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+ "description": "A String", # A description of the sfdc instance.
+ "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+ "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+ "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+ "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
+ +Deletes an sfdc channel.
+ +Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
+
+Args:
+ parent: string, Required. "projects/{project}/locations/{location}" format. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The SfdcChannel that points to a CDC or Platform Event Channel.
+ "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+ "createTime": "A String", # Output only. Time when the channel is created
+ "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+ "description": "A String", # The description for this channel
+ "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+ "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+ "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+ "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+ "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The SfdcChannel that points to a CDC or Platform Event Channel.
+ "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+ "createTime": "A String", # Output only. Time when the channel is created
+ "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+ "description": "A String", # The description for this channel
+ "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+ "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+ "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+ "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+ "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+delete(name, x__xgafv=None)
+ Deletes an sfdc channel.
+
+Args:
+ name: string, Required. The name that is associated with the SfdcChannel. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+get(name, x__xgafv=None)
+ Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
+
+Args:
+ name: string, Required. The name that is associated with the SfdcChannel. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The SfdcChannel that points to a CDC or Platform Event Channel.
+ "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+ "createTime": "A String", # Output only. Time when the channel is created
+ "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+ "description": "A String", # The description for this channel
+ "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+ "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+ "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+ "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+ "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
+ Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
+
+Args:
+ parent: string, Required. The client, which owns this collection of SfdcChannels. (required)
+ filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
+ pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
+ pageToken: string, The token returned in the previous response.
+ readMask: string, The mask which specifies fields that need to be returned in the SfdcChannel's response.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response to list SfdcChannels.
+ "nextPageToken": "A String", # The token used to retrieve the next page of results.
+ "sfdcChannels": [ # The list of SfdcChannels retrieved.
+ { # The SfdcChannel that points to a CDC or Platform Event Channel.
+ "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+ "createTime": "A String", # Output only. Time when the channel is created
+ "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+ "description": "A String", # The description for this channel
+ "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+ "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+ "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+ "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+ "updateTime": "A String", # Output only. Time when the channel was last updated
+ },
+ ],
+}
+list_next()
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
+
+Args:
+ name: string, Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The SfdcChannel that points to a CDC or Platform Event Channel.
+ "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+ "createTime": "A String", # Output only. Time when the channel is created
+ "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+ "description": "A String", # The description for this channel
+ "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+ "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+ "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+ "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+ "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+
+ updateMask: string, Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The SfdcChannel that points to a CDC or Platform Event Channel.
+ "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+ "createTime": "A String", # Output only. Time when the channel is created
+ "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+ "description": "A String", # The description for this channel
+ "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+ "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+ "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+ "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+ "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+
+ sfdcChannels()
+
Returns the sfdcChannels Resource.
+ +
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
+ +Deletes an sfdc instance.
+ +Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates an sfdc instance record. Store the sfdc instance in Spanner. Returns the sfdc instance.
+
+Args:
+ parent: string, Required. "projects/{project}/locations/{location}" format. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The SfdcInstance resource use to hold channels and connection config data.
+ "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Time when the instance is created
+ "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+ "description": "A String", # A description of the sfdc instance.
+ "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+ "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+ "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+ "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The SfdcInstance resource use to hold channels and connection config data.
+ "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Time when the instance is created
+ "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+ "description": "A String", # A description of the sfdc instance.
+ "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+ "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+ "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+ "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+delete(name, x__xgafv=None)
+ Deletes an sfdc instance.
+
+Args:
+ name: string, Required. The name that is associated with the SfdcInstance. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+get(name, x__xgafv=None)
+ Gets an sfdc instance. If the instance doesn't exist, Code.NOT_FOUND exception will be thrown.
+
+Args:
+ name: string, Required. The name that is associated with the SfdcInstance. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The SfdcInstance resource use to hold channels and connection config data.
+ "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Time when the instance is created
+ "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+ "description": "A String", # A description of the sfdc instance.
+ "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+ "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+ "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+ "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
+ Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.
+
+Args:
+ parent: string, Required. The client, which owns this collection of SfdcInstances. (required)
+ filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
+ pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
+ pageToken: string, The token returned in the previous response.
+ readMask: string, The mask which specifies fields that need to be returned in the SfdcInstance's response.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response to list SfdcInstances.
+ "nextPageToken": "A String", # The token used to retrieve the next page of results.
+ "sfdcInstances": [ # The list of SfdcInstances retrieved.
+ { # The SfdcInstance resource use to hold channels and connection config data.
+ "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Time when the instance is created
+ "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+ "description": "A String", # A description of the sfdc instance.
+ "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+ "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+ "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+ "updateTime": "A String", # Output only. Time when the instance was last updated
+ },
+ ],
+}
+list_next()
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates an sfdc instance. Updates the sfdc instance in spanner. Returns the sfdc instance.
+
+Args:
+ name: string, Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The SfdcInstance resource use to hold channels and connection config data.
+ "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Time when the instance is created
+ "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+ "description": "A String", # A description of the sfdc instance.
+ "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+ "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+ "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+ "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+ updateMask: string, Field mask specifying the fields in the above SfdcInstance that have been modified and need to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The SfdcInstance resource use to hold channels and connection config data.
+ "authConfigId": [ # A list of AuthConfigs that can be tried to open the channel to SFDC
+ "A String",
+ ],
+ "createTime": "A String", # Output only. Time when the instance is created
+ "deleteTime": "A String", # Output only. Time when the instance was deleted. Empty if not deleted.
+ "description": "A String", # A description of the sfdc instance.
+ "displayName": "A String", # User selected unique name/alias to easily reference an instance.
+ "name": "A String", # Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}.
+ "serviceAuthority": "A String", # URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig).
+ "sfdcOrgId": "A String", # The SFDC Org Id. This is defined in salesforce.
+ "updateTime": "A String", # Output only. Time when the instance was last updated
+}
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
+ +Deletes an sfdc channel.
+ +Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates an sfdc channel record. Store the sfdc channel in Spanner. Returns the sfdc channel.
+
+Args:
+ parent: string, Required. "projects/{project}/locations/{location}" format. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The SfdcChannel that points to a CDC or Platform Event Channel.
+ "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+ "createTime": "A String", # Output only. Time when the channel is created
+ "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+ "description": "A String", # The description for this channel
+ "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+ "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+ "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+ "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+ "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The SfdcChannel that points to a CDC or Platform Event Channel.
+ "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+ "createTime": "A String", # Output only. Time when the channel is created
+ "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+ "description": "A String", # The description for this channel
+ "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+ "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+ "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+ "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+ "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+delete(name, x__xgafv=None)
+ Deletes an sfdc channel.
+
+Args:
+ name: string, Required. The name that is associated with the SfdcChannel. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # 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); }
+}
+get(name, x__xgafv=None)
+ Gets an sfdc channel. If the channel doesn't exist, Code.NOT_FOUND exception will be thrown.
+
+Args:
+ name: string, Required. The name that is associated with the SfdcChannel. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The SfdcChannel that points to a CDC or Platform Event Channel.
+ "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+ "createTime": "A String", # Output only. Time when the channel is created
+ "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+ "description": "A String", # The description for this channel
+ "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+ "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+ "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+ "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+ "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None)
+ Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.
+
+Args:
+ parent: string, Required. The client, which owns this collection of SfdcChannels. (required)
+ filter: string, Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters.
+ pageSize: integer, The size of entries in the response. If unspecified, defaults to 100.
+ pageToken: string, The token returned in the previous response.
+ readMask: string, The mask which specifies fields that need to be returned in the SfdcChannel's response.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response to list SfdcChannels.
+ "nextPageToken": "A String", # The token used to retrieve the next page of results.
+ "sfdcChannels": [ # The list of SfdcChannels retrieved.
+ { # The SfdcChannel that points to a CDC or Platform Event Channel.
+ "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+ "createTime": "A String", # Output only. Time when the channel is created
+ "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+ "description": "A String", # The description for this channel
+ "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+ "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+ "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+ "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+ "updateTime": "A String", # Output only. Time when the channel was last updated
+ },
+ ],
+}
+list_next()
+ 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. ++
patch(name, body=None, updateMask=None, x__xgafv=None)
+ Updates an sfdc channel. Updates the sfdc channel in spanner. Returns the sfdc channel.
+
+Args:
+ name: string, Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The SfdcChannel that points to a CDC or Platform Event Channel.
+ "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+ "createTime": "A String", # Output only. Time when the channel is created
+ "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+ "description": "A String", # The description for this channel
+ "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+ "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+ "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+ "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+ "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+
+ updateMask: string, Field mask specifying the fields in the above SfdcChannel that have been modified and need to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The SfdcChannel that points to a CDC or Platform Event Channel.
+ "channelTopic": "A String", # The Channel topic defined by salesforce once an channel is opened
+ "createTime": "A String", # Output only. Time when the channel is created
+ "deleteTime": "A String", # Output only. Time when the channel was deleted. Empty if not deleted.
+ "description": "A String", # The description for this channel
+ "displayName": "A String", # Client level unique name/alias to easily reference a channel.
+ "isActive": True or False, # Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it.
+ "lastReplayId": "A String", # Last sfdc messsage replay id for channel
+ "name": "A String", # Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}.
+ "updateTime": "A String", # Output only. Time when the channel was last updated
+}
+Makes a recommendation prediction.
Args:
- placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Managing serving configurations] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
+ placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Manage serving configs] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
body: object, The request body.
The object takes the form of:
@@ -364,7 +364,7 @@ Method Details
Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
Args:
- placement: string, Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving configuration name and the set of models that will be used to make the search. (required)
+ placement: string, Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving config name and the set of models that will be used to make the search. (required)
body: object, The request body.
The object takes the form of:
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html
index ee45a3cf13a..cf1f24c476f 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html
@@ -572,7 +572,7 @@ Method Details
Makes a recommendation prediction.
Args:
- placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Managing serving configurations] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
+ placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Manage serving configs] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
body: object, The request body.
The object takes the form of:
@@ -907,7 +907,7 @@ Method Details
Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
Args:
- placement: string, Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving configuration name and the set of models that will be used to make the search. (required)
+ placement: string, Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving config name and the set of models that will be used to make the search. (required)
body: object, The request body.
The object takes the form of:
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html
index 326ccbdda15..154dfa66327 100644
--- a/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html
+++ b/docs/dyn/retail_v2.projects.locations.catalogs.userEvents.html
@@ -90,7 +90,7 @@ Instance Methods
rejoin(parent, body=None, x__xgafv=None)
Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.
- write(parent, body=None, x__xgafv=None)
+ write(parent, body=None, writeAsync=None, x__xgafv=None)
Writes a single user event.
Method Details
@@ -502,7 +502,7 @@ Method Details
- write(parent, body=None, x__xgafv=None)
+ write(parent, body=None, writeAsync=None, x__xgafv=None)
Writes a single user event.
Args:
@@ -731,6 +731,7 @@ Method Details
"visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.
}
+ writeAsync: boolean, If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write. Therefore, silent failures can occur even if the API returns success. In case of silent failures, error messages can be found in Stackdriver logs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html
index 2cc3bab0f3c..2d14c6c0af0 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.controls.html
@@ -111,7 +111,7 @@ Method Details
The object takes the form of:
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
- "associatedServingConfigIds": [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
+ "associatedServingConfigIds": [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
"A String",
],
"displayName": "A String", # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -230,7 +230,7 @@ Method Details
An object of the form:
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
- "associatedServingConfigIds": [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
+ "associatedServingConfigIds": [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
"A String",
],
"displayName": "A String", # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -373,7 +373,7 @@ Method Details
An object of the form:
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
- "associatedServingConfigIds": [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
+ "associatedServingConfigIds": [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
"A String",
],
"displayName": "A String", # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -503,7 +503,7 @@ Method Details
{ # Response for ListControls method.
"controls": [ # All the Controls for a given catalog.
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
- "associatedServingConfigIds": [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
+ "associatedServingConfigIds": [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
"A String",
],
"displayName": "A String", # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -640,7 +640,7 @@ Method Details
The object takes the form of:
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
- "associatedServingConfigIds": [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
+ "associatedServingConfigIds": [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
"A String",
],
"displayName": "A String", # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -759,7 +759,7 @@ Method Details
An object of the form:
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
- "associatedServingConfigIds": [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
+ "associatedServingConfigIds": [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
"A String",
],
"displayName": "A String", # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html
index 7dbea330ca9..8016aefc701 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.models.html
@@ -124,7 +124,7 @@ Method Details
"lastTuneTime": "A String", # Output only. The timestamp when the latest successful tune finished.
"name": "A String", # Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
"optimizationObjective": "A String", # Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
- "pageOptimizationConfig": { # The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configurations to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey. # Optional. The page optimization config.
+ "pageOptimizationConfig": { # The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configs to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey. # Optional. The page optimization config.
"pageOptimizationEventType": "A String", # Required. The type of UserEvent this page optimization is shown for. Each page has an associated event type - this will be the corresponding event type for the page that the page optimization model is used on. Supported types: * `add-to-cart`: Products being added to cart. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed * `category-page-view`: Homepage viewed * `shopping-cart-page-view`: User viewing a shopping cart. `home-page-view` only allows models with type `recommended-for-you`. All other page_optimization_event_type allow all Model.types.
"panels": [ # Required. A list of panel configurations. Limit = 5.
{ # An individual panel with a list of ServingConfigs to consider for it.
@@ -230,7 +230,7 @@ Method Details
"lastTuneTime": "A String", # Output only. The timestamp when the latest successful tune finished.
"name": "A String", # Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
"optimizationObjective": "A String", # Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
- "pageOptimizationConfig": { # The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configurations to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey. # Optional. The page optimization config.
+ "pageOptimizationConfig": { # The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configs to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey. # Optional. The page optimization config.
"pageOptimizationEventType": "A String", # Required. The type of UserEvent this page optimization is shown for. Each page has an associated event type - this will be the corresponding event type for the page that the page optimization model is used on. Supported types: * `add-to-cart`: Products being added to cart. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed * `category-page-view`: Homepage viewed * `shopping-cart-page-view`: User viewing a shopping cart. `home-page-view` only allows models with type `recommended-for-you`. All other page_optimization_event_type allow all Model.types.
"panels": [ # Required. A list of panel configurations. Limit = 5.
{ # An individual panel with a list of ServingConfigs to consider for it.
@@ -297,7 +297,7 @@ Method Details
"lastTuneTime": "A String", # Output only. The timestamp when the latest successful tune finished.
"name": "A String", # Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
"optimizationObjective": "A String", # Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
- "pageOptimizationConfig": { # The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configurations to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey. # Optional. The page optimization config.
+ "pageOptimizationConfig": { # The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configs to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey. # Optional. The page optimization config.
"pageOptimizationEventType": "A String", # Required. The type of UserEvent this page optimization is shown for. Each page has an associated event type - this will be the corresponding event type for the page that the page optimization model is used on. Supported types: * `add-to-cart`: Products being added to cart. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed * `category-page-view`: Homepage viewed * `shopping-cart-page-view`: User viewing a shopping cart. `home-page-view` only allows models with type `recommended-for-you`. All other page_optimization_event_type allow all Model.types.
"panels": [ # Required. A list of panel configurations. Limit = 5.
{ # An individual panel with a list of ServingConfigs to consider for it.
@@ -346,7 +346,7 @@ Method Details
"lastTuneTime": "A String", # Output only. The timestamp when the latest successful tune finished.
"name": "A String", # Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
"optimizationObjective": "A String", # Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
- "pageOptimizationConfig": { # The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configurations to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey. # Optional. The page optimization config.
+ "pageOptimizationConfig": { # The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configs to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey. # Optional. The page optimization config.
"pageOptimizationEventType": "A String", # Required. The type of UserEvent this page optimization is shown for. Each page has an associated event type - this will be the corresponding event type for the page that the page optimization model is used on. Supported types: * `add-to-cart`: Products being added to cart. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed * `category-page-view`: Homepage viewed * `shopping-cart-page-view`: User viewing a shopping cart. `home-page-view` only allows models with type `recommended-for-you`. All other page_optimization_event_type allow all Model.types.
"panels": [ # Required. A list of panel configurations. Limit = 5.
{ # An individual panel with a list of ServingConfigs to consider for it.
@@ -407,7 +407,7 @@ Method Details
"lastTuneTime": "A String", # Output only. The timestamp when the latest successful tune finished.
"name": "A String", # Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
"optimizationObjective": "A String", # Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
- "pageOptimizationConfig": { # The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configurations to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey. # Optional. The page optimization config.
+ "pageOptimizationConfig": { # The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configs to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey. # Optional. The page optimization config.
"pageOptimizationEventType": "A String", # Required. The type of UserEvent this page optimization is shown for. Each page has an associated event type - this will be the corresponding event type for the page that the page optimization model is used on. Supported types: * `add-to-cart`: Products being added to cart. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed * `category-page-view`: Homepage viewed * `shopping-cart-page-view`: User viewing a shopping cart. `home-page-view` only allows models with type `recommended-for-you`. All other page_optimization_event_type allow all Model.types.
"panels": [ # Required. A list of panel configurations. Limit = 5.
{ # An individual panel with a list of ServingConfigs to consider for it.
@@ -468,7 +468,7 @@ Method Details
"lastTuneTime": "A String", # Output only. The timestamp when the latest successful tune finished.
"name": "A String", # Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
"optimizationObjective": "A String", # Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
- "pageOptimizationConfig": { # The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configurations to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey. # Optional. The page optimization config.
+ "pageOptimizationConfig": { # The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configs to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey. # Optional. The page optimization config.
"pageOptimizationEventType": "A String", # Required. The type of UserEvent this page optimization is shown for. Each page has an associated event type - this will be the corresponding event type for the page that the page optimization model is used on. Supported types: * `add-to-cart`: Products being added to cart. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed * `category-page-view`: Homepage viewed * `shopping-cart-page-view`: User viewing a shopping cart. `home-page-view` only allows models with type `recommended-for-you`. All other page_optimization_event_type allow all Model.types.
"panels": [ # Required. A list of panel configurations. Limit = 5.
{ # An individual panel with a list of ServingConfigs to consider for it.
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html
index f43f3b76570..0fe07b76c3d 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html
@@ -97,7 +97,7 @@ Method Details
Makes a recommendation prediction.
Args:
- placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Managing serving configurations] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
+ placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Manage serving configs] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
body: object, The request body.
The object takes the form of:
@@ -364,7 +364,7 @@ Method Details
Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
Args:
- placement: string, Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving configuration name and the set of models that will be used to make the search. (required)
+ placement: string, Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving config name and the set of models that will be used to make the search. (required)
body: object, The request body.
The object takes the form of:
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html
index 9438889a0f1..cb5d53a727a 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html
@@ -572,7 +572,7 @@ Method Details
Makes a recommendation prediction.
Args:
- placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Managing serving configurations] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
+ placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Manage serving configs] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
body: object, The request body.
The object takes the form of:
@@ -907,7 +907,7 @@ Method Details
Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
Args:
- placement: string, Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving configuration name and the set of models that will be used to make the search. (required)
+ placement: string, Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving config name and the set of models that will be used to make the search. (required)
body: object, The request body.
The object takes the form of:
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html
index 2d5c9e67002..38271f29ae4 100644
--- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html
+++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html
@@ -90,7 +90,7 @@ Instance Methods
rejoin(parent, body=None, x__xgafv=None)
Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.
- write(parent, body=None, x__xgafv=None)
+ write(parent, body=None, writeAsync=None, x__xgafv=None)
Writes a single user event.
Method Details
@@ -502,7 +502,7 @@ Method Details
- write(parent, body=None, x__xgafv=None)
+ write(parent, body=None, writeAsync=None, x__xgafv=None)
Writes a single user event.
Args:
@@ -731,6 +731,7 @@ Method Details
"visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.
}
+ writeAsync: boolean, If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write. Therefore, silent failures can occur even if the API returns success. In case of silent failures, error messages can be found in Stackdriver logs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html
index 4b1ead9f55d..9ab1ae4f7f9 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.controls.html
@@ -111,7 +111,7 @@ Method Details
The object takes the form of:
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
- "associatedServingConfigIds": [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
+ "associatedServingConfigIds": [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
"A String",
],
"displayName": "A String", # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -230,7 +230,7 @@ Method Details
An object of the form:
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
- "associatedServingConfigIds": [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
+ "associatedServingConfigIds": [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
"A String",
],
"displayName": "A String", # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -373,7 +373,7 @@ Method Details
An object of the form:
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
- "associatedServingConfigIds": [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
+ "associatedServingConfigIds": [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
"A String",
],
"displayName": "A String", # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -503,7 +503,7 @@ Method Details
{ # Response for ListControls method.
"controls": [ # All the Controls for a given catalog.
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
- "associatedServingConfigIds": [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
+ "associatedServingConfigIds": [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
"A String",
],
"displayName": "A String", # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -640,7 +640,7 @@ Method Details
The object takes the form of:
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
- "associatedServingConfigIds": [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
+ "associatedServingConfigIds": [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
"A String",
],
"displayName": "A String", # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
@@ -759,7 +759,7 @@ Method Details
An object of the form:
{ # Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
- "associatedServingConfigIds": [ # Output only. List of serving configuration ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
+ "associatedServingConfigIds": [ # Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
"A String",
],
"displayName": "A String", # Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html
index 1cb128ce4a4..e44ac5d0329 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html
@@ -97,7 +97,7 @@ Method Details
Makes a recommendation prediction.
Args:
- placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Managing serving configurations] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
+ placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Manage serving configs] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
body: object, The request body.
The object takes the form of:
@@ -364,7 +364,7 @@ Method Details
Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
Args:
- placement: string, Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving configuration name and the set of models that will be used to make the search. (required)
+ placement: string, Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving config name and the set of models that will be used to make the search. (required)
body: object, The request body.
The object takes the form of:
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html
index 1e3cc7a7809..670178e566f 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html
@@ -572,7 +572,7 @@ Method Details
Makes a recommendation prediction.
Args:
- placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Managing serving configurations] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
+ placement: string, Required. Full resource name of the format: `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` or `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. We recommend using the `servingConfigs` resource. `placements` is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see [Manage serving configs] (https://cloud.google.com/retail/docs/manage-configs). The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs (required)
body: object, The request body.
The object takes the form of:
@@ -907,7 +907,7 @@ Method Details
Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.
Args:
- placement: string, Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving configuration name and the set of models that will be used to make the search. (required)
+ placement: string, Required. The resource name of the Retail Search serving config, such as `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config` or the name of the legacy placement resource, such as `projects/*/locations/global/catalogs/default_catalog/placements/default_search`. This field is used to identify the serving config name and the set of models that will be used to make the search. (required)
body: object, The request body.
The object takes the form of:
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html
index 8f6abdff9dc..9d312e474cd 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html
@@ -90,7 +90,7 @@ Instance Methods
rejoin(parent, body=None, x__xgafv=None)
Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.
- write(parent, body=None, x__xgafv=None)
+ write(parent, body=None, writeAsync=None, x__xgafv=None)
Writes a single user event.
Method Details
@@ -502,7 +502,7 @@ Method Details
- write(parent, body=None, x__xgafv=None)
+ write(parent, body=None, writeAsync=None, x__xgafv=None)
Writes a single user event.
Args:
@@ -731,6 +731,7 @@ Method Details
"visitorId": "A String", # Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor log in/out of the website. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. The field should not contain PII or user-data. We recommend to use Google Analytics [Client ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId) for this field.
}
+ writeAsync: boolean, If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write. Therefore, silent failures can occur even if the API returns success. In case of silent failures, error messages can be found in Stackdriver logs.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/run_v1.namespaces.configurations.html b/docs/dyn/run_v1.namespaces.configurations.html
index 0750c7f7117..8c6e3e3ee76 100644
--- a/docs/dyn/run_v1.namespaces.configurations.html
+++ b/docs/dyn/run_v1.namespaces.configurations.html
@@ -182,7 +182,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -258,7 +258,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -513,7 +513,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -589,7 +589,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
diff --git a/docs/dyn/run_v1.namespaces.executions.html b/docs/dyn/run_v1.namespaces.executions.html
index 73fb60f91e5..20a1016ac7b 100644
--- a/docs/dyn/run_v1.namespaces.executions.html
+++ b/docs/dyn/run_v1.namespaces.executions.html
@@ -158,7 +158,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -234,7 +234,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -498,7 +498,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -574,7 +574,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -799,7 +799,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -875,7 +875,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
diff --git a/docs/dyn/run_v1.namespaces.jobs.html b/docs/dyn/run_v1.namespaces.jobs.html
index f30d2961268..f57b35371e1 100644
--- a/docs/dyn/run_v1.namespaces.jobs.html
+++ b/docs/dyn/run_v1.namespaces.jobs.html
@@ -192,7 +192,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -268,7 +268,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -510,7 +510,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -586,7 +586,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -879,7 +879,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -955,7 +955,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -1214,7 +1214,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -1290,7 +1290,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -1545,7 +1545,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -1621,7 +1621,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -1863,7 +1863,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -1939,7 +1939,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -2160,7 +2160,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -2236,7 +2236,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
diff --git a/docs/dyn/run_v1.namespaces.revisions.html b/docs/dyn/run_v1.namespaces.revisions.html
index 9659e25375b..6e788d525ee 100644
--- a/docs/dyn/run_v1.namespaces.revisions.html
+++ b/docs/dyn/run_v1.namespaces.revisions.html
@@ -196,7 +196,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -272,7 +272,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -492,7 +492,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -568,7 +568,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
diff --git a/docs/dyn/run_v1.namespaces.services.html b/docs/dyn/run_v1.namespaces.services.html
index b78d550c5f0..0ac74fb4394 100644
--- a/docs/dyn/run_v1.namespaces.services.html
+++ b/docs/dyn/run_v1.namespaces.services.html
@@ -186,7 +186,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -262,7 +262,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -525,7 +525,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -601,7 +601,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -915,7 +915,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -991,7 +991,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -1270,7 +1270,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -1346,7 +1346,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -1621,7 +1621,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -1697,7 +1697,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -1960,7 +1960,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -2036,7 +2036,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
diff --git a/docs/dyn/run_v1.namespaces.tasks.html b/docs/dyn/run_v1.namespaces.tasks.html
index 697cfb9fb69..fed181e63eb 100644
--- a/docs/dyn/run_v1.namespaces.tasks.html
+++ b/docs/dyn/run_v1.namespaces.tasks.html
@@ -147,7 +147,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -223,7 +223,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -451,7 +451,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -527,7 +527,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
diff --git a/docs/dyn/run_v1.projects.locations.configurations.html b/docs/dyn/run_v1.projects.locations.configurations.html
index 921e0a1f3cd..21f61be0c52 100644
--- a/docs/dyn/run_v1.projects.locations.configurations.html
+++ b/docs/dyn/run_v1.projects.locations.configurations.html
@@ -182,7 +182,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -258,7 +258,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -513,7 +513,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -589,7 +589,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
diff --git a/docs/dyn/run_v1.projects.locations.revisions.html b/docs/dyn/run_v1.projects.locations.revisions.html
index cd8138bbf3d..a2db5226ade 100644
--- a/docs/dyn/run_v1.projects.locations.revisions.html
+++ b/docs/dyn/run_v1.projects.locations.revisions.html
@@ -196,7 +196,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -272,7 +272,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -492,7 +492,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -568,7 +568,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
diff --git a/docs/dyn/run_v1.projects.locations.services.html b/docs/dyn/run_v1.projects.locations.services.html
index 34da11ae157..95aa9b8bccc 100644
--- a/docs/dyn/run_v1.projects.locations.services.html
+++ b/docs/dyn/run_v1.projects.locations.services.html
@@ -195,7 +195,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -271,7 +271,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -534,7 +534,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -610,7 +610,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -924,7 +924,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -1000,7 +1000,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -1327,7 +1327,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -1403,7 +1403,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -1678,7 +1678,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -1754,7 +1754,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
@@ -2017,7 +2017,7 @@ Method Details
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. Variable references are not supported in Cloud Run.
"A String",
],
- "env": [ # List of environment variables to set in the container.
+ "env": [ # List of environment variables to set in the container. EnvVar with duplicate names are generally allowed; if referencing a secret, the name must be unique for the container. For non-secret EnvVar names, the Container will only get the last-declared one.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER.
"value": "A String", # Value of the environment variable. Defaults to "". Variable references are not supported in Cloud Run.
@@ -2093,7 +2093,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL. Currently unused in Cloud Run. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#dns-label-names
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid port number, 0 < x < 65536.
diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.html b/docs/dyn/run_v2.projects.locations.jobs.executions.html
index 362245810a2..cc5f97be61e 100644
--- a/docs/dyn/run_v2.projects.locations.jobs.executions.html
+++ b/docs/dyn/run_v2.projects.locations.jobs.executions.html
@@ -231,7 +231,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL.
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
@@ -282,7 +282,7 @@ Method Details
"timeout": "A String", # Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
- "cloudSqlInstance": { # Represents a specific Cloud SQL instance. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+ "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
@@ -410,7 +410,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL.
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
@@ -461,7 +461,7 @@ Method Details
"timeout": "A String", # Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
- "cloudSqlInstance": { # Represents a specific Cloud SQL instance. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+ "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html
index 38d64dbebb2..189ebf7a441 100644
--- a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html
+++ b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html
@@ -166,7 +166,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL.
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
@@ -247,7 +247,7 @@ Method Details
"updateTime": "A String", # Output only. The last-modified time.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
- "cloudSqlInstance": { # Represents a specific Cloud SQL instance. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+ "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
@@ -353,7 +353,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL.
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
@@ -434,7 +434,7 @@ Method Details
"updateTime": "A String", # Output only. The last-modified time.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
- "cloudSqlInstance": { # Represents a specific Cloud SQL instance. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+ "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
diff --git a/docs/dyn/run_v2.projects.locations.jobs.html b/docs/dyn/run_v2.projects.locations.jobs.html
index a22901ad63a..64fbfe97357 100644
--- a/docs/dyn/run_v2.projects.locations.jobs.html
+++ b/docs/dyn/run_v2.projects.locations.jobs.html
@@ -222,7 +222,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL.
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
@@ -273,7 +273,7 @@ Method Details
"timeout": "A String", # Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
- "cloudSqlInstance": { # Represents a specific Cloud SQL instance. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+ "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
@@ -489,7 +489,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL.
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
@@ -540,7 +540,7 @@ Method Details
"timeout": "A String", # Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
- "cloudSqlInstance": { # Represents a specific Cloud SQL instance. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+ "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
@@ -742,7 +742,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL.
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
@@ -793,7 +793,7 @@ Method Details
"timeout": "A String", # Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
- "cloudSqlInstance": { # Represents a specific Cloud SQL instance. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+ "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
@@ -954,7 +954,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL.
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
@@ -1005,7 +1005,7 @@ Method Details
"timeout": "A String", # Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
- "cloudSqlInstance": { # Represents a specific Cloud SQL instance. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+ "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html
index 08b492d57db..412a091f6b8 100644
--- a/docs/dyn/run_v2.projects.locations.services.html
+++ b/docs/dyn/run_v2.projects.locations.services.html
@@ -211,7 +211,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL.
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
@@ -270,7 +270,7 @@ Method Details
"timeout": "A String", # Max allowed time for an instance to respond to a request.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
- "cloudSqlInstance": { # Represents a specific Cloud SQL instance. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+ "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
@@ -495,7 +495,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL.
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
@@ -554,7 +554,7 @@ Method Details
"timeout": "A String", # Max allowed time for an instance to respond to a request.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
- "cloudSqlInstance": { # Represents a specific Cloud SQL instance. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+ "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
@@ -766,7 +766,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL.
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
@@ -825,7 +825,7 @@ Method Details
"timeout": "A String", # Max allowed time for an instance to respond to a request.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
- "cloudSqlInstance": { # Represents a specific Cloud SQL instance. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+ "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
@@ -994,7 +994,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL.
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
@@ -1053,7 +1053,7 @@ Method Details
"timeout": "A String", # Max allowed time for an instance to respond to a request.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
- "cloudSqlInstance": { # Represents a specific Cloud SQL instance. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+ "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
diff --git a/docs/dyn/run_v2.projects.locations.services.revisions.html b/docs/dyn/run_v2.projects.locations.services.revisions.html
index ab3dca035ce..2d6771ff959 100644
--- a/docs/dyn/run_v2.projects.locations.services.revisions.html
+++ b/docs/dyn/run_v2.projects.locations.services.revisions.html
@@ -205,7 +205,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL.
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
@@ -252,6 +252,8 @@ Method Details
"createTime": "A String", # Output only. The creation time.
"deleteTime": "A String", # Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.
"encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
+ "encryptionKeyRevocationAction": "A String", # The action to take if the encryption key is revoked.
+ "encryptionKeyShutdownDuration": "A String", # If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.
"etag": "A String", # Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
"executionEnvironment": "A String", # The execution environment being used to host this Revision.
"expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.
@@ -276,7 +278,7 @@ Method Details
"updateTime": "A String", # Output only. The last-modified time.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
- "cloudSqlInstance": { # Represents a specific Cloud SQL instance. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+ "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
@@ -381,7 +383,7 @@ Method Details
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
},
- "name": "A String", # Name of the container specified as a DNS_LABEL.
+ "name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
@@ -428,6 +430,8 @@ Method Details
"createTime": "A String", # Output only. The creation time.
"deleteTime": "A String", # Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.
"encryptionKey": "A String", # A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
+ "encryptionKeyRevocationAction": "A String", # The action to take if the encryption key is revoked.
+ "encryptionKeyShutdownDuration": "A String", # If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour.
"etag": "A String", # Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
"executionEnvironment": "A String", # The execution environment being used to host this Revision.
"expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.
@@ -452,7 +456,7 @@ Method Details
"updateTime": "A String", # Output only. The last-modified time.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
- "cloudSqlInstance": { # Represents a specific Cloud SQL instance. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
+ "cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
diff --git a/docs/dyn/servicenetworking_v1.services.html b/docs/dyn/servicenetworking_v1.services.html
index 36a7ed54ff4..5a87f3b0f5d 100644
--- a/docs/dyn/servicenetworking_v1.services.html
+++ b/docs/dyn/servicenetworking_v1.services.html
@@ -134,7 +134,7 @@ Method Details
"consumer": "A String", # Required. A resource that represents the service consumer, such as `projects/123456`. The project number can be different from the value in the consumer network parameter. For example, the network might be part of a Shared VPC network. In those cases, Service Networking validates that this resource belongs to that Shared VPC.
"consumerNetwork": "A String", # Required. The name of the service consumer's VPC network. The network must have an existing private connection that was provisioned through the connections.create method. The name must be in the following format: `projects/{project}/global/networks/{network}`, where {project} is a project number, such as `12345`. {network} is the name of a VPC network in the project.
"description": "A String", # Optional. Description of the subnet.
- "ipPrefixLength": 42, # Required. The prefix length of the subnet's IP address range. Use CIDR range notation, such as `30` to provision a subnet with an `x.x.x.x/30` CIDR range. The IP address range is drawn from a pool of available ranges in the service consumer's allocated range.
+ "ipPrefixLength": 42, # Required. The prefix length of the subnet's IP address range. Use CIDR range notation, such as `29` to provision a subnet with an `x.x.x.x/29` CIDR range. The IP address range is drawn from a pool of available ranges in the service consumer's allocated range. GCE disallows subnets with prefix_length > 29
"outsideAllocationPublicIpRange": "A String", # Optional. Enable outside allocation using public IP addresses. Any public IP range may be specified. If this field is provided, we will not use customer reserved ranges for this primary IP range.
"privateIpv6GoogleAccess": "A String", # Optional. The private IPv6 google access type for the VMs in this subnet. For information about the access types that can be set using this field, see [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) in the Compute API documentation.
"purpose": "A String", # Optional. Defines the purpose field of the subnet, e.g. 'PRIVATE_SERVICE_CONNECT'. For information about the purposes that can be set using this field, see [subnetwork](https://cloud.google.com/compute/docs/reference/rest/v1/subnetworks) in the Compute API documentation.
@@ -335,11 +335,11 @@ Method Details
"projectNum": "A String", # Required. Project number of the consumer that is launching the service instance. It can own the network that is peered with Google or, be a service project in an XPN where the host project has the network.
},
"rangeReservation": { # Represents a range reservation. # RANGES_EXHAUSTED, RANGES_EXHAUSTED, and RANGES_DELETED_LATER are done when range_reservation is provided.
- "ipPrefixLength": 42, # Required. The size of the desired subnet. Use usual CIDR range notation. For example, '30' to find unused x.x.x.x/30 CIDR range. The goal is to determine if one of the allocated ranges has enough free space for a subnet of the requested size.
+ "ipPrefixLength": 42, # Required. The size of the desired subnet. Use usual CIDR range notation. For example, '29' to find unused x.x.x.x/29 CIDR range. The goal is to determine if one of the allocated ranges has enough free space for a subnet of the requested size. GCE disallows subnets with prefix_length > 29
"requestedRanges": [ # Optional. The name of one or more allocated IP address ranges associated with this private service access connection. If no range names are provided all ranges associated with this connection will be considered. If a CIDR range with the specified IP prefix length is not available within these ranges the validation fails.
"A String",
],
- "secondaryRangeIpPrefixLengths": [ # Optional. The size of the desired secondary ranges for the subnet. Use usual CIDR range notation. For example, '30' to find unused x.x.x.x/30 CIDR range. The goal is to determine that the allocated ranges have enough free space for all the requested secondary ranges.
+ "secondaryRangeIpPrefixLengths": [ # Optional. The size of the desired secondary ranges for the subnet. Use usual CIDR range notation. For example, '29' to find unused x.x.x.x/29 CIDR range. The goal is to determine that the allocated ranges have enough free space for all the requested secondary ranges. GCE disallows subnets with prefix_length > 29
42,
],
"subnetworkCandidates": [ # Optional. List of subnetwork candidates to validate. The required input fields are `name`, `network`, and `region`. Subnetworks from this list which exist will be returned in the response with the `ip_cidr_range`, `secondary_ip_cider_ranges`, and `outside_allocation` fields set.
diff --git a/docs/dyn/sheets_v4.spreadsheets.html b/docs/dyn/sheets_v4.spreadsheets.html
index afdfea65a33..043ad30e29b 100644
--- a/docs/dyn/sheets_v4.spreadsheets.html
+++ b/docs/dyn/sheets_v4.spreadsheets.html
@@ -100,10 +100,10 @@ Instance Methods
Creates a spreadsheet, returning the newly created spreadsheet.
get(spreadsheetId, includeGridData=None, ranges=None, x__xgafv=None)
-Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a field mask listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.
+Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a [field mask](https://developers.google.com/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.
getByDataFilter(spreadsheetId, body=None, x__xgafv=None)
-Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data one of 2 ways: * Specify a field mask listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.
+Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data one of 2 ways: * Specify a [field mask](https://developers.google.com/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.
Method Details
batchUpdate(spreadsheetId, body=None, x__xgafv=None)
@@ -22383,7 +22383,7 @@ Method Details
get(spreadsheetId, includeGridData=None, ranges=None, x__xgafv=None)
- Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a field mask listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.
+ Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. By default, data within grids is not returned. You can include grid data in one of 2 ways: * Specify a [field mask](https://developers.google.com/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData URL parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want. To retrieve only subsets of spreadsheet data, use the ranges URL parameter. Ranges are specified using [A1 notation](/sheets/api/guides/concepts#cell). You can define a single cell (for example, `A1`) or multiple cells (for example, `A1:D5`). You can also get cells from other sheets within the same spreadsheet (for example, `Sheet2!A1:C4`) or retrieve multiple ranges at once (for example, `?ranges=A1:D5&ranges=Sheet2!A1:C4`). Limiting the range returns only the portions of the spreadsheet that intersect the requested ranges.
Args:
spreadsheetId: string, The spreadsheet to request. (required)
@@ -26044,7 +26044,7 @@ Method Details
getByDataFilter(spreadsheetId, body=None, x__xgafv=None)
- Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data one of 2 ways: * Specify a field mask listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.
+ Returns the spreadsheet at the given ID. The caller must specify the spreadsheet ID. This method differs from GetSpreadsheet in that it allows selecting which subsets of spreadsheet data to return by specifying a dataFilters parameter. Multiple DataFilters can be specified. Specifying one or more data filters returns the portions of the spreadsheet that intersect ranges matched by any of the filters. By default, data within grids is not returned. You can include grid data one of 2 ways: * Specify a [field mask](https://developers.google.com/sheets/api/guides/field-masks) listing your desired fields using the `fields` URL parameter in HTTP * Set the includeGridData parameter to true. If a field mask is set, the `includeGridData` parameter is ignored For large spreadsheets, as a best practice, retrieve only the specific spreadsheet fields that you want.
Args:
spreadsheetId: string, The spreadsheet to request. (required)
diff --git a/docs/dyn/slides_v1.presentations.html b/docs/dyn/slides_v1.presentations.html
index 0013f68370e..cb028ee7300 100644
--- a/docs/dyn/slides_v1.presentations.html
+++ b/docs/dyn/slides_v1.presentations.html
@@ -105,7 +105,7 @@ Method Details
"requests": [ # A list of updates to apply to the presentation.
{ # A single kind of update to apply to a presentation.
"createImage": { # Creates an image. # Creates an image.
- "elementProperties": { # Common properties for a page element. Note: When you initially create a PageElement, the API may modify the values of both `size` and `transform`, but the visual size will be unchanged. # The element properties for the image. When the aspect ratio of the provided size does not match the image aspect ratio, the image is scaled and centered with respect to the size in order to maintain aspect ratio. The provided transform is applied after this operation. The PageElementProperties.size property is optional. If you don't specify the size, the default size of the image is used. The PageElementProperties.transform property is optional. If you don't specify a transform, the image will be placed at the top left corner of the page.
+ "elementProperties": { # Common properties for a page element. Note: When you initially create a PageElement, the API may modify the values of both `size` and `transform`, but the visual size will be unchanged. # The element properties for the image. When the aspect ratio of the provided size does not match the image aspect ratio, the image is scaled and centered with respect to the size in order to maintain the aspect ratio. The provided transform is applied after this operation. The PageElementProperties.size property is optional. If you don't specify the size, the default size of the image is used. The PageElementProperties.transform property is optional. If you don't specify a transform, the image will be placed at the top-left corner of the page.
"pageObjectId": "A String", # The object ID of the page where the element is located.
"size": { # A width and height. # The size of the element.
"height": { # A magnitude in a single direction in the specified units. # The height of the object.
@@ -128,7 +128,7 @@ Method Details
},
},
"objectId": "A String", # A user-supplied object ID. If you specify an ID, it must be unique among all pages and page elements in the presentation. The ID must start with an alphanumeric character or an underscore (matches regex `[a-zA-Z0-9_]`); remaining characters may include those as well as a hyphen or colon (matches regex `[a-zA-Z0-9_-:]`). The length of the ID must not be less than 5 or greater than 50. If you don't specify an ID, a unique one is generated.
- "url": "A String", # The image URL. The image is fetched once at insertion time and a copy is stored for display inside the presentation. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. The URL itself is saved with the image, and exposed via the Image.source_url field.
+ "url": "A String", # The image URL. The image is fetched once at insertion time and a copy is stored for display inside the presentation. Images must be less than 50 MB in size, can't exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF formats. The provided URL can be up to 2 KB in length. The URL is saved with the image, and exposed through the Image.source_url field.
},
"createLine": { # Creates a line. # Creates a line.
"category": "A String", # The category of the line to be created. The exact line type created is determined based on the category and how it's routed to connect to other page elements. If you specify both a `category` and a `line_category`, the `category` takes precedence. If you do not specify a value for `category`, but specify a value for `line_category`, then the specified `line_category` value is used. If you do not specify either, then STRAIGHT is used.
diff --git a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
index ffe0a325433..4db06328cdf 100644
--- a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
+++ b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html
@@ -428,14 +428,7 @@ Method Details
"arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
"code": "A String", # Required. The TypeCode for this type.
"protoTypeFqn": "A String", # If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully qualified name of the proto type representing the proto/enum definition.
- "structType": { # `StructType` defines the fields of a STRUCT type. # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
- "fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
- { # Message representing a single field of a struct.
- "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
- },
- ],
- },
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
"typeAnnotation": "A String", # The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.
},
},
@@ -496,7 +489,13 @@ Method Details
"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
{ # Message representing a single field of a struct.
"name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
+ "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field.
+ "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
+ "code": "A String", # Required. The TypeCode for this type.
+ "protoTypeFqn": "A String", # If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully qualified name of the proto type representing the proto/enum definition.
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
+ "typeAnnotation": "A String", # The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.
+ },
},
],
},
@@ -508,7 +507,13 @@ Method Details
"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
{ # Message representing a single field of a struct.
"name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
+ "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field.
+ "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
+ "code": "A String", # Required. The TypeCode for this type.
+ "protoTypeFqn": "A String", # If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully qualified name of the proto type representing the proto/enum definition.
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
+ "typeAnnotation": "A String", # The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.
+ },
},
],
},
@@ -582,14 +587,7 @@ Method Details
"arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
"code": "A String", # Required. The TypeCode for this type.
"protoTypeFqn": "A String", # If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully qualified name of the proto type representing the proto/enum definition.
- "structType": { # `StructType` defines the fields of a STRUCT type. # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
- "fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
- { # Message representing a single field of a struct.
- "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
- },
- ],
- },
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
"typeAnnotation": "A String", # The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.
},
},
@@ -659,7 +657,13 @@ Method Details
"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
{ # Message representing a single field of a struct.
"name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
+ "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field.
+ "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
+ "code": "A String", # Required. The TypeCode for this type.
+ "protoTypeFqn": "A String", # If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully qualified name of the proto type representing the proto/enum definition.
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
+ "typeAnnotation": "A String", # The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.
+ },
},
],
},
@@ -671,7 +675,13 @@ Method Details
"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
{ # Message representing a single field of a struct.
"name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
+ "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field.
+ "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
+ "code": "A String", # Required. The TypeCode for this type.
+ "protoTypeFqn": "A String", # If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully qualified name of the proto type representing the proto/enum definition.
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
+ "typeAnnotation": "A String", # The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.
+ },
},
],
},
@@ -734,14 +744,7 @@ Method Details
"arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
"code": "A String", # Required. The TypeCode for this type.
"protoTypeFqn": "A String", # If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully qualified name of the proto type representing the proto/enum definition.
- "structType": { # `StructType` defines the fields of a STRUCT type. # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
- "fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
- { # Message representing a single field of a struct.
- "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
- },
- ],
- },
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
"typeAnnotation": "A String", # The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.
},
},
@@ -812,7 +815,13 @@ Method Details
"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
{ # Message representing a single field of a struct.
"name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
+ "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field.
+ "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
+ "code": "A String", # Required. The TypeCode for this type.
+ "protoTypeFqn": "A String", # If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully qualified name of the proto type representing the proto/enum definition.
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
+ "typeAnnotation": "A String", # The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.
+ },
},
],
},
@@ -824,7 +833,13 @@ Method Details
"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
{ # Message representing a single field of a struct.
"name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
+ "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field.
+ "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
+ "code": "A String", # Required. The TypeCode for this type.
+ "protoTypeFqn": "A String", # If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully qualified name of the proto type representing the proto/enum definition.
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
+ "typeAnnotation": "A String", # The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.
+ },
},
],
},
@@ -958,14 +973,7 @@ Method Details
"arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
"code": "A String", # Required. The TypeCode for this type.
"protoTypeFqn": "A String", # If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully qualified name of the proto type representing the proto/enum definition.
- "structType": { # `StructType` defines the fields of a STRUCT type. # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
- "fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
- { # Message representing a single field of a struct.
- "name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
- },
- ],
- },
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
"typeAnnotation": "A String", # The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.
},
},
@@ -1228,7 +1236,13 @@ Method Details
"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
{ # Message representing a single field of a struct.
"name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
+ "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field.
+ "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
+ "code": "A String", # Required. The TypeCode for this type.
+ "protoTypeFqn": "A String", # If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully qualified name of the proto type representing the proto/enum definition.
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
+ "typeAnnotation": "A String", # The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.
+ },
},
],
},
@@ -1240,7 +1254,13 @@ Method Details
"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
{ # Message representing a single field of a struct.
"name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
+ "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field.
+ "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
+ "code": "A String", # Required. The TypeCode for this type.
+ "protoTypeFqn": "A String", # If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully qualified name of the proto type representing the proto/enum definition.
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
+ "typeAnnotation": "A String", # The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.
+ },
},
],
},
@@ -1410,7 +1430,13 @@ Method Details
"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
{ # Message representing a single field of a struct.
"name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
+ "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field.
+ "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
+ "code": "A String", # Required. The TypeCode for this type.
+ "protoTypeFqn": "A String", # If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully qualified name of the proto type representing the proto/enum definition.
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
+ "typeAnnotation": "A String", # The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.
+ },
},
],
},
@@ -1422,7 +1448,13 @@ Method Details
"fields": [ # The list of fields that make up this struct. Order is significant, because values of this struct type are represented as lists, where the order of field values matches the order of fields in the StructType. In turn, the order of fields matches the order of columns in a read request, or the order of fields in the `SELECT` clause of a query.
{ # Message representing a single field of a struct.
"name": "A String", # The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., `"Word"` in the query `"SELECT 'hello' AS Word"`), or the column name (e.g., `"ColName"` in the query `"SELECT ColName FROM Table"`). Some columns might have an empty name (e.g., `"SELECT UPPER(ColName)"`). Note that a query result can contain multiple fields with the same name.
- "type": # Object with schema name: Type # The type of the field.
+ "type": { # `Type` indicates the type of a Cloud Spanner value, as might be stored in a table cell or returned from an SQL query. # The type of the field.
+ "arrayElementType": # Object with schema name: Type # If code == ARRAY, then `array_element_type` is the type of the array elements.
+ "code": "A String", # Required. The TypeCode for this type.
+ "protoTypeFqn": "A String", # If code == PROTO or code == ENUM, then `proto_type_fqn` is the fully qualified name of the proto type representing the proto/enum definition.
+ "structType": # Object with schema name: StructType # If code == STRUCT, then `struct_type` provides type information for the struct's fields.
+ "typeAnnotation": "A String", # The TypeAnnotationCode that disambiguates SQL type that Spanner will use to represent values of this type during query processing. This is necessary for some type codes because a single TypeCode can be mapped to different SQL types depending on the SQL dialect. type_annotation typically is not needed to process the content of a value (it doesn't affect serialization) and clients can ignore it on the read path.
+ },
},
],
},
diff --git a/docs/dyn/speech_v1.speech.html b/docs/dyn/speech_v1.speech.html
index 564bd0de49c..75b5317daea 100644
--- a/docs/dyn/speech_v1.speech.html
+++ b/docs/dyn/speech_v1.speech.html
@@ -104,6 +104,11 @@ Method Details
},
"config": { # Provides information to the recognizer that specifies how to process the request. # Required. Provides information to the recognizer that specifies how to process the request.
"adaptation": { # Speech adaptation configuration. # Speech adaptation configuration improves the accuracy of speech recognition. For more information, see the [speech adaptation](https://cloud.google.com/speech-to-text/docs/adaptation) documentation. When speech adaptation is set it supersedes the `speech_contexts` field.
+ "abnfGrammar": { # Augmented Backus-Naur form (ABNF) is a standardized grammar notation comprised by a set of derivation rules. See specifications: https://www.w3.org/TR/speech-grammar
+ "abnfStrings": [ # All declarations and rules of an ABNF grammar broken up into multiple strings that will end up concatenated.
+ "A String",
+ ],
+ },
"customClasses": [ # A collection of custom classes. To specify the classes inline, leave the class' `name` blank and fill in the rest of its fields, giving it a unique `custom_class_id`. Refer to the inline defined class in phrase hints by its `custom_class_id`.
{ # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.
"customClassId": "A String", # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
@@ -222,6 +227,11 @@ Method Details
},
"config": { # Provides information to the recognizer that specifies how to process the request. # Required. Provides information to the recognizer that specifies how to process the request.
"adaptation": { # Speech adaptation configuration. # Speech adaptation configuration improves the accuracy of speech recognition. For more information, see the [speech adaptation](https://cloud.google.com/speech-to-text/docs/adaptation) documentation. When speech adaptation is set it supersedes the `speech_contexts` field.
+ "abnfGrammar": { # Augmented Backus-Naur form (ABNF) is a standardized grammar notation comprised by a set of derivation rules. See specifications: https://www.w3.org/TR/speech-grammar
+ "abnfStrings": [ # All declarations and rules of an ABNF grammar broken up into multiple strings that will end up concatenated.
+ "A String",
+ ],
+ },
"customClasses": [ # A collection of custom classes. To specify the classes inline, leave the class' `name` blank and fill in the rest of its fields, giving it a unique `custom_class_id`. Refer to the inline defined class in phrase hints by its `custom_class_id`.
{ # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.
"customClassId": "A String", # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
diff --git a/docs/dyn/speech_v1p1beta1.speech.html b/docs/dyn/speech_v1p1beta1.speech.html
index bb74b8983a6..ce392133071 100644
--- a/docs/dyn/speech_v1p1beta1.speech.html
+++ b/docs/dyn/speech_v1p1beta1.speech.html
@@ -104,6 +104,11 @@ Method Details
},
"config": { # Provides information to the recognizer that specifies how to process the request. # Required. Provides information to the recognizer that specifies how to process the request.
"adaptation": { # Speech adaptation configuration. # Speech adaptation configuration improves the accuracy of speech recognition. For more information, see the [speech adaptation](https://cloud.google.com/speech-to-text/docs/adaptation) documentation. When speech adaptation is set it supersedes the `speech_contexts` field.
+ "abnfGrammar": { # Augmented Backus-Naur form (ABNF) is a standardized grammar notation comprised by a set of derivation rules. See specifications: https://www.w3.org/TR/speech-grammar
+ "abnfStrings": [ # All declarations and rules of an ABNF grammar broken up into multiple strings that will end up concatenated.
+ "A String",
+ ],
+ },
"customClasses": [ # A collection of custom classes. To specify the classes inline, leave the class' `name` blank and fill in the rest of its fields, giving it a unique `custom_class_id`. Refer to the inline defined class in phrase hints by its `custom_class_id`.
{ # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.
"customClassId": "A String", # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
@@ -234,6 +239,11 @@ Method Details
},
"config": { # Provides information to the recognizer that specifies how to process the request. # Required. Provides information to the recognizer that specifies how to process the request.
"adaptation": { # Speech adaptation configuration. # Speech adaptation configuration improves the accuracy of speech recognition. For more information, see the [speech adaptation](https://cloud.google.com/speech-to-text/docs/adaptation) documentation. When speech adaptation is set it supersedes the `speech_contexts` field.
+ "abnfGrammar": { # Augmented Backus-Naur form (ABNF) is a standardized grammar notation comprised by a set of derivation rules. See specifications: https://www.w3.org/TR/speech-grammar
+ "abnfStrings": [ # All declarations and rules of an ABNF grammar broken up into multiple strings that will end up concatenated.
+ "A String",
+ ],
+ },
"customClasses": [ # A collection of custom classes. To specify the classes inline, leave the class' `name` blank and fill in the rest of its fields, giving it a unique `custom_class_id`. Refer to the inline defined class in phrase hints by its `custom_class_id`.
{ # A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.
"customClassId": "A String", # If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.
diff --git a/docs/dyn/texttospeech_v1.operations.html b/docs/dyn/texttospeech_v1.operations.html
index 20888b3a6eb..b0fb9c91c1e 100644
--- a/docs/dyn/texttospeech_v1.operations.html
+++ b/docs/dyn/texttospeech_v1.operations.html
@@ -83,15 +83,6 @@ Instance Methods
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`.
-
-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.
-
- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-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.
-
-Retrieves the next page of results.
Method Details
cancel(name, body=None, x__xgafv=None)
@@ -140,96 +131,4 @@ Method Details
}
-
- get(name, x__xgafv=None)
- 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.
-
-Args:
- name: string, The name of the operation resource. (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.
- "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.
- "error": { # 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). # The error result of the operation in case of failure or cancellation.
- "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.
- },
- ],
- "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.
- },
- "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.
- },
- "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}`.
- "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.
- },
-}
-
-
-
- list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
- 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.
-
-Args:
- name: string, The name of the operation's parent resource. (required)
- filter: string, The standard list filter.
- pageSize: integer, The standard list page size.
- pageToken: string, The standard list page token.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # The response message for Operations.ListOperations.
- "nextPageToken": "A String", # The standard List next-page token.
- "operations": [ # A list of operations that matches the specified filter in the request.
- { # This resource represents a long-running operation that is the result of a network API call.
- "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.
- "error": { # 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). # The error result of the operation in case of failure or cancellation.
- "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.
- },
- ],
- "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.
- },
- "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.
- },
- "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}`.
- "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.
- },
- },
- ],
-}
-
-
-
- list_next()
- 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.
-
-
-