org.jclouds.googlecompute.features.ZoneApi Maven / Gradle / Ivy
/*
* Licensed to jclouds, Inc. (jclouds) under one or more
* contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. jclouds licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.jclouds.googlecompute.features;
import org.jclouds.collect.PagedIterable;
import org.jclouds.googlecompute.domain.ListPage;
import org.jclouds.googlecompute.domain.Zone;
import org.jclouds.googlecompute.options.ListOptions;
import org.jclouds.javax.annotation.Nullable;
/**
* Provides synchronous access to Zones via their REST API.
*
*
* @author David Alves
* @see
*/
public interface ZoneApi {
/**
* Returns the specified zone resource
*
* @param zoneName name of the zone resource to return.
* @return If successful, this method returns a Zone resource
*/
Zone get(String zoneName);
/**
* @see ZoneApi#listAtMarker(String, org.jclouds.googlecompute.options.ListOptions)
*/
ListPage listFirstPage();
/**
* @see ZoneApi#listAtMarker(String, org.jclouds.googlecompute.options.ListOptions)
*/
ListPage listAtMarker(@Nullable String marker);
/**
* Retrieves the listFirstPage of zone resources available to the specified project.
* By default the listFirstPage as a maximum size of 100, if no options are provided or ListOptions#getMaxResults()
* has not been set.
*
* @param marker marks the beginning of the next list page
* @param listOptions listing options
* @return a page of the listFirstPage
* @see ListOptions
* @see ListPage
*/
ListPage listAtMarker(@Nullable String marker, ListOptions listOptions);
/**
* @see ZoneApi#list(org.jclouds.googlecompute.options.ListOptions)
*/
PagedIterable list();
/**
* A paged version of ZoneApi#listFirstPage()
*
* @return a Paged, Fluent Iterable that is able to fetch additional pages when required
* @see ZoneApi#listAtMarker(String, org.jclouds.googlecompute.options.ListOptions)
* @see PagedIterable
*/
PagedIterable list(ListOptions listOptions);
}