<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.settings.html">settings</a> . <a href="cloudsearch_v1.settings.datasources.html">datasources</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a datasource.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a datasource.</p>
<p class="toc_element">
  <code><a href="#get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a datasource.</p>
<p class="toc_element">
  <code><a href="#list">list(pageSize=None, pageToken=None, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists datasources.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a datasource.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="create">create(body=None, x__xgafv=None)</code>
  <pre>Creates a datasource.

**Note:** This API requires an admin account to execute.

Args:
  body: object, The request body.
    The object takes the form of:

{ # 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.
  &quot;name&quot;: &quot;A String&quot;, # Name of the datasource resource.
      # Format: datasources/{source_id}.
      # &lt;br /&gt;The name is ignored when creating a datasource.
  &quot;disableModifications&quot;: True or False, # 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.
  &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
    &quot;A String&quot;,
  ],
  &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
  &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source.  This value will be used to match the
      # &#x27;source&#x27; operator. For example, if the short name is *&amp;lt;value&amp;gt;* then
      # queries like *source:&amp;lt;value&amp;gt;* 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 &#x27;google&#x27; 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.
  &quot;itemsVisibility&quot;: [ # 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.
    {
      &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
      &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the
          # customer.
      &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
    },
  ],
  &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this
      # schema.
    &quot;A String&quot;,
  ],
  &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource
      # The maximum length is 300 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.
    &quot;response&quot;: { # 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`.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;metadata&quot;: { # 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.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # 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).
      &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # 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.
      &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    },
    &quot;name&quot;: &quot;A String&quot;, # 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}`.
    &quot;done&quot;: 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.
  }</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
  <pre>Deletes a datasource.

**Note:** This API requires an admin account to execute.

Args:
  name: string, Name of the datasource.
Format: datasources/{source_id}. (required)
  debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
Otherwise, ignore this field.
  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.
    &quot;response&quot;: { # 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`.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;metadata&quot;: { # 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.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # 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).
      &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # 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.
      &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    },
    &quot;name&quot;: &quot;A String&quot;, # 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}`.
    &quot;done&quot;: 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.
  }</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>
  <pre>Gets a datasource.

**Note:** This API requires an admin account to execute.

Args:
  name: string, Name of the datasource resource.
Format: datasources/{source_id}. (required)
  debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
Otherwise, ignore this field.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
    &quot;name&quot;: &quot;A String&quot;, # Name of the datasource resource.
        # Format: datasources/{source_id}.
        # &lt;br /&gt;The name is ignored when creating a datasource.
    &quot;disableModifications&quot;: True or False, # 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.
    &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
      &quot;A String&quot;,
    ],
    &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
    &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source.  This value will be used to match the
        # &#x27;source&#x27; operator. For example, if the short name is *&amp;lt;value&amp;gt;* then
        # queries like *source:&amp;lt;value&amp;gt;* 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 &#x27;google&#x27; 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.
    &quot;itemsVisibility&quot;: [ # 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.
      {
        &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
        &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the
            # customer.
        &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
      },
    ],
    &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this
        # schema.
      &quot;A String&quot;,
    ],
    &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource
        # The maximum length is 300 characters.
  }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(pageSize=None, pageToken=None, debugOptions_enableDebugging=None, x__xgafv=None)</code>
  <pre>Lists datasources.

**Note:** This API requires an admin account to execute.

Args:
  pageSize: integer, Maximum number of datasources to fetch in a request.
The max value is 100.
&lt;br /&gt;The default value is 10
  pageToken: string, Starting index of the results.
  debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
Otherwise, ignore this field.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no
        # more results in the list.
    &quot;sources&quot;: [
      { # 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.
        &quot;name&quot;: &quot;A String&quot;, # Name of the datasource resource.
            # Format: datasources/{source_id}.
            # &lt;br /&gt;The name is ignored when creating a datasource.
        &quot;disableModifications&quot;: True or False, # 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.
        &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
          &quot;A String&quot;,
        ],
        &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
        &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source.  This value will be used to match the
            # &#x27;source&#x27; operator. For example, if the short name is *&amp;lt;value&amp;gt;* then
            # queries like *source:&amp;lt;value&amp;gt;* 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 &#x27;google&#x27; 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.
        &quot;itemsVisibility&quot;: [ # 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.
          {
            &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
            &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the
                # customer.
            &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
          },
        ],
        &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this
            # schema.
          &quot;A String&quot;,
        ],
        &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource
            # The maximum length is 300 characters.
      },
    ],
  }</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
  <pre>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 &#x27;execute()&#x27; on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

<div class="method">
    <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
  <pre>Updates a datasource.

**Note:** This API requires an admin account to execute.

Args:
  name: string, Name of the datasource resource.
Format: datasources/{source_id}.
&lt;br /&gt;The name is ignored when creating a datasource. (required)
  body: object, The request body.
    The object takes the form of:

{
    &quot;source&quot;: { # 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.
      &quot;name&quot;: &quot;A String&quot;, # Name of the datasource resource.
          # Format: datasources/{source_id}.
          # &lt;br /&gt;The name is ignored when creating a datasource.
      &quot;disableModifications&quot;: True or False, # 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.
      &quot;indexingServiceAccounts&quot;: [ # List of service accounts that have indexing access.
        &quot;A String&quot;,
      ],
      &quot;disableServing&quot;: True or False, # Disable serving any search or assist results.
      &quot;shortName&quot;: &quot;A String&quot;, # A short name or alias for the source.  This value will be used to match the
          # &#x27;source&#x27; operator. For example, if the short name is *&amp;lt;value&amp;gt;* then
          # queries like *source:&amp;lt;value&amp;gt;* 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 &#x27;google&#x27; 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.
      &quot;itemsVisibility&quot;: [ # 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.
        {
          &quot;gsuiteGroupEmail&quot;: &quot;A String&quot;, # This principal references a G Suite group account
          &quot;gsuiteDomain&quot;: True or False, # This principal represents all users of the G Suite domain of the
              # customer.
          &quot;gsuiteUserEmail&quot;: &quot;A String&quot;, # This principal references a G Suite user account
        },
      ],
      &quot;operationIds&quot;: [ # IDs of the Long Running Operations (LROs) currently running for this
          # schema.
        &quot;A String&quot;,
      ],
      &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name of the datasource
          # The maximum length is 300 characters.
    },
    &quot;debugOptions&quot;: { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
      &quot;enableDebugging&quot;: True or False, # If you are asked by Google to help with debugging, set this field.
          # Otherwise, ignore this field.
    },
  }

  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.
    &quot;response&quot;: { # 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`.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;metadata&quot;: { # 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.
      &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
    },
    &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
        # 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).
      &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
        },
      ],
      &quot;message&quot;: &quot;A String&quot;, # 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.
      &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    },
    &quot;name&quot;: &quot;A String&quot;, # 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}`.
    &quot;done&quot;: 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.
  }</pre>
</div>

</body></html>