com.google.api.services.integrations.v1alpha.model.EnterpriseCrmEventbusProtoTaskMetadata Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.integrations.v1alpha.model;
/**
* TaskMetadata are attributes that are associated to every common Task we have. Next available: 26
*
* This is the Java data model class that specifies how to parse/serialize into the JSON that is
* transmitted over HTTP when working with the Application Integration API. For a detailed
* explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class EnterpriseCrmEventbusProtoTaskMetadata extends com.google.api.client.json.GenericJson {
/**
* The new task name to replace the current task if it is deprecated. Otherwise, it is the same as
* the current task name.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String activeTaskName;
/**
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List admins;
/**
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String category;
/**
* The Code Search link to the Task Java file.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String codeSearchLink;
/**
* Controls whether JSON workflow parameters are validated against provided schemas before and/or
* after this task's execution.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String defaultJsonValidationOption;
/**
* Contains the initial configuration of the task with default values set. For now, The string
* should be compatible to an ASCII-proto format.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String defaultSpec;
/**
* In a few sentences, describe the purpose and usage of the task.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String description;
/**
* 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")
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String descriptiveName;
/**
* Snippet of markdown documentation to embed in the RHP for this task.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String docMarkdown;
/**
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String externalCategory;
/**
* Sequence with which the task in specific category to be displayed in task discovery panel for
* external users.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Integer externalCategorySequence;
/**
* External-facing documention embedded in the RHP for this task.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String externalDocHtml;
/**
* Doc link for external-facing documentation (separate from g3doc).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String externalDocLink;
/**
* DEPRECATED: Use external_doc_html.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String externalDocMarkdown;
/**
* URL to the associated G3 Doc for the task if available
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String g3DocLink;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String iconLink;
/**
* The deprecation status of the current task. Default value is false;
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean isDeprecated;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String name;
/**
* External-facing documention for standalone IP in pantheon embedded in the RHP for this task.
* Non null only if different from external_doc_html
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String standaloneExternalDocHtml;
/**
* Allows author to indicate if the task is ready to use or not. If not set, then it will default
* to INACTIVE.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String status;
/**
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String system;
/**
* 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List tags;
/**
* The new task name to replace the current task if it is deprecated. Otherwise, it is the same as
* the current task name.
* @return value or {@code null} for none
*/
public java.lang.String getActiveTaskName() {
return activeTaskName;
}
/**
* The new task name to replace the current task if it is deprecated. Otherwise, it is the same as
* the current task name.
* @param activeTaskName activeTaskName or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setActiveTaskName(java.lang.String activeTaskName) {
this.activeTaskName = activeTaskName;
return this;
}
/**
* @return value or {@code null} for none
*/
public java.util.List getAdmins() {
return admins;
}
/**
* @param admins admins or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setAdmins(java.util.List admins) {
this.admins = admins;
return this;
}
/**
* @return value or {@code null} for none
*/
public java.lang.String getCategory() {
return category;
}
/**
* @param category category or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setCategory(java.lang.String category) {
this.category = category;
return this;
}
/**
* The Code Search link to the Task Java file.
* @return value or {@code null} for none
*/
public java.lang.String getCodeSearchLink() {
return codeSearchLink;
}
/**
* The Code Search link to the Task Java file.
* @param codeSearchLink codeSearchLink or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setCodeSearchLink(java.lang.String codeSearchLink) {
this.codeSearchLink = codeSearchLink;
return this;
}
/**
* Controls whether JSON workflow parameters are validated against provided schemas before and/or
* after this task's execution.
* @return value or {@code null} for none
*/
public java.lang.String getDefaultJsonValidationOption() {
return defaultJsonValidationOption;
}
/**
* Controls whether JSON workflow parameters are validated against provided schemas before and/or
* after this task's execution.
* @param defaultJsonValidationOption defaultJsonValidationOption or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setDefaultJsonValidationOption(java.lang.String defaultJsonValidationOption) {
this.defaultJsonValidationOption = defaultJsonValidationOption;
return this;
}
/**
* Contains the initial configuration of the task with default values set. For now, The string
* should be compatible to an ASCII-proto format.
* @return value or {@code null} for none
*/
public java.lang.String getDefaultSpec() {
return defaultSpec;
}
/**
* Contains the initial configuration of the task with default values set. For now, The string
* should be compatible to an ASCII-proto format.
* @param defaultSpec defaultSpec or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setDefaultSpec(java.lang.String defaultSpec) {
this.defaultSpec = defaultSpec;
return this;
}
/**
* In a few sentences, describe the purpose and usage of the task.
* @return value or {@code null} for none
*/
public java.lang.String getDescription() {
return description;
}
/**
* In a few sentences, describe the purpose and usage of the task.
* @param description description or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setDescription(java.lang.String description) {
this.description = description;
return this;
}
/**
* 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")
* @return value or {@code null} for none
*/
public java.lang.String getDescriptiveName() {
return descriptiveName;
}
/**
* 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")
* @param descriptiveName descriptiveName or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setDescriptiveName(java.lang.String descriptiveName) {
this.descriptiveName = descriptiveName;
return this;
}
/**
* Snippet of markdown documentation to embed in the RHP for this task.
* @return value or {@code null} for none
*/
public java.lang.String getDocMarkdown() {
return docMarkdown;
}
/**
* Snippet of markdown documentation to embed in the RHP for this task.
* @param docMarkdown docMarkdown or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setDocMarkdown(java.lang.String docMarkdown) {
this.docMarkdown = docMarkdown;
return this;
}
/**
* @return value or {@code null} for none
*/
public java.lang.String getExternalCategory() {
return externalCategory;
}
/**
* @param externalCategory externalCategory or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setExternalCategory(java.lang.String externalCategory) {
this.externalCategory = externalCategory;
return this;
}
/**
* Sequence with which the task in specific category to be displayed in task discovery panel for
* external users.
* @return value or {@code null} for none
*/
public java.lang.Integer getExternalCategorySequence() {
return externalCategorySequence;
}
/**
* Sequence with which the task in specific category to be displayed in task discovery panel for
* external users.
* @param externalCategorySequence externalCategorySequence or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setExternalCategorySequence(java.lang.Integer externalCategorySequence) {
this.externalCategorySequence = externalCategorySequence;
return this;
}
/**
* External-facing documention embedded in the RHP for this task.
* @return value or {@code null} for none
*/
public java.lang.String getExternalDocHtml() {
return externalDocHtml;
}
/**
* External-facing documention embedded in the RHP for this task.
* @param externalDocHtml externalDocHtml or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setExternalDocHtml(java.lang.String externalDocHtml) {
this.externalDocHtml = externalDocHtml;
return this;
}
/**
* Doc link for external-facing documentation (separate from g3doc).
* @return value or {@code null} for none
*/
public java.lang.String getExternalDocLink() {
return externalDocLink;
}
/**
* Doc link for external-facing documentation (separate from g3doc).
* @param externalDocLink externalDocLink or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setExternalDocLink(java.lang.String externalDocLink) {
this.externalDocLink = externalDocLink;
return this;
}
/**
* DEPRECATED: Use external_doc_html.
* @return value or {@code null} for none
*/
public java.lang.String getExternalDocMarkdown() {
return externalDocMarkdown;
}
/**
* DEPRECATED: Use external_doc_html.
* @param externalDocMarkdown externalDocMarkdown or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setExternalDocMarkdown(java.lang.String externalDocMarkdown) {
this.externalDocMarkdown = externalDocMarkdown;
return this;
}
/**
* URL to the associated G3 Doc for the task if available
* @return value or {@code null} for none
*/
public java.lang.String getG3DocLink() {
return g3DocLink;
}
/**
* URL to the associated G3 Doc for the task if available
* @param g3DocLink g3DocLink or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setG3DocLink(java.lang.String g3DocLink) {
this.g3DocLink = g3DocLink;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getIconLink() {
return iconLink;
}
/**
* 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.
* @param iconLink iconLink or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setIconLink(java.lang.String iconLink) {
this.iconLink = iconLink;
return this;
}
/**
* The deprecation status of the current task. Default value is false;
* @return value or {@code null} for none
*/
public java.lang.Boolean getIsDeprecated() {
return isDeprecated;
}
/**
* The deprecation status of the current task. Default value is false;
* @param isDeprecated isDeprecated or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setIsDeprecated(java.lang.Boolean isDeprecated) {
this.isDeprecated = isDeprecated;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.lang.String getName() {
return name;
}
/**
* 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.
* @param name name or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setName(java.lang.String name) {
this.name = name;
return this;
}
/**
* External-facing documention for standalone IP in pantheon embedded in the RHP for this task.
* Non null only if different from external_doc_html
* @return value or {@code null} for none
*/
public java.lang.String getStandaloneExternalDocHtml() {
return standaloneExternalDocHtml;
}
/**
* External-facing documention for standalone IP in pantheon embedded in the RHP for this task.
* Non null only if different from external_doc_html
* @param standaloneExternalDocHtml standaloneExternalDocHtml or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setStandaloneExternalDocHtml(java.lang.String standaloneExternalDocHtml) {
this.standaloneExternalDocHtml = standaloneExternalDocHtml;
return this;
}
/**
* Allows author to indicate if the task is ready to use or not. If not set, then it will default
* to INACTIVE.
* @return value or {@code null} for none
*/
public java.lang.String getStatus() {
return status;
}
/**
* Allows author to indicate if the task is ready to use or not. If not set, then it will default
* to INACTIVE.
* @param status status or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setStatus(java.lang.String status) {
this.status = status;
return this;
}
/**
* @return value or {@code null} for none
*/
public java.lang.String getSystem() {
return system;
}
/**
* @param system system or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setSystem(java.lang.String system) {
this.system = system;
return this;
}
/**
* 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.
* @return value or {@code null} for none
*/
public java.util.List getTags() {
return 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.
* @param tags tags or {@code null} for none
*/
public EnterpriseCrmEventbusProtoTaskMetadata setTags(java.util.List tags) {
this.tags = tags;
return this;
}
@Override
public EnterpriseCrmEventbusProtoTaskMetadata set(String fieldName, Object value) {
return (EnterpriseCrmEventbusProtoTaskMetadata) super.set(fieldName, value);
}
@Override
public EnterpriseCrmEventbusProtoTaskMetadata clone() {
return (EnterpriseCrmEventbusProtoTaskMetadata) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy