Package namespace.cloud.compute.v1beta

Interface Compute.CreateInstanceRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Compute.CreateInstanceRequest, Compute.CreateInstanceRequest.Builder
Enclosing class:
Compute
public static interface Compute.CreateInstanceRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasShape

      boolean hasShape()
       The shape of the instance to be created.
      .namespace.cloud.compute.v1beta.InstanceShape shape = 1;
      Returns:
      Whether the shape field is set.

    • getShape

      Compute.InstanceShape getShape()
       The shape of the instance to be created.
      .namespace.cloud.compute.v1beta.InstanceShape shape = 1;
      Returns:
      The shape.

    • getShapeOrBuilder

      Compute.InstanceShapeOrBuilder getShapeOrBuilder()
       The shape of the instance to be created.
      .namespace.cloud.compute.v1beta.InstanceShape shape = 1;

    • getFeaturesList

      List<Compute.CreateInstanceRequest.Feature> getFeaturesList()
       A list of features that should be enabled in this instance.
 Deprecated: use feature_configuration below instead.
      repeated .namespace.cloud.compute.v1beta.CreateInstanceRequest.Feature features = 3;
      Returns:
      A list containing the features.

    • getFeaturesCount

      int getFeaturesCount()
       A list of features that should be enabled in this instance.
 Deprecated: use feature_configuration below instead.
      repeated .namespace.cloud.compute.v1beta.CreateInstanceRequest.Feature features = 3;
      Returns:
      The count of features.

    • getFeatures

      Compute.CreateInstanceRequest.Feature getFeatures(int index)
       A list of features that should be enabled in this instance.
 Deprecated: use feature_configuration below instead.
      repeated .namespace.cloud.compute.v1beta.CreateInstanceRequest.Feature features = 3;
      Parameters:
      index - The index of the element to return.
      Returns:
      The features at the given index.

    • getFeaturesValueList

      List<Integer> getFeaturesValueList()
       A list of features that should be enabled in this instance.
 Deprecated: use feature_configuration below instead.
      repeated .namespace.cloud.compute.v1beta.CreateInstanceRequest.Feature features = 3;
      Returns:
      A list containing the enum numeric values on the wire for features.

    • getFeaturesValue

      int getFeaturesValue(int index)
       A list of features that should be enabled in this instance.
 Deprecated: use feature_configuration below instead.
      repeated .namespace.cloud.compute.v1beta.CreateInstanceRequest.Feature features = 3;
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of features at the given index.

    • hasFeatureConfiguration

      boolean hasFeatureConfiguration()
       A list of features that should be enabled in this instance.
      .namespace.cloud.compute.v1beta.CreateInstanceRequest.FeatureConfiguration feature_configuration = 11;
      Returns:
      Whether the featureConfiguration field is set.

    • getFeatureConfiguration

      Compute.CreateInstanceRequest.FeatureConfiguration getFeatureConfiguration()
       A list of features that should be enabled in this instance.
      .namespace.cloud.compute.v1beta.CreateInstanceRequest.FeatureConfiguration feature_configuration = 11;
      Returns:
      The featureConfiguration.

    • getFeatureConfigurationOrBuilder

      Compute.CreateInstanceRequest.FeatureConfigurationOrBuilder getFeatureConfigurationOrBuilder()
       A list of features that should be enabled in this instance.
      .namespace.cloud.compute.v1beta.CreateInstanceRequest.FeatureConfiguration feature_configuration = 11;

    • getDocumentedPurpose

      String getDocumentedPurpose()
       A human-facing description of the purpose of this instance. Used for
 debugging purposes.
      string documented_purpose = 4;
      Returns:
      The documentedPurpose.

    • getDocumentedPurposeBytes

      com.google.protobuf.ByteString getDocumentedPurposeBytes()
       A human-facing description of the purpose of this instance. Used for
 debugging purposes.
      string documented_purpose = 4;
      Returns:
      The bytes for documentedPurpose.

    • getLabelsList

      List<Labels.Label> getLabelsList()
       A set of labels that are attached to the new instance. Instances can be
 queried based on labels, see also ListInstancesRequest.
      repeated .namespace.stdlib.Label labels = 5;

    • getLabels

      Labels.Label getLabels(int index)
       A set of labels that are attached to the new instance. Instances can be
 queried based on labels, see also ListInstancesRequest.
      repeated .namespace.stdlib.Label labels = 5;

    • getLabelsCount

      int getLabelsCount()
       A set of labels that are attached to the new instance. Instances can be
 queried based on labels, see also ListInstancesRequest.
      repeated .namespace.stdlib.Label labels = 5;

    • getLabelsOrBuilderList

      List<? extends Labels.LabelOrBuilder> getLabelsOrBuilderList()
       A set of labels that are attached to the new instance. Instances can be
 queried based on labels, see also ListInstancesRequest.
      repeated .namespace.stdlib.Label labels = 5;

    • getLabelsOrBuilder

      Labels.LabelOrBuilder getLabelsOrBuilder(int index)
       A set of labels that are attached to the new instance. Instances can be
 queried based on labels, see also ListInstancesRequest.
      repeated .namespace.stdlib.Label labels = 5;

    • hasDeadline

      boolean hasDeadline()
       Timestamp of when this instance should be released (in UTC). Requested
 deadlines can be modified by policy. For example, if a workspace is
 configured with a maximum deadline of 24h, and a instance is created with
 a requested deadline of 48h, the resulting instance will have a deadline
 of 24h.

 When a instance hits its deadline, processes within will receive a
 `SIGTERM` and have a maximum time to shutdown gracefully before the
 instance is destroyed.

 Note: In JSON format, the Timestamp type is encoded as a string in the
 [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format.
      .google.protobuf.Timestamp deadline = 6;
      Returns:
      Whether the deadline field is set.

    • getDeadline

      com.google.protobuf.Timestamp getDeadline()
       Timestamp of when this instance should be released (in UTC). Requested
 deadlines can be modified by policy. For example, if a workspace is
 configured with a maximum deadline of 24h, and a instance is created with
 a requested deadline of 48h, the resulting instance will have a deadline
 of 24h.

 When a instance hits its deadline, processes within will receive a
 `SIGTERM` and have a maximum time to shutdown gracefully before the
 instance is destroyed.

 Note: In JSON format, the Timestamp type is encoded as a string in the
 [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format.
      .google.protobuf.Timestamp deadline = 6;
      Returns:
      The deadline.

    • getDeadlineOrBuilder

      com.google.protobuf.TimestampOrBuilder getDeadlineOrBuilder()
       Timestamp of when this instance should be released (in UTC). Requested
 deadlines can be modified by policy. For example, if a workspace is
 configured with a maximum deadline of 24h, and a instance is created with
 a requested deadline of 48h, the resulting instance will have a deadline
 of 24h.

 When a instance hits its deadline, processes within will receive a
 `SIGTERM` and have a maximum time to shutdown gracefully before the
 instance is destroyed.

 Note: In JSON format, the Timestamp type is encoded as a string in the
 [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format.
      .google.protobuf.Timestamp deadline = 6;

    • getInteractive

      boolean getInteractive()
       Deprecated and ignored; it used to allow creation queueing.
      bool interactive = 7;
      Returns:
      The interactive.

    • getRegion

      String getRegion()
       Requests that the new instance be created in the specified region.

 Typically a region is not set. In that case, the Namespace platform makes
 a placement a decision on behalf of users based on the type of workload,
 tenant policies and available global capacity.
      string region = 8;
      Returns:
      The region.

    • getRegionBytes

      com.google.protobuf.ByteString getRegionBytes()
       Requests that the new instance be created in the specified region.

 Typically a region is not set. In that case, the Namespace platform makes
 a placement a decision on behalf of users based on the type of workload,
 tenant policies and available global capacity.
      string region = 8;
      Returns:
      The bytes for region.

    • getPlacementList

      List<String> getPlacementList()
       Ordered placement selectors.

 Each entry must be one of:
 - `cell:<cell-name>` (for example `cell:iad2-a`)
 - `site:<site-name>` (for example `site:iad2`)
 - `continent:<continent-name>` (for example `continent:us`)
 - `any`
      repeated string placement = 19;
      Returns:
      A list containing the placement.

    • getPlacementCount

      int getPlacementCount()
       Ordered placement selectors.

 Each entry must be one of:
 - `cell:<cell-name>` (for example `cell:iad2-a`)
 - `site:<site-name>` (for example `site:iad2`)
 - `continent:<continent-name>` (for example `continent:us`)
 - `any`
      repeated string placement = 19;
      Returns:
      The count of placement.

    • getPlacement

      String getPlacement(int index)
       Ordered placement selectors.

 Each entry must be one of:
 - `cell:<cell-name>` (for example `cell:iad2-a`)
 - `site:<site-name>` (for example `site:iad2`)
 - `continent:<continent-name>` (for example `continent:us`)
 - `any`
      repeated string placement = 19;
      Parameters:
      index - The index of the element to return.
      Returns:
      The placement at the given index.

    • getPlacementBytes

      com.google.protobuf.ByteString getPlacementBytes(int index)
       Ordered placement selectors.

 Each entry must be one of:
 - `cell:<cell-name>` (for example `cell:iad2-a`)
 - `site:<site-name>` (for example `site:iad2`)
 - `continent:<continent-name>` (for example `continent:us`)
 - `any`
      repeated string placement = 19;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the placement at the given index.

    • getContainersList

      List<Compute.ContainerRequest> getContainersList()
       Start the specified containers as part of instance creation. Containers
 are deployed to `containerd` directly. See ContainerRequest for more
 details. Only supported on Linux platform.
      repeated .namespace.cloud.compute.v1beta.ContainerRequest containers = 9;

    • getContainers

      Compute.ContainerRequest getContainers(int index)
       Start the specified containers as part of instance creation. Containers
 are deployed to `containerd` directly. See ContainerRequest for more
 details. Only supported on Linux platform.
      repeated .namespace.cloud.compute.v1beta.ContainerRequest containers = 9;

    • getContainersCount

      int getContainersCount()
       Start the specified containers as part of instance creation. Containers
 are deployed to `containerd` directly. See ContainerRequest for more
 details. Only supported on Linux platform.
      repeated .namespace.cloud.compute.v1beta.ContainerRequest containers = 9;

    • getContainersOrBuilderList

      List<? extends Compute.ContainerRequestOrBuilder> getContainersOrBuilderList()
       Start the specified containers as part of instance creation. Containers
 are deployed to `containerd` directly. See ContainerRequest for more
 details. Only supported on Linux platform.
      repeated .namespace.cloud.compute.v1beta.ContainerRequest containers = 9;

    • getContainersOrBuilder

      Compute.ContainerRequestOrBuilder getContainersOrBuilder(int index)
       Start the specified containers as part of instance creation. Containers
 are deployed to `containerd` directly. See ContainerRequest for more
 details. Only supported on Linux platform.
      repeated .namespace.cloud.compute.v1beta.ContainerRequest containers = 9;

    • getIngressesList

      List<Compute.Ingress> getIngressesList()
       Ingresses backed by ports exposed directly by the instance. Unlike
 container export ports, these can target any supported platform.
      repeated .namespace.cloud.compute.v1beta.Ingress ingresses = 20;

    • getIngresses

      Compute.Ingress getIngresses(int index)
       Ingresses backed by ports exposed directly by the instance. Unlike
 container export ports, these can target any supported platform.
      repeated .namespace.cloud.compute.v1beta.Ingress ingresses = 20;

    • getIngressesCount

      int getIngressesCount()
       Ingresses backed by ports exposed directly by the instance. Unlike
 container export ports, these can target any supported platform.
      repeated .namespace.cloud.compute.v1beta.Ingress ingresses = 20;

    • getIngressesOrBuilderList

      List<? extends Compute.IngressOrBuilder> getIngressesOrBuilderList()
       Ingresses backed by ports exposed directly by the instance. Unlike
 container export ports, these can target any supported platform.
      repeated .namespace.cloud.compute.v1beta.Ingress ingresses = 20;

    • getIngressesOrBuilder

      Compute.IngressOrBuilder getIngressesOrBuilder(int index)
       Ingresses backed by ports exposed directly by the instance. Unlike
 container export ports, these can target any supported platform.
      repeated .namespace.cloud.compute.v1beta.Ingress ingresses = 20;

    • getIngressBaseDomain

      String getIngressBaseDomain()
       Domain used to construct ingress hostnames for the instance. The
 workspace must be configured to allow the requested domain.
      string ingress_base_domain = 21;
      Returns:
      The ingressBaseDomain.

    • getIngressBaseDomainBytes

      com.google.protobuf.ByteString getIngressBaseDomainBytes()
       Domain used to construct ingress hostnames for the instance. The
 workspace must be configured to allow the requested domain.
      string ingress_base_domain = 21;
      Returns:
      The bytes for ingressBaseDomain.

    • getApplicationsList

      List<Compute.ApplicationRequest> getApplicationsList()
       Start the specified applications on the instance without using
 containerization. See ApplicationRequest for details.
      repeated .namespace.cloud.compute.v1beta.ApplicationRequest applications = 14;

    • getApplications

      Compute.ApplicationRequest getApplications(int index)
       Start the specified applications on the instance without using
 containerization. See ApplicationRequest for details.
      repeated .namespace.cloud.compute.v1beta.ApplicationRequest applications = 14;

    • getApplicationsCount

      int getApplicationsCount()
       Start the specified applications on the instance without using
 containerization. See ApplicationRequest for details.
      repeated .namespace.cloud.compute.v1beta.ApplicationRequest applications = 14;

    • getApplicationsOrBuilderList

      List<? extends Compute.ApplicationRequestOrBuilder> getApplicationsOrBuilderList()
       Start the specified applications on the instance without using
 containerization. See ApplicationRequest for details.
      repeated .namespace.cloud.compute.v1beta.ApplicationRequest applications = 14;

    • getApplicationsOrBuilder

      Compute.ApplicationRequestOrBuilder getApplicationsOrBuilder(int index)
       Start the specified applications on the instance without using
 containerization. See ApplicationRequest for details.
      repeated .namespace.cloud.compute.v1beta.ApplicationRequest applications = 14;

    • hasExperimental

      boolean hasExperimental()
       A set of experimental features that should be attached to this instance.
 Experimental features may be removed or modified at any time by the
 Namespace team.
      .namespace.cloud.compute.v1beta.CreateInstanceRequest.ExperimentalFeatures experimental = 10;
      Returns:
      Whether the experimental field is set.

    • getExperimental

      Compute.CreateInstanceRequest.ExperimentalFeatures getExperimental()
       A set of experimental features that should be attached to this instance.
 Experimental features may be removed or modified at any time by the
 Namespace team.
      .namespace.cloud.compute.v1beta.CreateInstanceRequest.ExperimentalFeatures experimental = 10;
      Returns:
      The experimental.

    • getExperimentalOrBuilder

      Compute.CreateInstanceRequest.ExperimentalFeaturesOrBuilder getExperimentalOrBuilder()
       A set of experimental features that should be attached to this instance.
 Experimental features may be removed or modified at any time by the
 Namespace team.
      .namespace.cloud.compute.v1beta.CreateInstanceRequest.ExperimentalFeatures experimental = 10;

    • getVolumesList

      List<Compute.VolumeRequest> getVolumesList()
       Attach storage to the instance, notably, cache volumes.
 See https://namespace.so/docs/architecture/storage/cache-volumes for details.
      repeated .namespace.cloud.compute.v1beta.VolumeRequest volumes = 12;

    • getVolumes

      Compute.VolumeRequest getVolumes(int index)
       Attach storage to the instance, notably, cache volumes.
 See https://namespace.so/docs/architecture/storage/cache-volumes for details.
      repeated .namespace.cloud.compute.v1beta.VolumeRequest volumes = 12;

    • getVolumesCount

      int getVolumesCount()
       Attach storage to the instance, notably, cache volumes.
 See https://namespace.so/docs/architecture/storage/cache-volumes for details.
      repeated .namespace.cloud.compute.v1beta.VolumeRequest volumes = 12;

    • getVolumesOrBuilderList

      List<? extends Compute.VolumeRequestOrBuilder> getVolumesOrBuilderList()
       Attach storage to the instance, notably, cache volumes.
 See https://namespace.so/docs/architecture/storage/cache-volumes for details.
      repeated .namespace.cloud.compute.v1beta.VolumeRequest volumes = 12;

    • getVolumesOrBuilder

      Compute.VolumeRequestOrBuilder getVolumesOrBuilder(int index)
       Attach storage to the instance, notably, cache volumes.
 See https://namespace.so/docs/architecture/storage/cache-volumes for details.
      repeated .namespace.cloud.compute.v1beta.VolumeRequest volumes = 12;

    • hasContainerCache

      boolean hasContainerCache()
       Enable container caching. Container caching is only available on Linux.
      .namespace.cloud.compute.v1beta.ContainerCache container_cache = 13;
      Returns:
      Whether the containerCache field is set.

    • getContainerCache

      Compute.ContainerCache getContainerCache()
       Enable container caching. Container caching is only available on Linux.
      .namespace.cloud.compute.v1beta.ContainerCache container_cache = 13;
      Returns:
      The containerCache.

    • getContainerCacheOrBuilder

      Compute.ContainerCacheOrBuilder getContainerCacheOrBuilder()
       Enable container caching. Container caching is only available on Linux.
      .namespace.cloud.compute.v1beta.ContainerCache container_cache = 13;

    • hasHttpEventCallback

      boolean hasHttpEventCallback()
       We'll HTTP POST on this URL whenever the instance changes state. The body
 of the post will be application/json with a serialized
 InstanceEventMetadata.
      .namespace.stdlib.HttpCallbackEndpoint http_event_callback = 15;
      Returns:
      Whether the httpEventCallback field is set.

    • getHttpEventCallback

      Callback.HttpCallbackEndpoint getHttpEventCallback()
       We'll HTTP POST on this URL whenever the instance changes state. The body
 of the post will be application/json with a serialized
 InstanceEventMetadata.
      .namespace.stdlib.HttpCallbackEndpoint http_event_callback = 15;
      Returns:
      The httpEventCallback.

    • getHttpEventCallbackOrBuilder

      Callback.HttpCallbackEndpointOrBuilder getHttpEventCallbackOrBuilder()
       We'll HTTP POST on this URL whenever the instance changes state. The body
 of the post will be application/json with a serialized
 InstanceEventMetadata.
      .namespace.stdlib.HttpCallbackEndpoint http_event_callback = 15;

    • getAdditionalRegistriesCount

      int getAdditionalRegistriesCount()
       Additional authenticated registries that can be targeted when pulling images.
 The map key is the registry address.
      map<string, .namespace.cloud.compute.v1beta.AdditionalRegistry> additional_registries = 16;

    • containsAdditionalRegistries

      boolean containsAdditionalRegistries(String key)
       Additional authenticated registries that can be targeted when pulling images.
 The map key is the registry address.
      map<string, .namespace.cloud.compute.v1beta.AdditionalRegistry> additional_registries = 16;

    • getAdditionalRegistries

      @Deprecated Map<String,Compute.AdditionalRegistry> getAdditionalRegistries()
      Deprecated.
      Use getAdditionalRegistriesMap() instead.

    • getAdditionalRegistriesMap

      Map<String,Compute.AdditionalRegistry> getAdditionalRegistriesMap()
       Additional authenticated registries that can be targeted when pulling images.
 The map key is the registry address.
      map<string, .namespace.cloud.compute.v1beta.AdditionalRegistry> additional_registries = 16;

    • getAdditionalRegistriesOrDefault

      Compute.AdditionalRegistry getAdditionalRegistriesOrDefault(String key, Compute.AdditionalRegistry defaultValue)
       Additional authenticated registries that can be targeted when pulling images.
 The map key is the registry address.
      map<string, .namespace.cloud.compute.v1beta.AdditionalRegistry> additional_registries = 16;

    • getAdditionalRegistriesOrThrow

      Compute.AdditionalRegistry getAdditionalRegistriesOrThrow(String key)
       Additional authenticated registries that can be targeted when pulling images.
 The map key is the registry address.
      map<string, .namespace.cloud.compute.v1beta.AdditionalRegistry> additional_registries = 16;

    • getWorkloadPermissionsList

      List<Authz.Permission> getWorkloadPermissionsList()
       The set of permissions to grant to the workload running in this instance.
 If not specified, inherits the tenant's default workload permissions.
 If the tenant token used to authenticate this request does not itself
 grant a requested permission, the request fails with `PermissionDenied`.
 See https://namespace.so/docs/security/permissions for available permissions.
      repeated .namespace.cloud.iam.v1beta.Permission workload_permissions = 17;

    • getWorkloadPermissions

      Authz.Permission getWorkloadPermissions(int index)
       The set of permissions to grant to the workload running in this instance.
 If not specified, inherits the tenant's default workload permissions.
 If the tenant token used to authenticate this request does not itself
 grant a requested permission, the request fails with `PermissionDenied`.
 See https://namespace.so/docs/security/permissions for available permissions.
      repeated .namespace.cloud.iam.v1beta.Permission workload_permissions = 17;

    • getWorkloadPermissionsCount

      int getWorkloadPermissionsCount()
       The set of permissions to grant to the workload running in this instance.
 If not specified, inherits the tenant's default workload permissions.
 If the tenant token used to authenticate this request does not itself
 grant a requested permission, the request fails with `PermissionDenied`.
 See https://namespace.so/docs/security/permissions for available permissions.
      repeated .namespace.cloud.iam.v1beta.Permission workload_permissions = 17;

    • getWorkloadPermissionsOrBuilderList

      List<? extends Authz.PermissionOrBuilder> getWorkloadPermissionsOrBuilderList()
       The set of permissions to grant to the workload running in this instance.
 If not specified, inherits the tenant's default workload permissions.
 If the tenant token used to authenticate this request does not itself
 grant a requested permission, the request fails with `PermissionDenied`.
 See https://namespace.so/docs/security/permissions for available permissions.
      repeated .namespace.cloud.iam.v1beta.Permission workload_permissions = 17;

    • getWorkloadPermissionsOrBuilder

      Authz.PermissionOrBuilder getWorkloadPermissionsOrBuilder(int index)
       The set of permissions to grant to the workload running in this instance.
 If not specified, inherits the tenant's default workload permissions.
 If the tenant token used to authenticate this request does not itself
 grant a requested permission, the request fails with `PermissionDenied`.
 See https://namespace.so/docs/security/permissions for available permissions.
      repeated .namespace.cloud.iam.v1beta.Permission workload_permissions = 17;

    • hasNetworkPolicy

      boolean hasNetworkPolicy()
       Network policy to apply to the instance.
 See https://namespace.so/docs/architecture/networking/security for details.
      .namespace.cloud.compute.v1beta.CreateInstanceRequest.NetworkPolicy network_policy = 18;
      Returns:
      Whether the networkPolicy field is set.

    • getNetworkPolicy

      Compute.CreateInstanceRequest.NetworkPolicy getNetworkPolicy()
       Network policy to apply to the instance.
 See https://namespace.so/docs/architecture/networking/security for details.
      .namespace.cloud.compute.v1beta.CreateInstanceRequest.NetworkPolicy network_policy = 18;
      Returns:
      The networkPolicy.

    • getNetworkPolicyOrBuilder

      Compute.CreateInstanceRequest.NetworkPolicyOrBuilder getNetworkPolicyOrBuilder()
       Network policy to apply to the instance.
 See https://namespace.so/docs/architecture/networking/security for details.
      .namespace.cloud.compute.v1beta.CreateInstanceRequest.NetworkPolicy network_policy = 18;