1 /**
2 * Licensed to jclouds, Inc. (jclouds) under one or more
3 * contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. jclouds licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.jclouds.compute.domain;
20
21 import java.util.Set;
22
23 import org.jclouds.javax.annotation.Nullable;
24
25 import org.jclouds.compute.domain.internal.ComputeMetadataImpl;
26 import org.jclouds.domain.ResourceMetadata;
27
28 import com.google.inject.ImplementedBy;
29
30 /**
31 * @author Ivan Meredith
32 * @author Adrian Cole
33 */
34 @ImplementedBy(ComputeMetadataImpl.class)
35 public interface ComputeMetadata extends ResourceMetadata<ComputeType> {
36 /**
37 * @return Type of the resource, ex node, image, size
38 */
39 @Override
40 public ComputeType getType();
41
42 /**
43 * @return id of the server within the naming scope it was created. potentially generated by the
44 * service.
45 */
46 @Override
47 public String getProviderId();
48
49 /**
50 * @return user defined name of the server.
51 */
52 @Override
53 @Nullable
54 public String getName();
55
56 /**
57 *
58 * A means to uniquely address this resource within a provider. For example, if the namespace of
59 * a node or image is region based, the id will likely include both the region and the
60 * provider-supplied id encoded to avoid collisions.
61 *
62 * @return unique id within your account on the provider
63 */
64 public String getId();
65
66 /**
67 * @return tags describing this resource, if supported
68 */
69 public Set<String> getTags();
70 }