google_api_android_enterprise v0.16.2 GoogleApi.AndroidEnterprise.V1.Api.Storelayoutclusters View Source
API calls for all endpoints tagged Storelayoutclusters
.
Link to this section Summary
Functions
Deletes a cluster.
Retrieves details of a cluster.
Inserts a new cluster in a page.
Retrieves the details of all clusters on the specified page.
Link to this section Functions
Link to this function
androidenterprise_storelayoutclusters_delete(connection, enterprise_id, page_id, cluster_id, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_storelayoutclusters_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Deletes a cluster.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.page_id
(type:String.t
) - The ID of the page.cluster_id
(type:String.t
) - The ID of the cluster.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %{}}
on success{:error, info}
on failure
Link to this function
androidenterprise_storelayoutclusters_get(connection, enterprise_id, page_id, cluster_id, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_storelayoutclusters_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.StoreCluster.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieves details of a cluster.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.page_id
(type:String.t
) - The ID of the page.cluster_id
(type:String.t
) - The ID of the cluster.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.StoreCluster{}}
on success{:error, info}
on failure
Link to this function
androidenterprise_storelayoutclusters_insert(connection, enterprise_id, page_id, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_storelayoutclusters_insert( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.StoreCluster.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Inserts a new cluster in a page.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.page_id
(type:String.t
) - The ID of the page.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:body
(type:GoogleApi.AndroidEnterprise.V1.Model.StoreCluster.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.StoreCluster{}}
on success{:error, info}
on failure
Link to this function
androidenterprise_storelayoutclusters_list(connection, enterprise_id, page_id, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_storelayoutclusters_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.StoreLayoutClustersListResponse.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Retrieves the details of all clusters on the specified page.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.page_id
(type:String.t
) - The ID of the page.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.StoreLayoutClustersListResponse{}}
on success{:error, info}
on failure
Link to this function
androidenterprise_storelayoutclusters_update(connection, enterprise_id, page_id, cluster_id, optional_params \\ [], opts \\ [])
View Sourceandroidenterprise_storelayoutclusters_update( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.AndroidEnterprise.V1.Model.StoreCluster.t()} | {:ok, Tesla.Env.t()} | {:error, Tesla.Env.t()}
Updates a cluster.
Parameters
connection
(type:GoogleApi.AndroidEnterprise.V1.Connection.t
) - Connection to serverenterprise_id
(type:String.t
) - The ID of the enterprise.page_id
(type:String.t
) - The ID of the page.cluster_id
(type:String.t
) - The ID of the cluster.optional_params
(type:keyword()
) - Optional parameters:alt
(type:String.t
) - Data format for the response.: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
) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.:userIp
(type:String.t
) - Deprecated. Please use quotaUser instead.:body
(type:GoogleApi.AndroidEnterprise.V1.Model.StoreCluster.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.AndroidEnterprise.V1.Model.StoreCluster{}}
on success{:error, info}
on failure