org.jclouds.googlecomputeengine.features

Interface AddressApi

public interface AddressApi

Provides access to Addresses via their REST API.

Author:

Andrew Bayer

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
Operation	createInRegion(String region, String addressName) Creates a address resource in the specified project specifying the size of the address.
Operation	deleteInRegion(String region, String addressName) Deletes the specified address resource.
Address	getInRegion(String region, String addressName) Returns the specified address resource.
ListPage<Address>	listAtMarkerInRegion(String region, String marker)
ListPage<Address>	listAtMarkerInRegion(String region, String marker, ListOptions listOptions) Retrieves the listPage of address resources contained within the specified project and region.
ListPage<Address>	listFirstPageInRegion(String region)
org.jclouds.collect.PagedIterable<Address>	listInRegion(String region) A paged version of AddressApi#listPageInRegion(String)
org.jclouds.collect.PagedIterable<Address>	listInRegion(String region, ListOptions options)

Method Detail

getInRegion

@Named(value="Addresss:get")
@Nullable
Address getInRegion(String region,
                                 String addressName)

Returns the specified address resource.

Parameters:

region - Name of the region the address is in.

addressName - name of the address resource to return.

Returns:

a Address resource.

createInRegion

@Named(value="Addresss:insert")
Operation createInRegion(String region,
                             String addressName)

Creates a address resource in the specified project specifying the size of the address.

Parameters:

region - the name of the region where the address is to be created.

addressName - the name of address.

Returns:

an Operation resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field.

deleteInRegion

@Named(value="Addresss:delete")
@Nullable
Operation deleteInRegion(String region,
                                      String addressName)

Deletes the specified address resource.

Parameters:

region - the region the address is in.

addressName - name of the address resource to delete.

Returns:

an Operation resource. To check on the status of an operation, poll the Operations resource returned to you, and look for the status field.

listFirstPageInRegion

@Named(value="Addresss:list")
ListPage<Address> listFirstPageInRegion(String region)

See Also:

listAtMarkerInRegion(String, String, org.jclouds.googlecomputeengine.options.ListOptions)

listAtMarkerInRegion

@Named(value="Addresss:list")
ListPage<Address> listAtMarkerInRegion(String region,
                                           @Nullable
                                           String marker)

See Also:

listAtMarkerInRegion(String, String, org.jclouds.googlecomputeengine.options.ListOptions)

listAtMarkerInRegion

@Named(value="Addresss:list")
ListPage<Address> listAtMarkerInRegion(String region,
                                           @Nullable
                                           String marker,
                                           ListOptions listOptions)

Retrieves the listPage of address resources contained within the specified project and region. By default the listPage as a maximum size of 100, if no options are provided or ListOptions#getMaxResults() has not been set.

Parameters:

region - the region to search in

marker - marks the beginning of the next list page

listOptions - listing options

Returns:

a page of the listPage

See Also:

ListOptions, ListPage

listInRegion

@Named(value="Addresss:list")
org.jclouds.collect.PagedIterable<Address> listInRegion(String region)

A paged version of AddressApi#listPageInRegion(String)

Parameters:

region - the region to list in

Returns:

a Paged, Fluent Iterable that is able to fetch additional pages when required

See Also:

PagedIterable, listAtMarkerInRegion(String, String, org.jclouds.googlecomputeengine.options.ListOptions)

listInRegion

@Named(value="Addresss:list")
org.jclouds.collect.PagedIterable<Address> listInRegion(String region,
                                                            ListOptions options)