Package com.google.cloud.memcache.v1

Interface InstanceOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Instance, Instance.Builder
    public interface InstanceOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Required. Unique name of the resource in this scope including project and
 location using the form:
     `projects/{project_id}/locations/{location_id}/instances/{instance_id}`

 Note: Memcached instances are managed and addressed at the regional level
 so `location_id` here refers to a Google Cloud region; however, users may
 choose which zones Memcached nodes should be provisioned in within an
 instance. Refer to [zones][google.cloud.memcache.v1.Instance.zones] field for more details.
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Required. Unique name of the resource in this scope including project and
 location using the form:
     `projects/{project_id}/locations/{location_id}/instances/{instance_id}`

 Note: Memcached instances are managed and addressed at the regional level
 so `location_id` here refers to a Google Cloud region; however, users may
 choose which zones Memcached nodes should be provisioned in within an
 instance. Refer to [zones][google.cloud.memcache.v1.Instance.zones] field for more details.
        string name = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for name.

      • getDisplayName

        String getDisplayName()
         User provided name for the instance, which is only used for display
 purposes. Cannot be more than 80 characters.
        string display_name = 2;
        Returns:
        The displayName.

      • getDisplayNameBytes

        com.google.protobuf.ByteString getDisplayNameBytes()
         User provided name for the instance, which is only used for display
 purposes. Cannot be more than 80 characters.
        string display_name = 2;
        Returns:
        The bytes for displayName.

      • getLabelsCount

        int getLabelsCount()
         Resource labels to represent user-provided metadata.
 Refer to cloud documentation on labels for more details.
 https://cloud.google.com/compute/docs/labeling-resources
        map<string, string> labels = 3;

      • containsLabels

        boolean containsLabels​(String key)
         Resource labels to represent user-provided metadata.
 Refer to cloud documentation on labels for more details.
 https://cloud.google.com/compute/docs/labeling-resources
        map<string, string> labels = 3;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Resource labels to represent user-provided metadata.
 Refer to cloud documentation on labels for more details.
 https://cloud.google.com/compute/docs/labeling-resources
        map<string, string> labels = 3;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Resource labels to represent user-provided metadata.
 Refer to cloud documentation on labels for more details.
 https://cloud.google.com/compute/docs/labeling-resources
        map<string, string> labels = 3;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Resource labels to represent user-provided metadata.
 Refer to cloud documentation on labels for more details.
 https://cloud.google.com/compute/docs/labeling-resources
        map<string, string> labels = 3;

      • getAuthorizedNetwork

        String getAuthorizedNetwork()
         The full name of the Google Compute Engine
 [network](/compute/docs/networks-and-firewalls#networks) to which the
 instance is connected. If left unspecified, the `default` network
 will be used.
        string authorized_network = 4;
        Returns:
        The authorizedNetwork.

      • getAuthorizedNetworkBytes

        com.google.protobuf.ByteString getAuthorizedNetworkBytes()
         The full name of the Google Compute Engine
 [network](/compute/docs/networks-and-firewalls#networks) to which the
 instance is connected. If left unspecified, the `default` network
 will be used.
        string authorized_network = 4;
        Returns:
        The bytes for authorizedNetwork.

      • getZonesList

        List<String> getZonesList()
         Zones in which Memcached nodes should be provisioned.
 Memcached nodes will be equally distributed across these zones. If not
 provided, the service will by default create nodes in all zones in the
 region for the instance.
        repeated string zones = 5;
        Returns:
        A list containing the zones.

      • getZonesCount

        int getZonesCount()
         Zones in which Memcached nodes should be provisioned.
 Memcached nodes will be equally distributed across these zones. If not
 provided, the service will by default create nodes in all zones in the
 region for the instance.
        repeated string zones = 5;
        Returns:
        The count of zones.

      • getZones

        String getZones​(int index)
         Zones in which Memcached nodes should be provisioned.
 Memcached nodes will be equally distributed across these zones. If not
 provided, the service will by default create nodes in all zones in the
 region for the instance.
        repeated string zones = 5;
        Parameters:
        index - The index of the element to return.
        Returns:
        The zones at the given index.

      • getZonesBytes

        com.google.protobuf.ByteString getZonesBytes​(int index)
         Zones in which Memcached nodes should be provisioned.
 Memcached nodes will be equally distributed across these zones. If not
 provided, the service will by default create nodes in all zones in the
 region for the instance.
        repeated string zones = 5;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the zones at the given index.

      • getNodeCount

        int getNodeCount()
         Required. Number of nodes in the Memcached instance.
        int32 node_count = 6 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The nodeCount.

      • hasNodeConfig

        boolean hasNodeConfig()
         Required. Configuration for Memcached nodes.
        .google.cloud.memcache.v1.Instance.NodeConfig node_config = 7 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        Whether the nodeConfig field is set.

      • getNodeConfig

        Instance.NodeConfig getNodeConfig()
         Required. Configuration for Memcached nodes.
        .google.cloud.memcache.v1.Instance.NodeConfig node_config = 7 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The nodeConfig.

      • getNodeConfigOrBuilder

        Instance.NodeConfigOrBuilder getNodeConfigOrBuilder()
         Required. Configuration for Memcached nodes.
        .google.cloud.memcache.v1.Instance.NodeConfig node_config = 7 [(.google.api.field_behavior) = REQUIRED];

      • getMemcacheVersionValue

        int getMemcacheVersionValue()
         The major version of Memcached software.
 If not provided, latest supported version will be used. Currently the
 latest supported major version is `MEMCACHE_1_5`.
 The minor version will be automatically determined by our system based on
 the latest supported minor version.
        .google.cloud.memcache.v1.MemcacheVersion memcache_version = 9;
        Returns:
        The enum numeric value on the wire for memcacheVersion.

      • getMemcacheVersion

        MemcacheVersion getMemcacheVersion()
         The major version of Memcached software.
 If not provided, latest supported version will be used. Currently the
 latest supported major version is `MEMCACHE_1_5`.
 The minor version will be automatically determined by our system based on
 the latest supported minor version.
        .google.cloud.memcache.v1.MemcacheVersion memcache_version = 9;
        Returns:
        The memcacheVersion.

      • hasParameters

        boolean hasParameters()
         User defined parameters to apply to the memcached process
 on each node.
        .google.cloud.memcache.v1.MemcacheParameters parameters = 11;
        Returns:
        Whether the parameters field is set.

      • getParameters

        MemcacheParameters getParameters()
         User defined parameters to apply to the memcached process
 on each node.
        .google.cloud.memcache.v1.MemcacheParameters parameters = 11;
        Returns:
        The parameters.

      • getParametersOrBuilder

        MemcacheParametersOrBuilder getParametersOrBuilder()
         User defined parameters to apply to the memcached process
 on each node.
        .google.cloud.memcache.v1.MemcacheParameters parameters = 11;

      • getMemcacheNodesList

        List<Instance.Node> getMemcacheNodesList()
         Output only. List of Memcached nodes.
 Refer to [Node][google.cloud.memcache.v1.Instance.Node] message for more details.
        repeated .google.cloud.memcache.v1.Instance.Node memcache_nodes = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getMemcacheNodes

        Instance.Node getMemcacheNodes​(int index)
         Output only. List of Memcached nodes.
 Refer to [Node][google.cloud.memcache.v1.Instance.Node] message for more details.
        repeated .google.cloud.memcache.v1.Instance.Node memcache_nodes = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getMemcacheNodesCount

        int getMemcacheNodesCount()
         Output only. List of Memcached nodes.
 Refer to [Node][google.cloud.memcache.v1.Instance.Node] message for more details.
        repeated .google.cloud.memcache.v1.Instance.Node memcache_nodes = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getMemcacheNodesOrBuilderList

        List<? extends Instance.NodeOrBuilder> getMemcacheNodesOrBuilderList()
         Output only. List of Memcached nodes.
 Refer to [Node][google.cloud.memcache.v1.Instance.Node] message for more details.
        repeated .google.cloud.memcache.v1.Instance.Node memcache_nodes = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getMemcacheNodesOrBuilder

        Instance.NodeOrBuilder getMemcacheNodesOrBuilder​(int index)
         Output only. List of Memcached nodes.
 Refer to [Node][google.cloud.memcache.v1.Instance.Node] message for more details.
        repeated .google.cloud.memcache.v1.Instance.Node memcache_nodes = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasCreateTime

        boolean hasCreateTime()
         Output only. The time the instance was created.
        .google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. The time the instance was created.
        .google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time the instance was created.
        .google.protobuf.Timestamp create_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • hasUpdateTime

        boolean hasUpdateTime()
         Output only. The time the instance was updated.
        .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        com.google.protobuf.Timestamp getUpdateTime()
         Output only. The time the instance was updated.
        .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. The time the instance was updated.
        .google.protobuf.Timestamp update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getStateValue

        int getStateValue()
         Output only. The state of this Memcached instance.
        .google.cloud.memcache.v1.Instance.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for state.

      • getState

        Instance.State getState()
         Output only. The state of this Memcached instance.
        .google.cloud.memcache.v1.Instance.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The state.

      • getMemcacheFullVersion

        String getMemcacheFullVersion()
         Output only. The full version of memcached server running on this instance.
 System automatically determines the full memcached version for an instance
 based on the input MemcacheVersion.
 The full version format will be "memcached-1.5.16".
        string memcache_full_version = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The memcacheFullVersion.

      • getMemcacheFullVersionBytes

        com.google.protobuf.ByteString getMemcacheFullVersionBytes()
         Output only. The full version of memcached server running on this instance.
 System automatically determines the full memcached version for an instance
 based on the input MemcacheVersion.
 The full version format will be "memcached-1.5.16".
        string memcache_full_version = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for memcacheFullVersion.

      • getInstanceMessagesList

        List<Instance.InstanceMessage> getInstanceMessagesList()
         List of messages that describe the current state of the Memcached instance.
        repeated .google.cloud.memcache.v1.Instance.InstanceMessage instance_messages = 19;

      • getInstanceMessages

        Instance.InstanceMessage getInstanceMessages​(int index)
         List of messages that describe the current state of the Memcached instance.
        repeated .google.cloud.memcache.v1.Instance.InstanceMessage instance_messages = 19;

      • getInstanceMessagesCount

        int getInstanceMessagesCount()
         List of messages that describe the current state of the Memcached instance.
        repeated .google.cloud.memcache.v1.Instance.InstanceMessage instance_messages = 19;

      • getInstanceMessagesOrBuilderList

        List<? extends Instance.InstanceMessageOrBuilder> getInstanceMessagesOrBuilderList()
         List of messages that describe the current state of the Memcached instance.
        repeated .google.cloud.memcache.v1.Instance.InstanceMessage instance_messages = 19;

      • getInstanceMessagesOrBuilder

        Instance.InstanceMessageOrBuilder getInstanceMessagesOrBuilder​(int index)
         List of messages that describe the current state of the Memcached instance.
        repeated .google.cloud.memcache.v1.Instance.InstanceMessage instance_messages = 19;

      • getDiscoveryEndpoint

        String getDiscoveryEndpoint()
         Output only. Endpoint for the Discovery API.
        string discovery_endpoint = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The discoveryEndpoint.

      • getDiscoveryEndpointBytes

        com.google.protobuf.ByteString getDiscoveryEndpointBytes()
         Output only. Endpoint for the Discovery API.
        string discovery_endpoint = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for discoveryEndpoint.

      • hasMaintenancePolicy

        boolean hasMaintenancePolicy()
         The maintenance policy for the instance. If not provided,
 the maintenance event will be performed based on Memorystore
 internal rollout schedule.
        .google.cloud.memcache.v1.MaintenancePolicy maintenance_policy = 21;
        Returns:
        Whether the maintenancePolicy field is set.

      • getMaintenancePolicy

        MaintenancePolicy getMaintenancePolicy()
         The maintenance policy for the instance. If not provided,
 the maintenance event will be performed based on Memorystore
 internal rollout schedule.
        .google.cloud.memcache.v1.MaintenancePolicy maintenance_policy = 21;
        Returns:
        The maintenancePolicy.

      • getMaintenancePolicyOrBuilder

        MaintenancePolicyOrBuilder getMaintenancePolicyOrBuilder()
         The maintenance policy for the instance. If not provided,
 the maintenance event will be performed based on Memorystore
 internal rollout schedule.
        .google.cloud.memcache.v1.MaintenancePolicy maintenance_policy = 21;

      • hasMaintenanceSchedule

        boolean hasMaintenanceSchedule()
         Output only. Published maintenance schedule.
        .google.cloud.memcache.v1.MaintenanceSchedule maintenance_schedule = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the maintenanceSchedule field is set.

      • getMaintenanceSchedule

        MaintenanceSchedule getMaintenanceSchedule()
         Output only. Published maintenance schedule.
        .google.cloud.memcache.v1.MaintenanceSchedule maintenance_schedule = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The maintenanceSchedule.

      • getMaintenanceScheduleOrBuilder

        MaintenanceScheduleOrBuilder getMaintenanceScheduleOrBuilder()
         Output only. Published maintenance schedule.
        .google.cloud.memcache.v1.MaintenanceSchedule maintenance_schedule = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];