DataSource (Cloud Search API v1 (Rev. 47) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.cloudsearch.v1.model.DataSource

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class DataSource
extends com.google.api.client.json.GenericJson
```
Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.
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 Cloud Search API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

DataSource()

Constructors
Constructor and Description
`DataSource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataSource`	`clone()`
`java.lang.Boolean`	`getDisableModifications()` If true, Indexing API rejects any modification calls to this datasource such as create, update, and delete.
`java.lang.Boolean`	`getDisableServing()` Disable serving any search or assist results.
`java.lang.String`	`getDisplayName()` Required.
`java.util.List<java.lang.String>`	`getIndexingServiceAccounts()` List of service accounts that have indexing access.
`java.util.List<GSuitePrincipal>`	`getItemsVisibility()` This field restricts visibility to items at the datasource level.
`java.lang.String`	`getName()` Name of the datasource resource.
`java.util.List<java.lang.String>`	`getOperationIds()` IDs of the Long Running Operations (LROs) currently running for this schema.
`java.lang.String`	`getShortName()` A short name or alias for the source.
`DataSource`	`set(java.lang.String fieldName, java.lang.Object value)`
`DataSource`	`setDisableModifications(java.lang.Boolean disableModifications)` If true, Indexing API rejects any modification calls to this datasource such as create, update, and delete.
`DataSource`	`setDisableServing(java.lang.Boolean disableServing)` Disable serving any search or assist results.
`DataSource`	`setDisplayName(java.lang.String displayName)` Required.
`DataSource`	`setIndexingServiceAccounts(java.util.List<java.lang.String> indexingServiceAccounts)` List of service accounts that have indexing access.
`DataSource`	`setItemsVisibility(java.util.List<GSuitePrincipal> itemsVisibility)` This field restricts visibility to items at the datasource level.
`DataSource`	`setName(java.lang.String name)` Name of the datasource resource.
`DataSource`	`setOperationIds(java.util.List<java.lang.String> operationIds)` IDs of the Long Running Operations (LROs) currently running for this schema.
`DataSource`	`setShortName(java.lang.String shortName)` A short name or alias for the source.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - DataSource
```
public DataSource()
```
- Method Detail
  - getDisableModifications
```
public java.lang.Boolean getDisableModifications()
```
    If true, Indexing API rejects any modification calls to this datasource such as create, update, and delete. Disabling this does not imply halting process of previously accepted data.
    
    Returns:
    
    value or null for none
  - setDisableModifications
```
public DataSource setDisableModifications(java.lang.Boolean disableModifications)
```
    If true, Indexing API rejects any modification calls to this datasource such as create, update, and delete. Disabling this does not imply halting process of previously accepted data.
    
    Parameters:
    
    disableModifications - disableModifications or null for none
  - getDisableServing
```
public java.lang.Boolean getDisableServing()
```
    Disable serving any search or assist results.
    
    Returns:
    
    value or null for none
  - setDisableServing
```
public DataSource setDisableServing(java.lang.Boolean disableServing)
```
    Disable serving any search or assist results.
    
    Parameters:
    
    disableServing - disableServing or null for none
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Required. Display name of the datasource The maximum length is 300 characters.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public DataSource setDisplayName(java.lang.String displayName)
```
    Required. Display name of the datasource The maximum length is 300 characters.
    
    Parameters:
    
    displayName - displayName or null for none
  - getIndexingServiceAccounts
```
public java.util.List<java.lang.String> getIndexingServiceAccounts()
```
    List of service accounts that have indexing access.
    
    Returns:
    
    value or null for none
  - setIndexingServiceAccounts
```
public DataSource setIndexingServiceAccounts(java.util.List<java.lang.String> indexingServiceAccounts)
```
    List of service accounts that have indexing access.
    
    Parameters:
    
    indexingServiceAccounts - indexingServiceAccounts or null for none
  - getItemsVisibility
```
public java.util.List<GSuitePrincipal> getItemsVisibility()
```
    This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
    
    Returns:
    
    value or null for none
  - setItemsVisibility
```
public DataSource setItemsVisibility(java.util.List<GSuitePrincipal> itemsVisibility)
```
    This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.
    
    Parameters:
    
    itemsVisibility - itemsVisibility or null for none
  - getName
```
public java.lang.String getName()
```
    Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
    
    Returns:
    
    value or null for none
  - setName
```
public DataSource setName(java.lang.String name)
```
    Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.
    
    Parameters:
    
    name - name or null for none
  - getOperationIds
```
public java.util.List<java.lang.String> getOperationIds()
```
    IDs of the Long Running Operations (LROs) currently running for this schema.
    
    Returns:
    
    value or null for none
  - setOperationIds
```
public DataSource setOperationIds(java.util.List<java.lang.String> operationIds)
```
    IDs of the Long Running Operations (LROs) currently running for this schema.
    
    Parameters:
    
    operationIds - operationIds or null for none
  - getShortName
```
public java.lang.String getShortName()
```
    A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *value* then queries like *source:value* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
    
    Returns:
    
    value or null for none
  - setShortName
```
public DataSource setShortName(java.lang.String shortName)
```
    A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *value* then queries like *source:value* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.
    
    Parameters:
    
    shortName - shortName or null for none
  - set
```
public DataSource set(java.lang.String fieldName,
                      java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public DataSource clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Search API v1 (revision 47)

Class DataSource

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

DataSource

Method Detail

getDisableModifications

setDisableModifications

getDisableServing

setDisableServing

getDisplayName

setDisplayName

getIndexingServiceAccounts

setIndexingServiceAccounts

getItemsVisibility

setItemsVisibility

getName

setName

getOperationIds

setOperationIds

getShortName

setShortName

set

clone