Class LineItemServiceClient (0.6.0)

Service Description: Provides methods for handling LineItem objects.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (LineItemServiceClient lineItemServiceClient = LineItemServiceClient.create()) {
   LineItemName name = LineItemName.of("[NETWORK_CODE]", "[ORDER]", "[LINE_ITEM]");
   LineItem response = lineItemServiceClient.getLineItem(name);
 }

Note: close() needs to be called on the LineItemServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method	Description	Method Variants
GetLineItem	API to retrieve a LineItem object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getLineItem(GetLineItemRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getLineItem(LineItemName name) getLineItem(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getLineItemCallable()
ListLineItems	API to retrieve a list of LineItem objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listLineItems(ListLineItemsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listLineItems(OrderName parent) listLineItems(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listLineItemsPagedCallable() listLineItemsCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of LineItemServiceSettings to create(). For example:

To customize credentials:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 LineItemServiceSettings lineItemServiceSettings =
     LineItemServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LineItemServiceClient lineItemServiceClient =
     LineItemServiceClient.create(lineItemServiceSettings);

To customize the endpoint:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 LineItemServiceSettings lineItemServiceSettings =
     LineItemServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 LineItemServiceClient lineItemServiceClient =
     LineItemServiceClient.create(lineItemServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > LineItemServiceClient

Static Methods

create()

public static final LineItemServiceClient create()

Constructs an instance of LineItemServiceClient with default settings.

Returns
Type	Description
`LineItemServiceClient`

Exceptions
Type	Description
`IOException`

create(LineItemServiceSettings settings)

public static final LineItemServiceClient create(LineItemServiceSettings settings)

Constructs an instance of LineItemServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
`settings`	`LineItemServiceSettings`

Returns
Type	Description
`LineItemServiceClient`

Exceptions
Type	Description
`IOException`

create(LineItemServiceStub stub)

public static final LineItemServiceClient create(LineItemServiceStub stub)

Constructs an instance of LineItemServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(LineItemServiceSettings).

Parameter
Name	Description
`stub`	`LineItemServiceStub`

Returns
Type	Description
`LineItemServiceClient`

Constructors

LineItemServiceClient(LineItemServiceSettings settings)

protected LineItemServiceClient(LineItemServiceSettings settings)

Constructs an instance of LineItemServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
`settings`	`LineItemServiceSettings`

LineItemServiceClient(LineItemServiceStub stub)

protected LineItemServiceClient(LineItemServiceStub stub)

Parameter
Name	Description
`stub`	`LineItemServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

getLineItem(GetLineItemRequest request)

public final LineItem getLineItem(GetLineItemRequest request)

API to retrieve a LineItem object.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (LineItemServiceClient lineItemServiceClient = LineItemServiceClient.create()) {
   GetLineItemRequest request =
       GetLineItemRequest.newBuilder()
           .setName(LineItemName.of("[NETWORK_CODE]", "[ORDER]", "[LINE_ITEM]").toString())
           .build();
   LineItem response = lineItemServiceClient.getLineItem(request);
 }

Parameter
Name	Description
`request`	`GetLineItemRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`LineItem`

getLineItem(LineItemName name)

public final LineItem getLineItem(LineItemName name)

API to retrieve a LineItem object.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (LineItemServiceClient lineItemServiceClient = LineItemServiceClient.create()) {
   LineItemName name = LineItemName.of("[NETWORK_CODE]", "[ORDER]", "[LINE_ITEM]");
   LineItem response = lineItemServiceClient.getLineItem(name);
 }

Parameter
Name	Description
`name`	`LineItemName` Required. The resource name of the LineItem. Format: `networks/{network_code}/orders/{order_id}/lineItems/{line_item_id}`

Returns
Type	Description
`LineItem`

getLineItem(String name)

public final LineItem getLineItem(String name)

API to retrieve a LineItem object.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (LineItemServiceClient lineItemServiceClient = LineItemServiceClient.create()) {
   String name = LineItemName.of("[NETWORK_CODE]", "[ORDER]", "[LINE_ITEM]").toString();
   LineItem response = lineItemServiceClient.getLineItem(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the LineItem. Format: `networks/{network_code}/orders/{order_id}/lineItems/{line_item_id}`

Returns
Type	Description
`LineItem`

getLineItemCallable()

public final UnaryCallable<GetLineItemRequest,LineItem> getLineItemCallable()

API to retrieve a LineItem object.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (LineItemServiceClient lineItemServiceClient = LineItemServiceClient.create()) {
   GetLineItemRequest request =
       GetLineItemRequest.newBuilder()
           .setName(LineItemName.of("[NETWORK_CODE]", "[ORDER]", "[LINE_ITEM]").toString())
           .build();
   ApiFuture<LineItem> future = lineItemServiceClient.getLineItemCallable().futureCall(request);
   // Do something.
   LineItem response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetLineItemRequest,LineItem>`

getSettings()

public final LineItemServiceSettings getSettings()

Returns
Type	Description
`LineItemServiceSettings`

getStub()

public LineItemServiceStub getStub()

Returns
Type	Description
`LineItemServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listLineItems(ListLineItemsRequest request)

public final LineItemServiceClient.ListLineItemsPagedResponse listLineItems(ListLineItemsRequest request)

API to retrieve a list of LineItem objects.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (LineItemServiceClient lineItemServiceClient = LineItemServiceClient.create()) {
   ListLineItemsRequest request =
       ListLineItemsRequest.newBuilder()
           .setParent(OrderName.of("[NETWORK_CODE]", "[ORDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (LineItem element : lineItemServiceClient.listLineItems(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListLineItemsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`LineItemServiceClient.ListLineItemsPagedResponse`

listLineItems(OrderName parent)

public final LineItemServiceClient.ListLineItemsPagedResponse listLineItems(OrderName parent)

API to retrieve a list of LineItem objects.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (LineItemServiceClient lineItemServiceClient = LineItemServiceClient.create()) {
   OrderName parent = OrderName.of("[NETWORK_CODE]", "[ORDER]");
   for (LineItem element : lineItemServiceClient.listLineItems(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`OrderName` Required. The parent, which owns this collection of LineItems. Format: networks/{network_code}/orders/{order_id}

Returns
Type	Description
`LineItemServiceClient.ListLineItemsPagedResponse`

listLineItems(String parent)

public final LineItemServiceClient.ListLineItemsPagedResponse listLineItems(String parent)

API to retrieve a list of LineItem objects.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (LineItemServiceClient lineItemServiceClient = LineItemServiceClient.create()) {
   String parent = OrderName.of("[NETWORK_CODE]", "[ORDER]").toString();
   for (LineItem element : lineItemServiceClient.listLineItems(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of LineItems. Format: networks/{network_code}/orders/{order_id}

Returns
Type	Description
`LineItemServiceClient.ListLineItemsPagedResponse`

listLineItemsCallable()

public final UnaryCallable<ListLineItemsRequest,ListLineItemsResponse> listLineItemsCallable()

API to retrieve a list of LineItem objects.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (LineItemServiceClient lineItemServiceClient = LineItemServiceClient.create()) {
   ListLineItemsRequest request =
       ListLineItemsRequest.newBuilder()
           .setParent(OrderName.of("[NETWORK_CODE]", "[ORDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListLineItemsResponse response =
         lineItemServiceClient.listLineItemsCallable().call(request);
     for (LineItem element : response.getLineItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListLineItemsRequest,ListLineItemsResponse>`

listLineItemsPagedCallable()

public final UnaryCallable<ListLineItemsRequest,LineItemServiceClient.ListLineItemsPagedResponse> listLineItemsPagedCallable()

API to retrieve a list of LineItem objects.

Sample code:


 // 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.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (LineItemServiceClient lineItemServiceClient = LineItemServiceClient.create()) {
   ListLineItemsRequest request =
       ListLineItemsRequest.newBuilder()
           .setParent(OrderName.of("[NETWORK_CODE]", "[ORDER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<LineItem> future =
       lineItemServiceClient.listLineItemsPagedCallable().futureCall(request);
   // Do something.
   for (LineItem element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListLineItemsRequest,ListLineItemsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()