Navigation Menu

Skip to content

Commit

Permalink
feat(integrations): update the api
Browse files Browse the repository at this point in the history 
#### integrations:v1alpha

The following keys were deleted:
- resources.projects.resources.locations.methods.listTaskEntities (Total Keys: 11)
- resources.projects.resources.locations.resources.integrations.resources.versions.methods.archive (Total Keys: 12)
- resources.projects.resources.locations.resources.integrations.resources.versions.methods.deactivate (Total Keys: 12)
- resources.projects.resources.locations.resources.integrations.resources.versions.methods.validate (Total Keys: 12)
- resources.projects.resources.locations.resources.products.methods.createBundle (Total Keys: 12)
- resources.projects.resources.locations.resources.products.methods.listTaskEntities (Total Keys: 11)
- resources.projects.resources.locations.resources.products.resources.integrations.methods.archiveBundle (Total Keys: 12)
- resources.projects.resources.locations.resources.products.resources.integrations.resources.executionsnapshots.methods.list (Total Keys: 21)
- resources.projects.resources.locations.resources.products.resources.integrations.resources.versions.methods.archive (Total Keys: 12)
- resources.projects.resources.locations.resources.products.resources.integrations.resources.versions.methods.deactivate (Total Keys: 12)
- resources.projects.resources.locations.resources.products.resources.integrations.resources.versions.methods.getBundle (Total Keys: 11)
- resources.projects.resources.locations.resources.products.resources.integrations.resources.versions.methods.updateBundle (Total Keys: 12)
- resources.projects.resources.locations.resources.products.resources.integrations.resources.versions.methods.validate (Total Keys: 12)
- schemas.GoogleCloudIntegrationsV1alphaArchiveBundleRequest (Total Keys: 2)
- schemas.GoogleCloudIntegrationsV1alphaArchiveBundleResponse (Total Keys: 2)
- schemas.GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionRequest (Total Keys: 2)
- schemas.GoogleCloudIntegrationsV1alphaArchiveIntegrationVersionResponse (Total Keys: 2)
- schemas.GoogleCloudIntegrationsV1alphaCreateBundleRequest (Total Keys: 6)
- schemas.GoogleCloudIntegrationsV1alphaCreateBundleResponse (Total Keys: 4)
- schemas.GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionRequest (Total Keys: 2)
- schemas.GoogleCloudIntegrationsV1alphaDeactivateIntegrationVersionResponse (Total Keys: 2)
- schemas.GoogleCloudIntegrationsV1alphaGetBundleResponse (Total Keys: 3)
- schemas.GoogleCloudIntegrationsV1alphaIntegrationBundleConfig (Total Keys: 6)
- schemas.GoogleCloudIntegrationsV1alphaListExecutionSnapshotsResponse (Total Keys: 5)
- schemas.GoogleCloudIntegrationsV1alphaListTaskEntitiesResponse (Total Keys: 4)
- schemas.GoogleCloudIntegrationsV1alphaUpdateBundleRequest (Total Keys: 3)
- schemas.GoogleCloudIntegrationsV1alphaUpdateBundleResponse (Total Keys: 3)
- schemas.GoogleCloudIntegrationsV1alphaValidateIntegrationVersionRequest (Total Keys: 2)
- schemas.GoogleCloudIntegrationsV1alphaValidateIntegrationVersionResponse (Total Keys: 2)
  • Loading branch information
@yoshi-automation
yoshi-automation committed Feb 1, 2023
1 parent add703c commit b547436
Show file tree
Hide file tree
Showing 12 changed files with 324 additions and 1,506 deletions.
166 changes: 0 additions & 166 deletions docs/dyn/integrations_v1alpha.projects.locations.html
View file
Expand Up @@ -112,176 +112,10 @@ <h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#listTaskEntities">listTaskEntities(parent, x__xgafv=None)</a></code></p>
<p class="firstline">This is a UI only method and will be moved away. Returns a list of common tasks.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>

<div class="method">
<code class="details" id="listTaskEntities">listTaskEntities(parent, x__xgafv=None)</code>
<pre>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.
&quot;taskEntities&quot;: [ # The list of the tasks.
{ # Contains a task&#x27;s metadata and associated information. Next available id: 7
&quot;disabledForVpcSc&quot;: True or False, # True if the task has conflict with vpcsc
&quot;metadata&quot;: { # TaskMetadata are attributes that are associated to every common Task we have. Next available: 26 # Metadata inclueds the task name, author and so on.
&quot;activeTaskName&quot;: &quot;A String&quot;, # The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.
&quot;admins&quot;: [
{ # 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.
&quot;googleGroupEmail&quot;: &quot;A String&quot;,
&quot;userEmail&quot;: &quot;A String&quot;,
},
],
&quot;category&quot;: &quot;A String&quot;,
&quot;codeSearchLink&quot;: &quot;A String&quot;, # The Code Search link to the Task Java file.
&quot;defaultJsonValidationOption&quot;: &quot;A String&quot;, # Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task&#x27;s execution.
&quot;defaultSpec&quot;: &quot;A String&quot;, # Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.
&quot;description&quot;: &quot;A String&quot;, # In a few sentences, describe the purpose and usage of the task.
&quot;descriptiveName&quot;: &quot;A String&quot;, # 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. &quot;Send Mail&quot;)
&quot;docMarkdown&quot;: &quot;A String&quot;, # Snippet of markdown documentation to embed in the RHP for this task.
&quot;externalCategory&quot;: &quot;A String&quot;,
&quot;externalCategorySequence&quot;: 42, # Sequence with which the task in specific category to be displayed in task discovery panel for external users.
&quot;externalDocHtml&quot;: &quot;A String&quot;, # External-facing documention embedded in the RHP for this task.
&quot;externalDocLink&quot;: &quot;A String&quot;, # Doc link for external-facing documentation (separate from g3doc).
&quot;externalDocMarkdown&quot;: &quot;A String&quot;, # DEPRECATED: Use external_doc_html.
&quot;g3DocLink&quot;: &quot;A String&quot;, # URL to the associated G3 Doc for the task if available
&quot;iconLink&quot;: &quot;A String&quot;, # 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.
&quot;isDeprecated&quot;: True or False, # The deprecation status of the current task. Default value is false;
&quot;name&quot;: &quot;A String&quot;, # 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.
&quot;standaloneExternalDocHtml&quot;: &quot;A String&quot;, # External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html
&quot;status&quot;: &quot;A String&quot;, # Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.
&quot;system&quot;: &quot;A String&quot;,
&quot;tags&quot;: [ # A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names (&quot;REST Caller&quot; vs. &quot;Call REST Endpoint&quot;) or to help users find tasks based on related words.
&quot;A String&quot;,
],
},
&quot;paramSpecs&quot;: { # Declarations for inputs/outputs for a TypedTask. This is also associated with the METADATA mask.
&quot;parameters&quot;: [
{ # Key-value pair of EventBus task parameters. Next id: 13
&quot;className&quot;: &quot;A String&quot;, # The FQCN of the Java object this represents. A string, for example, would be &quot;java.lang.String&quot;. If this is &quot;java.lang.Object&quot;, the parameter can be of any type.
&quot;collectionElementClassName&quot;: &quot;A String&quot;, # If it is a collection of objects, this would be the FCQN of every individual element in the collection. If this is &quot;java.lang.Object&quot;, the parameter is a collection of any type.
&quot;config&quot;: { # Optional fields, such as help text and other useful info.
&quot;descriptivePhrase&quot;: &quot;A String&quot;, # A short phrase to describe what this parameter contains.
&quot;helpText&quot;: &quot;A String&quot;, # Detailed help text for this parameter containing information not provided elsewhere. For example, instructions on how to migrate from a deprecated parameter.
&quot;hideDefaultValue&quot;: True or False, # Whether the default value is hidden in the UI.
&quot;inputDisplayOption&quot;: &quot;A String&quot;,
&quot;isHidden&quot;: True or False, # Whether this field is hidden in the UI.
&quot;label&quot;: &quot;A String&quot;, # A user-friendly label for the parameter.
&quot;parameterNameOption&quot;: &quot;A String&quot;,
&quot;subSectionLabel&quot;: &quot;A String&quot;, # A user-friendly label for subSection under which the parameter will be displayed.
&quot;uiPlaceholderText&quot;: &quot;A String&quot;, # Placeholder text which will appear in the UI input form for this parameter.
},
&quot;dataType&quot;: &quot;A String&quot;, # The data type of the parameter.
&quot;defaultValue&quot;: { # 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.
&quot;booleanArray&quot;: {
&quot;booleanValues&quot;: [
True or False,
],
},
&quot;booleanValue&quot;: True or False,
&quot;doubleArray&quot;: {
&quot;doubleValues&quot;: [
3.14,
],
},
&quot;doubleValue&quot;: 3.14,
&quot;intArray&quot;: {
&quot;intValues&quot;: [
&quot;A String&quot;,
],
},
&quot;intValue&quot;: &quot;A String&quot;,
&quot;jsonValue&quot;: &quot;A String&quot;,
&quot;protoArray&quot;: {
&quot;protoValues&quot;: [
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
},
&quot;protoValue&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;serializedObjectValue&quot;: {
&quot;objectValue&quot;: &quot;A String&quot;,
},
&quot;stringArray&quot;: {
&quot;stringValues&quot;: [
&quot;A String&quot;,
],
},
&quot;stringValue&quot;: &quot;A String&quot;,
},
&quot;isDeprecated&quot;: True or False, # If set, this entry is deprecated, so further use of this parameter should be prohibited.
&quot;isOutput&quot;: True or False,
&quot;jsonSchema&quot;: &quot;A String&quot;, # If the data_type is JSON_VALUE, then this will define its schema.
&quot;key&quot;: &quot;A String&quot;, # 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.
&quot;protoDef&quot;: { # Populated if this represents a proto or proto array.
&quot;fullName&quot;: &quot;A String&quot;, # The fully-qualified proto name. This message, for example, would be &quot;enterprise.crm.eventbus.proto.ParamSpecEntry.ProtoDefinition&quot;.
&quot;path&quot;: &quot;A String&quot;, # Path to the proto file that contains the message type&#x27;s definition.
},
&quot;required&quot;: True or False, # If set, the user must provide an input value for this parameter.
&quot;validationRule&quot;: { # Rule used to validate inputs (individual values and collection elements) for this parameter.
&quot;doubleRange&quot;: { # Range used to validate doubles and floats.
&quot;max&quot;: 3.14, # The inclusive maximum of the acceptable range.
&quot;min&quot;: 3.14, # The inclusive minimum of the acceptable range.
},
&quot;intRange&quot;: { # Range used to validate longs and ints.
&quot;max&quot;: &quot;A String&quot;, # The inclusive maximum of the acceptable range.
&quot;min&quot;: &quot;A String&quot;, # The inclusive minimum of the acceptable range.
},
&quot;stringRegex&quot;: { # Rule used to validate strings.
&quot;exclusive&quot;: True or False, # Whether the regex matcher is applied exclusively (if true, matching values will be rejected).
&quot;regex&quot;: &quot;A String&quot;, # The regex applied to the input value(s).
},
},
},
],
},
&quot;stats&quot;: { # Stats for the requested dimensions: QPS, duration, and error/warning rate # Deprecated - statistics from the Monarch query.
&quot;dimensions&quot;: { # Dimensions that these stats have been aggregated on.
&quot;clientId&quot;: &quot;A String&quot;,
&quot;enumFilterType&quot;: &quot;A String&quot;, # Whether to include or exclude the enums matching the regex.
&quot;errorEnumString&quot;: &quot;A String&quot;,
&quot;retryAttempt&quot;: &quot;A String&quot;,
&quot;taskName&quot;: &quot;A String&quot;,
&quot;taskNumber&quot;: &quot;A String&quot;,
&quot;triggerId&quot;: &quot;A String&quot;, # Stats have been or will be aggregated on set fields for any semantically-meaningful combination.
&quot;warningEnumString&quot;: &quot;A String&quot;,
&quot;workflowId&quot;: &quot;A String&quot;,
&quot;workflowName&quot;: &quot;A String&quot;,
},
&quot;durationInSeconds&quot;: 3.14, # Average duration in seconds.
&quot;errorRate&quot;: 3.14, # Average error rate.
&quot;qps&quot;: 3.14, # Queries per second.
&quot;warningRate&quot;: 3.14, # Average warning rate.
},
&quot;taskType&quot;: &quot;A String&quot;, # Defines the type of the task
&quot;uiConfig&quot;: { # 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.
&quot;taskUiModuleConfigs&quot;: [ # Configurations of included config modules.
{ # Task author would use this type to configure a config module.
&quot;moduleId&quot;: &quot;A String&quot;, # ID of the config module.
},
],
},
},
],
}</pre>
</div>

</body></html>

0 comments on commit b547436

Please sign in to comment.