GoogleApi.CloudSearch.V1.Api.Settings (google_api_cloud_search v0.8.1) View Source
API calls for all endpoints tagged Settings
.
Link to this section Summary
Functions
Creates a datasource. Note: This API requires an admin account to execute.
Deletes a datasource. Note: This API requires an admin account to execute.
Gets a datasource. Note: This API requires an admin account to execute.
Lists datasources. Note: This API requires an admin account to execute.
Updates a datasource. Note: This API requires an admin account to execute.
Creates a search application. Note: This API requires an admin account to execute.
Deletes a search application. Note: This API requires an admin account to execute.
Gets the specified search application. Note: This API requires an admin account to execute.
Lists all search applications. Note: This API requires an admin account to execute.
Resets a search application to default settings. This will return an empty response. Note: This API requires an admin account to execute.
Updates a search application. Note: This API requires an admin account to execute.
Link to this section Functions
cloudsearch_settings_datasources_create(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudsearch_settings_datasources_create( Tesla.Env.client(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudSearch.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Creates a datasource. Note: This API requires an admin account to execute.
Parameters
-
connection
(type:GoogleApi.CloudSearch.V1.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.CloudSearch.V1.Model.DataSource.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudSearch.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudsearch_settings_datasources_delete(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudsearch_settings_datasources_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudSearch.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes a datasource. Note: This API requires an admin account to execute.
Parameters
-
connection
(type:GoogleApi.CloudSearch.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Name of the datasource. Format: datasources/{source_id}. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"debugOptions.enableDebugging"
(type:boolean()
) - If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudSearch.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudsearch_settings_datasources_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudsearch_settings_datasources_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudSearch.V1.Model.DataSource.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets a datasource. Note: This API requires an admin account to execute.
Parameters
-
connection
(type:GoogleApi.CloudSearch.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Name of the datasource resource. Format: datasources/{source_id}. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"debugOptions.enableDebugging"
(type:boolean()
) - If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudSearch.V1.Model.DataSource{}}
on success -
{:error, info}
on failure
cloudsearch_settings_datasources_list(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudsearch_settings_datasources_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.CloudSearch.V1.Model.ListDataSourceResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists datasources. Note: This API requires an admin account to execute.
Parameters
-
connection
(type:GoogleApi.CloudSearch.V1.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"debugOptions.enableDebugging"
(type:boolean()
) - If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. -
:pageSize
(type:integer()
) - Maximum number of datasources to fetch in a request. The max value is 100. The default value is 10 -
:pageToken
(type:String.t
) - Starting index of the results.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudSearch.V1.Model.ListDataSourceResponse{}}
on success -
{:error, info}
on failure
cloudsearch_settings_datasources_update(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudsearch_settings_datasources_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudSearch.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates a datasource. Note: This API requires an admin account to execute.
Parameters
-
connection
(type:GoogleApi.CloudSearch.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.CloudSearch.V1.Model.UpdateDataSourceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudSearch.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudsearch_settings_searchapplications_create(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudsearch_settings_searchapplications_create( Tesla.Env.client(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudSearch.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Creates a search application. Note: This API requires an admin account to execute.
Parameters
-
connection
(type:GoogleApi.CloudSearch.V1.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.CloudSearch.V1.Model.SearchApplication.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudSearch.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudsearch_settings_searchapplications_delete(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudsearch_settings_searchapplications_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudSearch.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Deletes a search application. Note: This API requires an admin account to execute.
Parameters
-
connection
(type:GoogleApi.CloudSearch.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the search application to be deleted. Format: applications/{application_id}. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"debugOptions.enableDebugging"
(type:boolean()
) - If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudSearch.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudsearch_settings_searchapplications_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudsearch_settings_searchapplications_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudSearch.V1.Model.SearchApplication.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Gets the specified search application. Note: This API requires an admin account to execute.
Parameters
-
connection
(type:GoogleApi.CloudSearch.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Name of the search application. Format: searchapplications/{application_id}. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"debugOptions.enableDebugging"
(type:boolean()
) - If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudSearch.V1.Model.SearchApplication{}}
on success -
{:error, info}
on failure
cloudsearch_settings_searchapplications_list(connection, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudsearch_settings_searchapplications_list( Tesla.Env.client(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudSearch.V1.Model.ListSearchApplicationsResponse.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Lists all search applications. Note: This API requires an admin account to execute.
Parameters
-
connection
(type:GoogleApi.CloudSearch.V1.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:"debugOptions.enableDebugging"
(type:boolean()
) - If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. -
:pageSize
(type:integer()
) - The maximum number of items to return. -
:pageToken
(type:String.t
) - The next_page_token value returned from a previous List request, if any. The default value is 10
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudSearch.V1.Model.ListSearchApplicationsResponse{}}
on success -
{:error, info}
on failure
cloudsearch_settings_searchapplications_reset(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudsearch_settings_searchapplications_reset( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudSearch.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Resets a search application to default settings. This will return an empty response. Note: This API requires an admin account to execute.
Parameters
-
connection
(type:GoogleApi.CloudSearch.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - The name of the search application to be reset. Format: applications/{application_id}. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.CloudSearch.V1.Model.ResetSearchApplicationRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudSearch.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudsearch_settings_searchapplications_update(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudsearch_settings_searchapplications_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudSearch.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Updates a search application. Note: This API requires an admin account to execute.
Parameters
-
connection
(type:GoogleApi.CloudSearch.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Name of the Search Application. Format: searchapplications/{application_id}. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.CloudSearch.V1.Model.SearchApplication.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudSearch.V1.Model.Operation{}}
on success -
{:error, info}
on failure