create(body=None, x__xgafv=None)

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

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.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"done": 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.
"name": "A String", # 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}`.
"error": { # 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).
"message": "A String", # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
}

delete(name=None, debugOptions_enableDebugging=None, x__xgafv=None)

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.
    "response": { # 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`.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "metadata": { # 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.
      "a_key": "", # Properties of the object. Contains field @type with type URL.
    },
    "done": 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.
    "name": "A String", # 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}`.
    "error": { # 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).
      "message": "A String", # 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.
      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
      "details": [ # A list of messages that carry the error details.  There is a common set of
          # message types for APIs to use.
        {
          "a_key": "", # Properties of the object. Contains field @type with type URL.
        },
      ],
    },
  }

get(name=None, debugOptions_enableDebugging=None, x__xgafv=None)

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

list(pageSize=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)

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.
 The default value is 10
debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.
Otherwise, ignore this field.
pageToken: string, Starting index of the results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

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

list_next(previous_request=*, previous_response=*)

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 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.

update(name=None, body=None, x__xgafv=None)

Updates a datasource.

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

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

{
"source": { # 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.
"operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this
# schema.
"A String",
],
"displayName": "A String", # Required. Display name of the datasource
# The maximum length is 300 characters.
"name": "A String", # Name of the datasource resource.
# Format: datasources/{source_id}.
# The name is ignored when creating a datasource.
"disableModifications": 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.
"disableServing": True or False, # Disable serving any search or assist results.
"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.
{
"gsuiteUserEmail": "A String", # This principal references a G Suite user account
"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the
# customer.
"gsuiteGroupEmail": "A String", # This principal references a G Suite group account
},
],
"shortName": "A String", # 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 *&lt;value&gt;* then
# queries like *source:&lt;value&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 '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.
"indexingServiceAccounts": [ # List of service accounts that have indexing access.
"A String",
],
},
"debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.
"enableDebugging": 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.
"response": { # 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"metadata": { # 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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"done": 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.
"name": "A String", # 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}`.
"error": { # 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).
"message": "A String", # 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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
}

Cloud Search API . settings . datasources

Instance Methods

Method Details