commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet Class Reference

Inherits commercetools.Sdk.Api.Client.IPagedQueryResourceRequest< ByProjectKeyCustomObjectsGet, ICustomObjectPagedQueryResponse, CustomObjectQueryBuilderDsl >, commercetools.Sdk.Api.Models.IPagedQueryResourceRequest< ByProjectKeyCustomObjectsGet, commercetools.Sdk.Api.Models.CustomObjects.ICustomObjectPagedQueryResponse >, commercetools.Base.Client.ApiMethod< ByProjectKeyCustomObjectsGet >, commercetools.Base.Client.IApiMethod< ByProjectKeyCustomObjectsGet, commercetools.Sdk.Api.Models.CustomObjects.ICustomObjectPagedQueryResponse >, commercetools.Sdk.Api.Client.IExpandableTrait< ByProjectKeyCustomObjectsGet >, commercetools.Sdk.Api.Client.ISortableTrait< ByProjectKeyCustomObjectsGet >, commercetools.Sdk.Api.Client.IPagingTrait< ByProjectKeyCustomObjectsGet >, commercetools.Sdk.Api.Client.IQueryTrait< ByProjectKeyCustomObjectsGet >, commercetools.Sdk.Api.Client.IErrorableTrait< ByProjectKeyCustomObjectsGet >, and commercetools.Sdk.Api.Client.IDeprecatable200Trait< ByProjectKeyCustomObjectsGet >.

Public Member Functions
	ByProjectKeyCustomObjectsGet (IClient apiHttpClient, string projectKey)
List< string >	GetExpand ()
List< string >	GetSort ()
List< string >	GetLimit ()
List< string >	GetOffset ()
List< string >	GetWithTotal ()
List< string >	GetWhere ()
ByProjectKeyCustomObjectsGet	WithExpand (string expand)
ByProjectKeyCustomObjectsGet	WithSort (string sort)
ByProjectKeyCustomObjectsGet	WithLimit (long limit)
ByProjectKeyCustomObjectsGet	WithOffset (long offset)
ByProjectKeyCustomObjectsGet	WithWithTotal (bool withTotal)
ByProjectKeyCustomObjectsGet	WithWhere (string where)
ByProjectKeyCustomObjectsGet	WithPredicateVar (string varName, string predicateVar)
async Task< commercetools.Sdk.Api.Models.CustomObjects.ICustomObjectPagedQueryResponse >	ExecuteAsync (CancellationToken cancellationToken=default)
async Task< string >	ExecuteAsJsonAsync (CancellationToken cancellationToken=default)
async Task< IApiResponse< commercetools.Sdk.Api.Models.CustomObjects.ICustomObjectPagedQueryResponse > >	SendAsync (CancellationToken cancellationToken=default)
async Task< IApiResponse< string > >	SendAsJsonAsync (CancellationToken cancellationToken=default)
Public Member Functions inherited from commercetools.Sdk.Api.Client.IPagedQueryResourceRequest< ByProjectKeyCustomObjectsGet, ICustomObjectPagedQueryResponse, CustomObjectQueryBuilderDsl >
T	WithExpand (string expand)
Public Member Functions inherited from commercetools.Sdk.Api.Models.IPagedQueryResourceRequest< ByProjectKeyCustomObjectsGet, commercetools.Sdk.Api.Models.CustomObjects.ICustomObjectPagedQueryResponse >
T	WithLimit (long limit)
T	WithOffset (long offset)
T	WithSort (string sort)
T	WithWhere (string where)
T	WithExpand (string expand)
T	WithWithTotal (bool withTotal)
T	WithPredicateVar (string varName, string predicateVar)
List< string >	GetQueryParam (string key)
Public Member Functions inherited from commercetools.Base.Client.ApiMethod< ByProjectKeyCustomObjectsGet >
	ApiMethod ()
T	AddQueryParam (string key, string value)
T	WithQueryParam (List< KeyValuePair< string, string > > queryParams)
ICollection< KeyValuePair< string, string > >	GetQueryParams ()
List< string >	GetQueryParam (string key)
string?	GetFirstQueryParam (string key)
T	AddHeader (string key, string value)
T	WithHeaders (ApiHttpHeaders headers)
virtual HttpRequestMessage	Build ()
Public Member Functions inherited from commercetools.Base.Client.IApiMethod< ByProjectKeyCustomObjectsGet, commercetools.Sdk.Api.Models.CustomObjects.ICustomObjectPagedQueryResponse >
T	AddQueryParam (string key, string value)
T	WithQueryParam (List< KeyValuePair< string, string > > queryParams)
List< string >	GetQueryParam (string key)
T	AddHeader (string key, string value)
T	WithHeaders (ApiHttpHeaders headers)
HttpRequestMessage	Build ()
Task< TResult >	ExecuteAsync (CancellationToken cancellationToken=default)
Task< IApiResponse< TResult > >	SendAsync (CancellationToken cancellationToken=default)
Task< string >	ExecuteAsJsonAsync (CancellationToken cancellationToken=default)
Task< IApiResponse< string > >	SendAsJsonAsync (CancellationToken cancellationToken=default)
Public Member Functions inherited from commercetools.Sdk.Api.Client.IExpandableTrait< ByProjectKeyCustomObjectsGet >
List< string >	GetExpand ()
T	WithExpand (string expand)
IExpandableTrait< T >	AsExpandableTrait ()
T	AsExpandableTraitToBaseType ()
Public Member Functions inherited from commercetools.Sdk.Api.Client.ISortableTrait< ByProjectKeyCustomObjectsGet >
List< string >	GetSort ()
T	WithSort (string sort)
ISortableTrait< T >	AsSortableTrait ()
T	AsSortableTraitToBaseType ()
Public Member Functions inherited from commercetools.Sdk.Api.Client.IPagingTrait< ByProjectKeyCustomObjectsGet >
List< string >	GetLimit ()
List< string >	GetOffset ()
List< string >	GetWithTotal ()
T	WithLimit (long limit)
T	WithOffset (long offset)
T	WithWithTotal (bool withTotal)
IPagingTrait< T >	AsPagingTrait ()
T	AsPagingTraitToBaseType ()
Public Member Functions inherited from commercetools.Sdk.Api.Client.IQueryTrait< ByProjectKeyCustomObjectsGet >
List< string >	GetWhere ()
T	WithWhere (string where)
T	WithPredicateVar (string varName, string predicateVar)
IQueryTrait< T >	AsQueryTrait ()
T	AsQueryTraitToBaseType ()
Public Member Functions inherited from commercetools.Sdk.Api.Client.IErrorableTrait< ByProjectKeyCustomObjectsGet >
IErrorableTrait< T >	AsErrorableTrait ()
T	AsErrorableTraitToBaseType ()
Public Member Functions inherited from commercetools.Sdk.Api.Client.IDeprecatable200Trait< ByProjectKeyCustomObjectsGet >
IDeprecatable200Trait< T >	AsDeprecatable200Trait ()
T	AsDeprecatable200TraitToBaseType ()

Properties
override HttpMethod	Method [get]
Properties inherited from commercetools.Base.Client.ApiMethod< ByProjectKeyCustomObjectsGet >
HttpMethod	Method [get]
string	RequestUrl [get, set]
ApiHttpHeaders	Headers [get, set]
Properties inherited from commercetools.Base.Client.IApiMethod< ByProjectKeyCustomObjectsGet, commercetools.Sdk.Api.Models.CustomObjects.ICustomObjectPagedQueryResponse >
HttpMethod	Method [get]
string	RequestUrl [get, set]

Constructor & Destructor Documentation

ByProjectKeyCustomObjectsGet()

commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.ByProjectKeyCustomObjectsGet ( IClient  apiHttpClient, string  projectKey  )

inline

Member Function Documentation

ExecuteAsJsonAsync()

async Task< string > commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.ExecuteAsJsonAsync ( CancellationToken  cancellationToken = default )

inline

ExecuteAsync()

async Task< commercetools.Sdk.Api.Models.CustomObjects.ICustomObjectPagedQueryResponse > commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.ExecuteAsync ( CancellationToken  cancellationToken = default )

inline

GetExpand()

List< string > commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.GetExpand ( )

inline

GetLimit()

List< string > commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.GetLimit ( )

inline

GetOffset()

List< string > commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.GetOffset ( )

inline

GetSort()

List< string > commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.GetSort ( )

inline

GetWhere()

List< string > commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.GetWhere ( )

inline

GetWithTotal()

List< string > commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.GetWithTotal ( )

inline

SendAsJsonAsync()

async Task< IApiResponse< string > > commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.SendAsJsonAsync ( CancellationToken  cancellationToken = default )

inline

SendAsync()

async Task< IApiResponse< commercetools.Sdk.Api.Models.CustomObjects.ICustomObjectPagedQueryResponse > > commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.SendAsync ( CancellationToken  cancellationToken = default )

inline

WithExpand()

ByProjectKeyCustomObjectsGet commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.WithExpand ( string  expand )

inline

WithLimit()

ByProjectKeyCustomObjectsGet commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.WithLimit ( long  limit )

inline

WithOffset()

ByProjectKeyCustomObjectsGet commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.WithOffset ( long  offset )

inline

WithPredicateVar()

ByProjectKeyCustomObjectsGet commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.WithPredicateVar ( string  varName, string  predicateVar  )

inline

WithSort()

ByProjectKeyCustomObjectsGet commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.WithSort ( string  sort )

inline

WithWhere()

ByProjectKeyCustomObjectsGet commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.WithWhere ( string  where )

inline

WithWithTotal()

ByProjectKeyCustomObjectsGet commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.WithWithTotal ( bool  withTotal )

inline

Property Documentation

Method

override HttpMethod commercetools.Sdk.Api.Client.RequestBuilders.CustomObjects.ByProjectKeyCustomObjectsGet.Method

get

---

The documentation for this class was generated from the following files:

• commercetools.Sdk/commercetools.Sdk.Api/Client/RequestBuilders/CustomObjects/ByProjectKeyCustomObjectsGet.cs
• commercetools.Sdk/commercetools.Sdk.Api/Generated/Client/RequestBuilders/CustomObjects/ByProjectKeyCustomObjectsGet.cs