com.ibm.watson.assistant.v1.model.ListMentionsOptions Maven / Gradle / Ivy
/*
* (C) Copyright IBM Corp. 2018, 2020.
*
* 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.
*/
package com.ibm.watson.assistant.v1.model;
import com.ibm.cloud.sdk.core.service.model.GenericModel;
/** The listMentions options. */
public class ListMentionsOptions extends GenericModel {
protected String workspaceId;
protected String entity;
protected Boolean export;
protected Boolean includeAudit;
/** Builder. */
public static class Builder {
private String workspaceId;
private String entity;
private Boolean export;
private Boolean includeAudit;
private Builder(ListMentionsOptions listMentionsOptions) {
this.workspaceId = listMentionsOptions.workspaceId;
this.entity = listMentionsOptions.entity;
this.export = listMentionsOptions.export;
this.includeAudit = listMentionsOptions.includeAudit;
}
/** Instantiates a new builder. */
public Builder() {}
/**
* Instantiates a new builder with required properties.
*
* @param workspaceId the workspaceId
* @param entity the entity
*/
public Builder(String workspaceId, String entity) {
this.workspaceId = workspaceId;
this.entity = entity;
}
/**
* Builds a ListMentionsOptions.
*
* @return the new ListMentionsOptions instance
*/
public ListMentionsOptions build() {
return new ListMentionsOptions(this);
}
/**
* Set the workspaceId.
*
* @param workspaceId the workspaceId
* @return the ListMentionsOptions builder
*/
public Builder workspaceId(String workspaceId) {
this.workspaceId = workspaceId;
return this;
}
/**
* Set the entity.
*
* @param entity the entity
* @return the ListMentionsOptions builder
*/
public Builder entity(String entity) {
this.entity = entity;
return this;
}
/**
* Set the export.
*
* @param export the export
* @return the ListMentionsOptions builder
*/
public Builder export(Boolean export) {
this.export = export;
return this;
}
/**
* Set the includeAudit.
*
* @param includeAudit the includeAudit
* @return the ListMentionsOptions builder
*/
public Builder includeAudit(Boolean includeAudit) {
this.includeAudit = includeAudit;
return this;
}
}
protected ListMentionsOptions(Builder builder) {
com.ibm.cloud.sdk.core.util.Validator.notEmpty(
builder.workspaceId, "workspaceId cannot be empty");
com.ibm.cloud.sdk.core.util.Validator.notEmpty(builder.entity, "entity cannot be empty");
workspaceId = builder.workspaceId;
entity = builder.entity;
export = builder.export;
includeAudit = builder.includeAudit;
}
/**
* New builder.
*
* @return a ListMentionsOptions builder
*/
public Builder newBuilder() {
return new Builder(this);
}
/**
* Gets the workspaceId.
*
* Unique identifier of the workspace.
*
* @return the workspaceId
*/
public String workspaceId() {
return workspaceId;
}
/**
* Gets the entity.
*
*
The name of the entity.
*
* @return the entity
*/
public String entity() {
return entity;
}
/**
* Gets the export.
*
*
Whether to include all element content in the returned data. If **export**=`false`, the
* returned data includes only information about the element itself. If **export**=`true`, all
* content, including subelements, is included.
*
* @return the export
*/
public Boolean export() {
return export;
}
/**
* Gets the includeAudit.
*
*
Whether to include the audit properties (`created` and `updated` timestamps) in the
* response.
*
* @return the includeAudit
*/
public Boolean includeAudit() {
return includeAudit;
}
}