Service for managing catalog configuration. v2
Package
@google-cloud/retailConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of CatalogServiceClient.
opts
ClientOptions
gaxInstance
typeof gax | typeof gax.fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new CatalogServiceClient({fallback: 'rest'}, gax); ```
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth
:
gax
.
GoogleAuth
;
catalogServiceStub
catalogServiceStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
descriptors
descriptors
:
Descriptors
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
locationsClient
locationsClient
:
LocationsClient
;
operationsClient
operationsClient
:
gax
.
OperationsClient
;
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
addCatalogAttribute(request, options)
addCatalogAttribute
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IAddCatalogAttributeRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
retail
.
v2
.
IAttributesConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IAddCatalogAttributeRequest
|
undefined
,
{}
|
undefined
]>;
Adds the specified to the .
If the to add already exists, an ALREADY_EXISTS error is returned.
request
protos. google.cloud.retail.v2.IAddCatalogAttributeRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.retail.v2.IAttributesConfig
,
protos. google.cloud.retail.v2.IAddCatalogAttributeRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Full AttributesConfig resource name. Format:
* `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
*/
// const attributesConfig = 'abc123'
/**
* Required. The CatalogAttribute google.cloud.retail.v2.CatalogAttribute
* to add.
*/
// const catalogAttribute = {}
// Imports the Retail library
const
{
CatalogServiceClient
}
=
require
(
' @google-cloud/retail
'
).
v2
;
// Instantiates a client
const
retailClient
=
new
CatalogServiceClient
();
async
function
callAddCatalogAttribute
()
{
// Construct request
const
request
=
{
attributesConfig
,
catalogAttribute
,
};
// Run request
const
response
=
await
retailClient
.
addCatalogAttribute
(
request
);
console
.
log
(
response
);
}
callAddCatalogAttribute
();
addCatalogAttribute(request, options, callback)
addCatalogAttribute
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IAddCatalogAttributeRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IAttributesConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IAddCatalogAttributeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IAddCatalogAttributeRequest
options
CallOptions
callback
Callback
<protos. google.cloud.retail.v2.IAttributesConfig
, protos. google.cloud.retail.v2.IAddCatalogAttributeRequest
| null | undefined, {} | null | undefined>
void
addCatalogAttribute(request, callback)
addCatalogAttribute
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IAddCatalogAttributeRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IAttributesConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IAddCatalogAttributeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IAddCatalogAttributeRequest
callback
Callback
<protos. google.cloud.retail.v2.IAttributesConfig
, protos. google.cloud.retail.v2.IAddCatalogAttributeRequest
| null | undefined, {} | null | undefined>
void
attributesConfigPath(project, location, catalog)
attributesConfigPath
(
project
:
string
,
location
:
string
,
catalog
:
string
)
:
string
;
Return a fully-qualified attributesConfig resource name string.
project
string
location
string
catalog
string
string
{string} Resource name string.
branchPath(project, location, catalog, branch)
branchPath
(
project
:
string
,
location
:
string
,
catalog
:
string
,
branch
:
string
)
:
string
;
Return a fully-qualified branch resource name string.
project
string
location
string
catalog
string
branch
string
string
{string} Resource name string.
cancelOperation(request, options, callback)
cancelOperation
(
request
:
protos
.
google
.
longrunning
.
CancelOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
CancelOperationRequest
,
{}
|
undefined
|
null
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
CancelOperationRequest
,
protos
.
google
.
protobuf
.
Empty
,
{}
|
undefined
|
null
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
request
protos. google.longrunning.CancelOperationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<protos. google.protobuf.Empty
, protos. google.longrunning.CancelOperationRequest
, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<protos. google.longrunning.CancelOperationRequest
, protos. google.protobuf.Empty
, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Promise
<protos. google.protobuf.Empty
>
const
client
=
longrunning
.
operationsClient
();
await
client
.
cancelOperation
({
name
:
''
});
catalogPath(project, location, catalog)
catalogPath
(
project
:
string
,
location
:
string
,
catalog
:
string
)
:
string
;
Return a fully-qualified catalog resource name string.
project
string
location
string
catalog
string
string
{string} Resource name string.
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
completionConfigPath(project, location, catalog)
completionConfigPath
(
project
:
string
,
location
:
string
,
catalog
:
string
)
:
string
;
Return a fully-qualified completionConfig resource name string.
project
string
location
string
catalog
string
string
{string} Resource name string.
controlPath(project, location, catalog, control)
controlPath
(
project
:
string
,
location
:
string
,
catalog
:
string
,
control
:
string
)
:
string
;
Return a fully-qualified control resource name string.
project
string
location
string
catalog
string
control
string
string
{string} Resource name string.
deleteOperation(request, options, callback)
deleteOperation
(
request
:
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
request
protos. google.longrunning.DeleteOperationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<protos. google.protobuf.Empty
, protos. google.longrunning.DeleteOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<protos. google.protobuf.Empty
, protos. google.longrunning.DeleteOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Promise
<protos. google.protobuf.Empty
>
const
client
=
longrunning
.
operationsClient
();
await
client
.
deleteOperation
({
name
:
''
});
getAttributesConfig(request, options)
getAttributesConfig
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IGetAttributesConfigRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
retail
.
v2
.
IAttributesConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IGetAttributesConfigRequest
|
undefined
,
{}
|
undefined
]>;
Gets an .
request
protos. google.cloud.retail.v2.IGetAttributesConfigRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.retail.v2.IAttributesConfig
,
protos. google.cloud.retail.v2.IGetAttributesConfigRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Full AttributesConfig resource name. Format:
* `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
*/
// const name = 'abc123'
// Imports the Retail library
const
{
CatalogServiceClient
}
=
require
(
' @google-cloud/retail
'
).
v2
;
// Instantiates a client
const
retailClient
=
new
CatalogServiceClient
();
async
function
callGetAttributesConfig
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
retailClient
.
getAttributesConfig
(
request
);
console
.
log
(
response
);
}
callGetAttributesConfig
();
getAttributesConfig(request, options, callback)
getAttributesConfig
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IGetAttributesConfigRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IAttributesConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IGetAttributesConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IGetAttributesConfigRequest
options
CallOptions
callback
Callback
<protos. google.cloud.retail.v2.IAttributesConfig
, protos. google.cloud.retail.v2.IGetAttributesConfigRequest
| null | undefined, {} | null | undefined>
void
getAttributesConfig(request, callback)
getAttributesConfig
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IGetAttributesConfigRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IAttributesConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IGetAttributesConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IGetAttributesConfigRequest
callback
Callback
<protos. google.cloud.retail.v2.IAttributesConfig
, protos. google.cloud.retail.v2.IGetAttributesConfigRequest
| null | undefined, {} | null | undefined>
void
getCompletionConfig(request, options)
getCompletionConfig
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IGetCompletionConfigRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
retail
.
v2
.
ICompletionConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IGetCompletionConfigRequest
|
undefined
,
{}
|
undefined
]>;
Gets a .
request
protos. google.cloud.retail.v2.IGetCompletionConfigRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.retail.v2.ICompletionConfig
,
protos. google.cloud.retail.v2.IGetCompletionConfigRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Full CompletionConfig resource name. Format:
* `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig`
*/
// const name = 'abc123'
// Imports the Retail library
const
{
CatalogServiceClient
}
=
require
(
' @google-cloud/retail
'
).
v2
;
// Instantiates a client
const
retailClient
=
new
CatalogServiceClient
();
async
function
callGetCompletionConfig
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
retailClient
.
getCompletionConfig
(
request
);
console
.
log
(
response
);
}
callGetCompletionConfig
();
getCompletionConfig(request, options, callback)
getCompletionConfig
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IGetCompletionConfigRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
ICompletionConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IGetCompletionConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IGetCompletionConfigRequest
options
CallOptions
callback
Callback
<protos. google.cloud.retail.v2.ICompletionConfig
, protos. google.cloud.retail.v2.IGetCompletionConfigRequest
| null | undefined, {} | null | undefined>
void
getCompletionConfig(request, callback)
getCompletionConfig
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IGetCompletionConfigRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
ICompletionConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IGetCompletionConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IGetCompletionConfigRequest
callback
Callback
<protos. google.cloud.retail.v2.ICompletionConfig
, protos. google.cloud.retail.v2.IGetCompletionConfigRequest
| null | undefined, {} | null | undefined>
void
getDefaultBranch(request, options)
getDefaultBranch
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IGetDefaultBranchRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
retail
.
v2
.
IGetDefaultBranchResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
IGetDefaultBranchRequest
|
undefined
,
{}
|
undefined
]>;
Get which branch is currently default branch set by method under a specified parent catalog.
request
protos. google.cloud.retail.v2.IGetDefaultBranchRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.retail.v2.IGetDefaultBranchResponse
,
protos. google.cloud.retail.v2.IGetDefaultBranchRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* The parent catalog resource name, such as
* `projects/* /locations/global/catalogs/default_catalog`.
*/
// const catalog = 'abc123'
// Imports the Retail library
const
{
CatalogServiceClient
}
=
require
(
' @google-cloud/retail
'
).
v2
;
// Instantiates a client
const
retailClient
=
new
CatalogServiceClient
();
async
function
callGetDefaultBranch
()
{
// Construct request
const
request
=
{
};
// Run request
const
response
=
await
retailClient
.
getDefaultBranch
(
request
);
console
.
log
(
response
);
}
callGetDefaultBranch
();
getDefaultBranch(request, options, callback)
getDefaultBranch
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IGetDefaultBranchRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IGetDefaultBranchResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
IGetDefaultBranchRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IGetDefaultBranchRequest
options
CallOptions
callback
Callback
<protos. google.cloud.retail.v2.IGetDefaultBranchResponse
, protos. google.cloud.retail.v2.IGetDefaultBranchRequest
| null | undefined, {} | null | undefined>
void
getDefaultBranch(request, callback)
getDefaultBranch
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IGetDefaultBranchRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IGetDefaultBranchResponse
,
protos
.
google
.
cloud
.
retail
.
v2
.
IGetDefaultBranchRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IGetDefaultBranchRequest
callback
Callback
<protos. google.cloud.retail.v2.IGetDefaultBranchResponse
, protos. google.cloud.retail.v2.IGetDefaultBranchRequest
| null | undefined, {} | null | undefined>
void
getLocation(request, options, callback)
getLocation
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
,
options
?:
gax
.
CallOptions
|
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Gets information about a location.
request
LocationProtos. google.cloud.location.IGetLocationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<LocationProtos. google.cloud.location.ILocation
, LocationProtos. google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Call options. See CallOptions for more details.
callback
Callback
<LocationProtos. google.cloud.location.ILocation
, LocationProtos. google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Promise
<LocationProtos. google.cloud.location.ILocation
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
const
[
response
]
=
await
client
.
getLocation
(
request
);
getOperation(request, options, callback)
getOperation
(
request
:
protos
.
google
.
longrunning
.
GetOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise
< [
protos
.
google
.
longrunning
.
Operation
]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
request
protos. google.longrunning.GetOperationRequest
The request object that will be sent.
options
gax. CallOptions
| Callback
<protos. google.longrunning.Operation
, protos. google.longrunning.GetOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
<protos. google.longrunning.Operation
, protos. google.longrunning.GetOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
Promise
<[protos. google.longrunning.Operation
]>
const
client
=
longrunning
.
operationsClient
();
const
name
=
''
;
const
[
response
]
=
await
client
.
getOperation
({
name
});
// doThingsWith(response)
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
listCatalogs(request, options)
listCatalogs
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IListCatalogsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
retail
.
v2
.
ICatalog
[],
protos
.
google
.
cloud
.
retail
.
v2
.
IListCatalogsRequest
|
null
,
protos
.
google
.
cloud
.
retail
.
v2
.
IListCatalogsResponse
]>;
Lists all the s associated with the project.
request
protos. google.cloud.retail.v2.IListCatalogsRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.retail.v2.ICatalog
[],
protos. google.cloud.retail.v2.IListCatalogsRequest
| null,
protos. google.cloud.retail.v2.IListCatalogsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listCatalogsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listCatalogs(request, options, callback)
listCatalogs
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IListCatalogsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
retail
.
v2
.
IListCatalogsRequest
,
protos
.
google
.
cloud
.
retail
.
v2
.
IListCatalogsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
retail
.
v2
.
ICatalog
> )
:
void
;
request
protos. google.cloud.retail.v2.IListCatalogsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.retail.v2.IListCatalogsRequest
, protos. google.cloud.retail.v2.IListCatalogsResponse
| null | undefined, protos. google.cloud.retail.v2.ICatalog
>
void
listCatalogs(request, callback)
listCatalogs
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IListCatalogsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
retail
.
v2
.
IListCatalogsRequest
,
protos
.
google
.
cloud
.
retail
.
v2
.
IListCatalogsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
retail
.
v2
.
ICatalog
> )
:
void
;
request
protos. google.cloud.retail.v2.IListCatalogsRequest
callback
PaginationCallback
<protos. google.cloud.retail.v2.IListCatalogsRequest
, protos. google.cloud.retail.v2.IListCatalogsResponse
| null | undefined, protos. google.cloud.retail.v2.ICatalog
>
void
listCatalogsAsync(request, options)
listCatalogsAsync
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IListCatalogsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
retail
.
v2
.
ICatalog
> ;
Equivalent to listCatalogs
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
protos. google.cloud.retail.v2.IListCatalogsRequest
The request object that will be sent.
options
AsyncIterable
<protos. google.cloud.retail.v2.ICatalog
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The account resource name with an associated location.
* If the caller does not have permission to list
* Catalog google.cloud.retail.v2.Catalog s under this location, regardless
* of whether or not this location exists, a PERMISSION_DENIED error is
* returned.
*/
// const parent = 'abc123'
/**
* Maximum number of Catalog google.cloud.retail.v2.Catalog s to return. If
* unspecified, defaults to 50. The maximum allowed value is 1000. Values
* above 1000 will be coerced to 1000.
* If this field is negative, an INVALID_ARGUMENT is returned.
*/
// const pageSize = 1234
/**
* A page token
* ListCatalogsResponse.next_page_token google.cloud.retail.v2.ListCatalogsResponse.next_page_token,
* received from a previous
* CatalogService.ListCatalogs google.cloud.retail.v2.CatalogService.ListCatalogs
* call. Provide this to retrieve the subsequent page.
* When paginating, all other parameters provided to
* CatalogService.ListCatalogs google.cloud.retail.v2.CatalogService.ListCatalogs
* must match the call that provided the page token. Otherwise, an
* INVALID_ARGUMENT error is returned.
*/
// const pageToken = 'abc123'
// Imports the Retail library
const
{
CatalogServiceClient
}
=
require
(
' @google-cloud/retail
'
).
v2
;
// Instantiates a client
const
retailClient
=
new
CatalogServiceClient
();
async
function
callListCatalogs
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
retailClient
.
listCatalogsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListCatalogs
();
listCatalogsStream(request, options)
listCatalogsStream
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IListCatalogsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
protos. google.cloud.retail.v2.IListCatalogsRequest
The request object that will be sent.
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listCatalogsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listLocationsAsync(request, options)
listLocationsAsync
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IListLocationsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Lists information about the supported locations for this service. Returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
LocationProtos. google.cloud.location.IListLocationsRequest
The request object that will be sent.
options
AsyncIterable
<LocationProtos. google.cloud.location.ILocation
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
const
iterable
=
client
.
listLocationsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
// process response
}
listOperationsAsync(request, options)
listOperationsAsync
(
request
:
protos
.
google
.
longrunning
.
ListOperationsRequest
,
options
?:
gax
.
CallOptions
)
:
AsyncIterable<protos
.
google
.
longrunning
.
ListOperationsResponse
> ;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
request
protos. google.longrunning.ListOperationsRequest
The request object that will be sent.
options
gax. CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
AsyncIterable
<protos. google.longrunning.ListOperationsResponse
>
{Object} An iterable Object that conforms to iteration protocols .
const
client
=
longrunning
.
operationsClient
();
for
await
(
const
response
of
client
.
listOperationsAsync
(
request
));
// doThingsWith(response)
locationPath(project, location)
locationPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified location resource name string.
project
string
location
string
string
{string} Resource name string.
matchBranchFromBranchName(branchName)
matchBranchFromBranchName
(
branchName
:
string
)
:
string
|
number
;
Parse the branch from Branch resource.
branchName
string
A fully-qualified path representing Branch resource.
string | number
{string} A string representing the branch.
matchBranchFromProductName(productName)
matchBranchFromProductName
(
productName
:
string
)
:
string
|
number
;
Parse the branch from Product resource.
productName
string
A fully-qualified path representing Product resource.
string | number
{string} A string representing the branch.
matchCatalogFromAttributesConfigName(attributesConfigName)
matchCatalogFromAttributesConfigName
(
attributesConfigName
:
string
)
:
string
|
number
;
Parse the catalog from AttributesConfig resource.
attributesConfigName
string
A fully-qualified path representing AttributesConfig resource.
string | number
{string} A string representing the catalog.
matchCatalogFromBranchName(branchName)
matchCatalogFromBranchName
(
branchName
:
string
)
:
string
|
number
;
Parse the catalog from Branch resource.
branchName
string
A fully-qualified path representing Branch resource.
string | number
{string} A string representing the catalog.
matchCatalogFromCatalogName(catalogName)
matchCatalogFromCatalogName
(
catalogName
:
string
)
:
string
|
number
;
Parse the catalog from Catalog resource.
catalogName
string
A fully-qualified path representing Catalog resource.
string | number
{string} A string representing the catalog.
matchCatalogFromCompletionConfigName(completionConfigName)
matchCatalogFromCompletionConfigName
(
completionConfigName
:
string
)
:
string
|
number
;
Parse the catalog from CompletionConfig resource.
completionConfigName
string
A fully-qualified path representing CompletionConfig resource.
string | number
{string} A string representing the catalog.
matchCatalogFromControlName(controlName)
matchCatalogFromControlName
(
controlName
:
string
)
:
string
|
number
;
Parse the catalog from Control resource.
controlName
string
A fully-qualified path representing Control resource.
string | number
{string} A string representing the catalog.
matchCatalogFromProductName(productName)
matchCatalogFromProductName
(
productName
:
string
)
:
string
|
number
;
Parse the catalog from Product resource.
productName
string
A fully-qualified path representing Product resource.
string | number
{string} A string representing the catalog.
matchCatalogFromServingConfigName(servingConfigName)
matchCatalogFromServingConfigName
(
servingConfigName
:
string
)
:
string
|
number
;
Parse the catalog from ServingConfig resource.
servingConfigName
string
A fully-qualified path representing ServingConfig resource.
string | number
{string} A string representing the catalog.
matchControlFromControlName(controlName)
matchControlFromControlName
(
controlName
:
string
)
:
string
|
number
;
Parse the control from Control resource.
controlName
string
A fully-qualified path representing Control resource.
string | number
{string} A string representing the control.
matchLocationFromAttributesConfigName(attributesConfigName)
matchLocationFromAttributesConfigName
(
attributesConfigName
:
string
)
:
string
|
number
;
Parse the location from AttributesConfig resource.
attributesConfigName
string
A fully-qualified path representing AttributesConfig resource.
string | number
{string} A string representing the location.
matchLocationFromBranchName(branchName)
matchLocationFromBranchName
(
branchName
:
string
)
:
string
|
number
;
Parse the location from Branch resource.
branchName
string
A fully-qualified path representing Branch resource.
string | number
{string} A string representing the location.
matchLocationFromCatalogName(catalogName)
matchLocationFromCatalogName
(
catalogName
:
string
)
:
string
|
number
;
Parse the location from Catalog resource.
catalogName
string
A fully-qualified path representing Catalog resource.
string | number
{string} A string representing the location.
matchLocationFromCompletionConfigName(completionConfigName)
matchLocationFromCompletionConfigName
(
completionConfigName
:
string
)
:
string
|
number
;
Parse the location from CompletionConfig resource.
completionConfigName
string
A fully-qualified path representing CompletionConfig resource.
string | number
{string} A string representing the location.
matchLocationFromControlName(controlName)
matchLocationFromControlName
(
controlName
:
string
)
:
string
|
number
;
Parse the location from Control resource.
controlName
string
A fully-qualified path representing Control resource.
string | number
{string} A string representing the location.
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the location.
matchLocationFromProductName(productName)
matchLocationFromProductName
(
productName
:
string
)
:
string
|
number
;
Parse the location from Product resource.
productName
string
A fully-qualified path representing Product resource.
string | number
{string} A string representing the location.
matchLocationFromServingConfigName(servingConfigName)
matchLocationFromServingConfigName
(
servingConfigName
:
string
)
:
string
|
number
;
Parse the location from ServingConfig resource.
servingConfigName
string
A fully-qualified path representing ServingConfig resource.
string | number
{string} A string representing the location.
matchProductFromProductName(productName)
matchProductFromProductName
(
productName
:
string
)
:
string
|
number
;
Parse the product from Product resource.
productName
string
A fully-qualified path representing Product resource.
string | number
{string} A string representing the product.
matchProjectFromAttributesConfigName(attributesConfigName)
matchProjectFromAttributesConfigName
(
attributesConfigName
:
string
)
:
string
|
number
;
Parse the project from AttributesConfig resource.
attributesConfigName
string
A fully-qualified path representing AttributesConfig resource.
string | number
{string} A string representing the project.
matchProjectFromBranchName(branchName)
matchProjectFromBranchName
(
branchName
:
string
)
:
string
|
number
;
Parse the project from Branch resource.
branchName
string
A fully-qualified path representing Branch resource.
string | number
{string} A string representing the project.
matchProjectFromCatalogName(catalogName)
matchProjectFromCatalogName
(
catalogName
:
string
)
:
string
|
number
;
Parse the project from Catalog resource.
catalogName
string
A fully-qualified path representing Catalog resource.
string | number
{string} A string representing the project.
matchProjectFromCompletionConfigName(completionConfigName)
matchProjectFromCompletionConfigName
(
completionConfigName
:
string
)
:
string
|
number
;
Parse the project from CompletionConfig resource.
completionConfigName
string
A fully-qualified path representing CompletionConfig resource.
string | number
{string} A string representing the project.
matchProjectFromControlName(controlName)
matchProjectFromControlName
(
controlName
:
string
)
:
string
|
number
;
Parse the project from Control resource.
controlName
string
A fully-qualified path representing Control resource.
string | number
{string} A string representing the project.
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the project.
matchProjectFromProductName(productName)
matchProjectFromProductName
(
productName
:
string
)
:
string
|
number
;
Parse the project from Product resource.
productName
string
A fully-qualified path representing Product resource.
string | number
{string} A string representing the project.
matchProjectFromServingConfigName(servingConfigName)
matchProjectFromServingConfigName
(
servingConfigName
:
string
)
:
string
|
number
;
Parse the project from ServingConfig resource.
servingConfigName
string
A fully-qualified path representing ServingConfig resource.
string | number
{string} A string representing the project.
matchServingConfigFromServingConfigName(servingConfigName)
matchServingConfigFromServingConfigName
(
servingConfigName
:
string
)
:
string
|
number
;
Parse the serving_config from ServingConfig resource.
servingConfigName
string
A fully-qualified path representing ServingConfig resource.
string | number
{string} A string representing the serving_config.
productPath(project, location, catalog, branch, product)
productPath
(
project
:
string
,
location
:
string
,
catalog
:
string
,
branch
:
string
,
product
:
string
)
:
string
;
Return a fully-qualified product resource name string.
project
string
location
string
catalog
string
branch
string
product
string
string
{string} Resource name string.
removeCatalogAttribute(request, options)
removeCatalogAttribute
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IRemoveCatalogAttributeRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
retail
.
v2
.
IAttributesConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IRemoveCatalogAttributeRequest
|
undefined
,
{}
|
undefined
]>;
Removes the specified from the .
If the to remove does not exist, a NOT_FOUND error is returned.
request
protos. google.cloud.retail.v2.IRemoveCatalogAttributeRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.retail.v2.IAttributesConfig
,
protos. google.cloud.retail.v2.IRemoveCatalogAttributeRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Full AttributesConfig resource name. Format:
* `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
*/
// const attributesConfig = 'abc123'
/**
* Required. The attribute name key of the
* CatalogAttribute google.cloud.retail.v2.CatalogAttribute to remove.
*/
// const key = 'abc123'
// Imports the Retail library
const
{
CatalogServiceClient
}
=
require
(
' @google-cloud/retail
'
).
v2
;
// Instantiates a client
const
retailClient
=
new
CatalogServiceClient
();
async
function
callRemoveCatalogAttribute
()
{
// Construct request
const
request
=
{
attributesConfig
,
key
,
};
// Run request
const
response
=
await
retailClient
.
removeCatalogAttribute
(
request
);
console
.
log
(
response
);
}
callRemoveCatalogAttribute
();
removeCatalogAttribute(request, options, callback)
removeCatalogAttribute
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IRemoveCatalogAttributeRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IAttributesConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IRemoveCatalogAttributeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IRemoveCatalogAttributeRequest
options
CallOptions
callback
Callback
<protos. google.cloud.retail.v2.IAttributesConfig
, protos. google.cloud.retail.v2.IRemoveCatalogAttributeRequest
| null | undefined, {} | null | undefined>
void
removeCatalogAttribute(request, callback)
removeCatalogAttribute
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IRemoveCatalogAttributeRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IAttributesConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IRemoveCatalogAttributeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IRemoveCatalogAttributeRequest
callback
Callback
<protos. google.cloud.retail.v2.IAttributesConfig
, protos. google.cloud.retail.v2.IRemoveCatalogAttributeRequest
| null | undefined, {} | null | undefined>
void
replaceCatalogAttribute(request, options)
replaceCatalogAttribute
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IReplaceCatalogAttributeRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
retail
.
v2
.
IAttributesConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IReplaceCatalogAttributeRequest
|
undefined
,
{}
|
undefined
]>;
Replaces the specified in the by updating the catalog attribute with the same .
If the to replace does not exist, a NOT_FOUND error is returned.
request
protos. google.cloud.retail.v2.IReplaceCatalogAttributeRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.retail.v2.IAttributesConfig
,
protos. google.cloud.retail.v2.IReplaceCatalogAttributeRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Full AttributesConfig resource name. Format:
* `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig`
*/
// const attributesConfig = 'abc123'
/**
* Required. The updated
* CatalogAttribute google.cloud.retail.v2.CatalogAttribute.
*/
// const catalogAttribute = {}
/**
* Indicates which fields in the provided
* CatalogAttribute google.cloud.retail.v2.CatalogAttribute to update. The
* following are NOT supported:
* * CatalogAttribute.key google.cloud.retail.v2.CatalogAttribute.key
* If not set, all supported fields are updated.
*/
// const updateMask = {}
// Imports the Retail library
const
{
CatalogServiceClient
}
=
require
(
' @google-cloud/retail
'
).
v2
;
// Instantiates a client
const
retailClient
=
new
CatalogServiceClient
();
async
function
callReplaceCatalogAttribute
()
{
// Construct request
const
request
=
{
attributesConfig
,
catalogAttribute
,
};
// Run request
const
response
=
await
retailClient
.
replaceCatalogAttribute
(
request
);
console
.
log
(
response
);
}
callReplaceCatalogAttribute
();
replaceCatalogAttribute(request, options, callback)
replaceCatalogAttribute
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IReplaceCatalogAttributeRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IAttributesConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IReplaceCatalogAttributeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IReplaceCatalogAttributeRequest
options
CallOptions
callback
Callback
<protos. google.cloud.retail.v2.IAttributesConfig
, protos. google.cloud.retail.v2.IReplaceCatalogAttributeRequest
| null | undefined, {} | null | undefined>
void
replaceCatalogAttribute(request, callback)
replaceCatalogAttribute
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IReplaceCatalogAttributeRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IAttributesConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IReplaceCatalogAttributeRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IReplaceCatalogAttributeRequest
callback
Callback
<protos. google.cloud.retail.v2.IAttributesConfig
, protos. google.cloud.retail.v2.IReplaceCatalogAttributeRequest
| null | undefined, {} | null | undefined>
void
servingConfigPath(project, location, catalog, servingConfig)
servingConfigPath
(
project
:
string
,
location
:
string
,
catalog
:
string
,
servingConfig
:
string
)
:
string
;
Return a fully-qualified servingConfig resource name string.
project
string
location
string
catalog
string
servingConfig
string
string
{string} Resource name string.
setDefaultBranch(request, options)
setDefaultBranch
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
ISetDefaultBranchRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
retail
.
v2
.
ISetDefaultBranchRequest
|
undefined
,
{}
|
undefined
]>;
Set a specified branch id as default branch. API methods such as , , will treat requests using "default_branch" to the actual branch id set as default.
For example, if projects/* /locations/* /catalogs/* /branches/1
is set as default, setting to projects/* /locations/* /catalogs/* /branches/default_branch
is equivalent to setting to projects/* /locations/* /catalogs/* /branches/1
.
Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using projects/* /locations/* /catalogs/* /branches/default_branch
as to route the traffic to this staging branch.
CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one.
More specifically:
* PredictionService will only return product IDs from branch {newBranch}. * SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set). * UserEventService will only join events with products from branch {newBranch}.
request
protos. google.cloud.retail.v2.ISetDefaultBranchRequest
The request object that will be sent.
options
Promise
<[
protos. google.protobuf.IEmpty
,
protos. google.cloud.retail.v2.ISetDefaultBranchRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Full resource name of the catalog, such as
* `projects/* /locations/global/catalogs/default_catalog`.
*/
// const catalog = 'abc123'
/**
* The final component of the resource name of a branch.
* This field must be one of "0", "1" or "2". Otherwise, an INVALID_ARGUMENT
* error is returned.
* If there are no sufficient active products in the targeted branch and
* force google.cloud.retail.v2.SetDefaultBranchRequest.force is not set, a
* FAILED_PRECONDITION error is returned.
*/
// const branchId = 'abc123'
/**
* Some note on this request, this can be retrieved by
* CatalogService.GetDefaultBranch google.cloud.retail.v2.CatalogService.GetDefaultBranch
* before next valid default branch set occurs.
* This field must be a UTF-8 encoded string with a length limit of 1,000
* characters. Otherwise, an INVALID_ARGUMENT error is returned.
*/
// const note = 'abc123'
/**
* If set to true, it permits switching to a branch with
* branch_id google.cloud.retail.v2.SetDefaultBranchRequest.branch_id even
* if it has no sufficient active products.
*/
// const force = true
// Imports the Retail library
const
{
CatalogServiceClient
}
=
require
(
' @google-cloud/retail
'
).
v2
;
// Instantiates a client
const
retailClient
=
new
CatalogServiceClient
();
async
function
callSetDefaultBranch
()
{
// Construct request
const
request
=
{
};
// Run request
const
response
=
await
retailClient
.
setDefaultBranch
(
request
);
console
.
log
(
response
);
}
callSetDefaultBranch
();
setDefaultBranch(request, options, callback)
setDefaultBranch
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
ISetDefaultBranchRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
retail
.
v2
.
ISetDefaultBranchRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.ISetDefaultBranchRequest
options
CallOptions
callback
Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.retail.v2.ISetDefaultBranchRequest
| null | undefined, {} | null | undefined>
void
setDefaultBranch(request, callback)
setDefaultBranch
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
ISetDefaultBranchRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
retail
.
v2
.
ISetDefaultBranchRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.ISetDefaultBranchRequest
callback
Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.retail.v2.ISetDefaultBranchRequest
| null | undefined, {} | null | undefined>
void
updateAttributesConfig(request, options)
updateAttributesConfig
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateAttributesConfigRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
retail
.
v2
.
IAttributesConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateAttributesConfigRequest
|
undefined
,
{}
|
undefined
]>;
Updates the .
The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options.
request
protos. google.cloud.retail.v2.IUpdateAttributesConfigRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.retail.v2.IAttributesConfig
,
protos. google.cloud.retail.v2.IUpdateAttributesConfigRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The AttributesConfig google.cloud.retail.v2.AttributesConfig
* to update.
*/
// const attributesConfig = {}
/**
* Indicates which fields in the provided
* AttributesConfig google.cloud.retail.v2.AttributesConfig to update. The
* following is the only supported field:
* * AttributesConfig.catalog_attributes google.cloud.retail.v2.AttributesConfig.catalog_attributes
* If not set, all supported fields are updated.
*/
// const updateMask = {}
// Imports the Retail library
const
{
CatalogServiceClient
}
=
require
(
' @google-cloud/retail
'
).
v2
;
// Instantiates a client
const
retailClient
=
new
CatalogServiceClient
();
async
function
callUpdateAttributesConfig
()
{
// Construct request
const
request
=
{
attributesConfig
,
};
// Run request
const
response
=
await
retailClient
.
updateAttributesConfig
(
request
);
console
.
log
(
response
);
}
callUpdateAttributesConfig
();
updateAttributesConfig(request, options, callback)
updateAttributesConfig
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateAttributesConfigRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IAttributesConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateAttributesConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IUpdateAttributesConfigRequest
options
CallOptions
callback
Callback
<protos. google.cloud.retail.v2.IAttributesConfig
, protos. google.cloud.retail.v2.IUpdateAttributesConfigRequest
| null | undefined, {} | null | undefined>
void
updateAttributesConfig(request, callback)
updateAttributesConfig
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateAttributesConfigRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
IAttributesConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateAttributesConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IUpdateAttributesConfigRequest
callback
Callback
<protos. google.cloud.retail.v2.IAttributesConfig
, protos. google.cloud.retail.v2.IUpdateAttributesConfigRequest
| null | undefined, {} | null | undefined>
void
updateCatalog(request, options)
updateCatalog
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateCatalogRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
retail
.
v2
.
ICatalog
,
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateCatalogRequest
|
undefined
,
{}
|
undefined
]>;
Updates the s.
request
protos. google.cloud.retail.v2.IUpdateCatalogRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.retail.v2.ICatalog
,
protos. google.cloud.retail.v2.IUpdateCatalogRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The Catalog google.cloud.retail.v2.Catalog to update.
* If the caller does not have permission to update the
* Catalog google.cloud.retail.v2.Catalog, regardless of whether or not it
* exists, a PERMISSION_DENIED error is returned.
* If the Catalog google.cloud.retail.v2.Catalog to update does not exist,
* a NOT_FOUND error is returned.
*/
// const catalog = {}
/**
* Indicates which fields in the provided
* Catalog google.cloud.retail.v2.Catalog to update.
* If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
* is returned.
*/
// const updateMask = {}
// Imports the Retail library
const
{
CatalogServiceClient
}
=
require
(
' @google-cloud/retail
'
).
v2
;
// Instantiates a client
const
retailClient
=
new
CatalogServiceClient
();
async
function
callUpdateCatalog
()
{
// Construct request
const
request
=
{
catalog
,
};
// Run request
const
response
=
await
retailClient
.
updateCatalog
(
request
);
console
.
log
(
response
);
}
callUpdateCatalog
();
updateCatalog(request, options, callback)
updateCatalog
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateCatalogRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
ICatalog
,
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateCatalogRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IUpdateCatalogRequest
options
CallOptions
callback
Callback
<protos. google.cloud.retail.v2.ICatalog
, protos. google.cloud.retail.v2.IUpdateCatalogRequest
| null | undefined, {} | null | undefined>
void
updateCatalog(request, callback)
updateCatalog
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateCatalogRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
ICatalog
,
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateCatalogRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IUpdateCatalogRequest
callback
Callback
<protos. google.cloud.retail.v2.ICatalog
, protos. google.cloud.retail.v2.IUpdateCatalogRequest
| null | undefined, {} | null | undefined>
void
updateCompletionConfig(request, options)
updateCompletionConfig
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateCompletionConfigRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
retail
.
v2
.
ICompletionConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateCompletionConfigRequest
|
undefined
,
{}
|
undefined
]>;
Updates the s.
request
protos. google.cloud.retail.v2.IUpdateCompletionConfigRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.retail.v2.ICompletionConfig
,
protos. google.cloud.retail.v2.IUpdateCompletionConfigRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The CompletionConfig google.cloud.retail.v2.CompletionConfig
* to update.
* If the caller does not have permission to update the
* CompletionConfig google.cloud.retail.v2.CompletionConfig, then a
* PERMISSION_DENIED error is returned.
* If the CompletionConfig google.cloud.retail.v2.CompletionConfig to
* update does not exist, a NOT_FOUND error is returned.
*/
// const completionConfig = {}
/**
* Indicates which fields in the provided
* CompletionConfig google.cloud.retail.v2.CompletionConfig to update. The
* following are the only supported fields:
* * CompletionConfig.matching_order google.cloud.retail.v2.CompletionConfig.matching_order
* * CompletionConfig.max_suggestions google.cloud.retail.v2.CompletionConfig.max_suggestions
* * CompletionConfig.min_prefix_length google.cloud.retail.v2.CompletionConfig.min_prefix_length
* * CompletionConfig.auto_learning google.cloud.retail.v2.CompletionConfig.auto_learning
* If not set, all supported fields are updated.
*/
// const updateMask = {}
// Imports the Retail library
const
{
CatalogServiceClient
}
=
require
(
' @google-cloud/retail
'
).
v2
;
// Instantiates a client
const
retailClient
=
new
CatalogServiceClient
();
async
function
callUpdateCompletionConfig
()
{
// Construct request
const
request
=
{
completionConfig
,
};
// Run request
const
response
=
await
retailClient
.
updateCompletionConfig
(
request
);
console
.
log
(
response
);
}
callUpdateCompletionConfig
();
updateCompletionConfig(request, options, callback)
updateCompletionConfig
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateCompletionConfigRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
ICompletionConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateCompletionConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IUpdateCompletionConfigRequest
options
CallOptions
callback
Callback
<protos. google.cloud.retail.v2.ICompletionConfig
, protos. google.cloud.retail.v2.IUpdateCompletionConfigRequest
| null | undefined, {} | null | undefined>
void
updateCompletionConfig(request, callback)
updateCompletionConfig
(
request
:
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateCompletionConfigRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2
.
ICompletionConfig
,
protos
.
google
.
cloud
.
retail
.
v2
.
IUpdateCompletionConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2.IUpdateCompletionConfigRequest
callback
Callback
<protos. google.cloud.retail.v2.ICompletionConfig
, protos. google.cloud.retail.v2.IUpdateCompletionConfigRequest
| null | undefined, {} | null | undefined>
void
