Package com.google.cloud.datafusion.v1beta1

Interface InstanceOrBuilder

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

  • Method Details

    • getName

      String getName()
       Output only. The name of this instance is in the form of
 projects/{project}/locations/{location}/instances/{instance}.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. The name of this instance is in the form of
 projects/{project}/locations/{location}/instances/{instance}.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for name.

    • getDescription

      String getDescription()
       A description of this instance.
      string description = 2;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       A description of this instance.
      string description = 2;
      Returns:
      The bytes for description.

    • getTypeValue

      int getTypeValue()
       Required. Instance type.
      .google.cloud.datafusion.v1beta1.Instance.Type type = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for type.

    • getType

      Instance.Type getType()
       Required. Instance type.
      .google.cloud.datafusion.v1beta1.Instance.Type type = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The type.

    • getEnableStackdriverLogging

      boolean getEnableStackdriverLogging()
       Option to enable Stackdriver Logging.
      bool enable_stackdriver_logging = 4;
      Returns:
      The enableStackdriverLogging.

    • getEnableStackdriverMonitoring

      boolean getEnableStackdriverMonitoring()
       Option to enable Stackdriver Monitoring.
      bool enable_stackdriver_monitoring = 5;
      Returns:
      The enableStackdriverMonitoring.

    • getPrivateInstance

      boolean getPrivateInstance()
       Specifies whether the Data Fusion instance should be private. If set to
 true, all Data Fusion nodes will have private IP addresses and will not be
 able to access the public internet.
      bool private_instance = 6;
      Returns:
      The privateInstance.

    • hasNetworkConfig

      boolean hasNetworkConfig()
       Network configuration options. These are required when a private Data
 Fusion instance is to be created.
      .google.cloud.datafusion.v1beta1.NetworkConfig network_config = 7;
      Returns:
      Whether the networkConfig field is set.

    • getNetworkConfig

      NetworkConfig getNetworkConfig()
       Network configuration options. These are required when a private Data
 Fusion instance is to be created.
      .google.cloud.datafusion.v1beta1.NetworkConfig network_config = 7;
      Returns:
      The networkConfig.

    • getNetworkConfigOrBuilder

      NetworkConfigOrBuilder getNetworkConfigOrBuilder()
       Network configuration options. These are required when a private Data
 Fusion instance is to be created.
      .google.cloud.datafusion.v1beta1.NetworkConfig network_config = 7;

    • getLabelsCount

      int getLabelsCount()
       The resource labels for instance to use to annotate any related underlying
 resources such as Compute Engine VMs. The character '=' is not allowed to
 be used within the labels.
      map<string, string> labels = 8;

    • containsLabels

      boolean containsLabels(String key)
       The resource labels for instance to use to annotate any related underlying
 resources such as Compute Engine VMs. The character '=' is not allowed to
 be used within the labels.
      map<string, string> labels = 8;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       The resource labels for instance to use to annotate any related underlying
 resources such as Compute Engine VMs. The character '=' is not allowed to
 be used within the labels.
      map<string, string> labels = 8;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       The resource labels for instance to use to annotate any related underlying
 resources such as Compute Engine VMs. The character '=' is not allowed to
 be used within the labels.
      map<string, string> labels = 8;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       The resource labels for instance to use to annotate any related underlying
 resources such as Compute Engine VMs. The character '=' is not allowed to
 be used within the labels.
      map<string, string> labels = 8;

    • getOptionsCount

      int getOptionsCount()
       Map of additional options used to configure the behavior of
 Data Fusion instance.
      map<string, string> options = 9;

    • containsOptions

      boolean containsOptions(String key)
       Map of additional options used to configure the behavior of
 Data Fusion instance.
      map<string, string> options = 9;

    • getOptions

      @Deprecated Map<String,String> getOptions()
      Deprecated.
      Use getOptionsMap() instead.

    • getOptionsMap

      Map<String,String> getOptionsMap()
       Map of additional options used to configure the behavior of
 Data Fusion instance.
      map<string, string> options = 9;

    • getOptionsOrDefault

      String getOptionsOrDefault(String key, String defaultValue)
       Map of additional options used to configure the behavior of
 Data Fusion instance.
      map<string, string> options = 9;

    • getOptionsOrThrow

      String getOptionsOrThrow(String key)
       Map of additional options used to configure the behavior of
 Data Fusion instance.
      map<string, string> options = 9;

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The time the instance was created.
      .google.protobuf.Timestamp create_time = 10 [(.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 = 10 [(.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 = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The time the instance was last updated.
      .google.protobuf.Timestamp update_time = 11 [(.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 last updated.
      .google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

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

    • getStateValue

      int getStateValue()
       Output only. The current state of this Data Fusion instance.
      .google.cloud.datafusion.v1beta1.Instance.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Instance.State getState()
       Output only. The current state of this Data Fusion instance.
      .google.cloud.datafusion.v1beta1.Instance.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • getStateMessage

      String getStateMessage()
       Output only. Additional information about the current state of this Data
 Fusion instance if available.
      string state_message = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The stateMessage.

    • getStateMessageBytes

      com.google.protobuf.ByteString getStateMessageBytes()
       Output only. Additional information about the current state of this Data
 Fusion instance if available.
      string state_message = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for stateMessage.

    • getServiceEndpoint

      String getServiceEndpoint()
       Output only. Endpoint on which the Data Fusion UI is accessible.
      string service_endpoint = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The serviceEndpoint.

    • getServiceEndpointBytes

      com.google.protobuf.ByteString getServiceEndpointBytes()
       Output only. Endpoint on which the Data Fusion UI is accessible.
      string service_endpoint = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for serviceEndpoint.

    • getZone

      String getZone()
       Name of the zone in which the Data Fusion instance will be created. Only
 DEVELOPER instances use this field.
      string zone = 15;
      Returns:
      The zone.

    • getZoneBytes

      com.google.protobuf.ByteString getZoneBytes()
       Name of the zone in which the Data Fusion instance will be created. Only
 DEVELOPER instances use this field.
      string zone = 15;
      Returns:
      The bytes for zone.

    • getVersion

      String getVersion()
       Current version of Data Fusion.
      string version = 16;
      Returns:
      The version.

    • getVersionBytes

      com.google.protobuf.ByteString getVersionBytes()
       Current version of Data Fusion.
      string version = 16;
      Returns:
      The bytes for version.

    • getServiceAccount

      @Deprecated String getServiceAccount()
      Deprecated.
      google.cloud.datafusion.v1beta1.Instance.service_account is deprecated. See google/cloud/datafusion/v1beta1/v1beta1.proto;l=392
       Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.
      string service_account = 17 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The serviceAccount.

    • getServiceAccountBytes

      @Deprecated com.google.protobuf.ByteString getServiceAccountBytes()
      Deprecated.
      google.cloud.datafusion.v1beta1.Instance.service_account is deprecated. See google/cloud/datafusion/v1beta1/v1beta1.proto;l=392
       Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID.
      string service_account = 17 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for serviceAccount.

    • getDisplayName

      String getDisplayName()
       Display name for an instance.
      string display_name = 18;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Display name for an instance.
      string display_name = 18;
      Returns:
      The bytes for displayName.

    • getAvailableVersionList

      List<Version> getAvailableVersionList()
       Available versions that the instance can be upgraded to using
 UpdateInstanceRequest.
      repeated .google.cloud.datafusion.v1beta1.Version available_version = 19;

    • getAvailableVersion

      Version getAvailableVersion(int index)
       Available versions that the instance can be upgraded to using
 UpdateInstanceRequest.
      repeated .google.cloud.datafusion.v1beta1.Version available_version = 19;

    • getAvailableVersionCount

      int getAvailableVersionCount()
       Available versions that the instance can be upgraded to using
 UpdateInstanceRequest.
      repeated .google.cloud.datafusion.v1beta1.Version available_version = 19;

    • getAvailableVersionOrBuilderList

      List<? extends VersionOrBuilder> getAvailableVersionOrBuilderList()
       Available versions that the instance can be upgraded to using
 UpdateInstanceRequest.
      repeated .google.cloud.datafusion.v1beta1.Version available_version = 19;

    • getAvailableVersionOrBuilder

      VersionOrBuilder getAvailableVersionOrBuilder(int index)
       Available versions that the instance can be upgraded to using
 UpdateInstanceRequest.
      repeated .google.cloud.datafusion.v1beta1.Version available_version = 19;

    • getApiEndpoint

      String getApiEndpoint()
       Output only. Endpoint on which the REST APIs is accessible.
      string api_endpoint = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The apiEndpoint.

    • getApiEndpointBytes

      com.google.protobuf.ByteString getApiEndpointBytes()
       Output only. Endpoint on which the REST APIs is accessible.
      string api_endpoint = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for apiEndpoint.

    • getGcsBucket

      String getGcsBucket()
       Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
      string gcs_bucket = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The gcsBucket.

    • getGcsBucketBytes

      com.google.protobuf.ByteString getGcsBucketBytes()
       Output only. Cloud Storage bucket generated by Data Fusion in the customer project.
      string gcs_bucket = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for gcsBucket.

    • getAcceleratorsList

      List<Accelerator> getAcceleratorsList()
       List of accelerators enabled for this CDF instance.
      repeated .google.cloud.datafusion.v1beta1.Accelerator accelerators = 22;

    • getAccelerators

      Accelerator getAccelerators(int index)
       List of accelerators enabled for this CDF instance.
      repeated .google.cloud.datafusion.v1beta1.Accelerator accelerators = 22;

    • getAcceleratorsCount

      int getAcceleratorsCount()
       List of accelerators enabled for this CDF instance.
      repeated .google.cloud.datafusion.v1beta1.Accelerator accelerators = 22;

    • getAcceleratorsOrBuilderList

      List<? extends AcceleratorOrBuilder> getAcceleratorsOrBuilderList()
       List of accelerators enabled for this CDF instance.
      repeated .google.cloud.datafusion.v1beta1.Accelerator accelerators = 22;

    • getAcceleratorsOrBuilder

      AcceleratorOrBuilder getAcceleratorsOrBuilder(int index)
       List of accelerators enabled for this CDF instance.
      repeated .google.cloud.datafusion.v1beta1.Accelerator accelerators = 22;

    • getP4ServiceAccount

      String getP4ServiceAccount()
       Output only. P4 service account for the customer project.
      string p4_service_account = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The p4ServiceAccount.

    • getP4ServiceAccountBytes

      com.google.protobuf.ByteString getP4ServiceAccountBytes()
       Output only. P4 service account for the customer project.
      string p4_service_account = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for p4ServiceAccount.

    • getTenantProjectId

      String getTenantProjectId()
       Output only. The name of the tenant project.
      string tenant_project_id = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The tenantProjectId.

    • getTenantProjectIdBytes

      com.google.protobuf.ByteString getTenantProjectIdBytes()
       Output only. The name of the tenant project.
      string tenant_project_id = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for tenantProjectId.

    • getDataprocServiceAccount

      String getDataprocServiceAccount()
       User-managed service account to set on Dataproc when Cloud Data Fusion
 creates Dataproc to run data processing pipelines.

 This allows users to have fine-grained access control on Dataproc's
 accesses to cloud resources.
      string dataproc_service_account = 25;
      Returns:
      The dataprocServiceAccount.

    • getDataprocServiceAccountBytes

      com.google.protobuf.ByteString getDataprocServiceAccountBytes()
       User-managed service account to set on Dataproc when Cloud Data Fusion
 creates Dataproc to run data processing pipelines.

 This allows users to have fine-grained access control on Dataproc's
 accesses to cloud resources.
      string dataproc_service_account = 25;
      Returns:
      The bytes for dataprocServiceAccount.

    • getEnableRbac

      boolean getEnableRbac()
       Option to enable granular role-based access control.
      bool enable_rbac = 26;
      Returns:
      The enableRbac.

    • hasCryptoKeyConfig

      boolean hasCryptoKeyConfig()
       The crypto key configuration. This field is used by the Customer-Managed
 Encryption Keys (CMEK) feature.
      .google.cloud.datafusion.v1beta1.CryptoKeyConfig crypto_key_config = 27;
      Returns:
      Whether the cryptoKeyConfig field is set.

    • getCryptoKeyConfig

      CryptoKeyConfig getCryptoKeyConfig()
       The crypto key configuration. This field is used by the Customer-Managed
 Encryption Keys (CMEK) feature.
      .google.cloud.datafusion.v1beta1.CryptoKeyConfig crypto_key_config = 27;
      Returns:
      The cryptoKeyConfig.

    • getCryptoKeyConfigOrBuilder

      CryptoKeyConfigOrBuilder getCryptoKeyConfigOrBuilder()
       The crypto key configuration. This field is used by the Customer-Managed
 Encryption Keys (CMEK) feature.
      .google.cloud.datafusion.v1beta1.CryptoKeyConfig crypto_key_config = 27;

    • getDisabledReasonList

      List<Instance.DisabledReason> getDisabledReasonList()
       Output only. If the instance state is DISABLED, the reason for disabling the instance.
      repeated .google.cloud.datafusion.v1beta1.Instance.DisabledReason disabled_reason = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the disabledReason.

    • getDisabledReasonCount

      int getDisabledReasonCount()
       Output only. If the instance state is DISABLED, the reason for disabling the instance.
      repeated .google.cloud.datafusion.v1beta1.Instance.DisabledReason disabled_reason = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The count of disabledReason.

    • getDisabledReason

      Instance.DisabledReason getDisabledReason(int index)
       Output only. If the instance state is DISABLED, the reason for disabling the instance.
      repeated .google.cloud.datafusion.v1beta1.Instance.DisabledReason disabled_reason = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the element to return.
      Returns:
      The disabledReason at the given index.

    • getDisabledReasonValueList

      List<Integer> getDisabledReasonValueList()
       Output only. If the instance state is DISABLED, the reason for disabling the instance.
      repeated .google.cloud.datafusion.v1beta1.Instance.DisabledReason disabled_reason = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      A list containing the enum numeric values on the wire for disabledReason.

    • getDisabledReasonValue

      int getDisabledReasonValue(int index)
       Output only. If the instance state is DISABLED, the reason for disabling the instance.
      repeated .google.cloud.datafusion.v1beta1.Instance.DisabledReason disabled_reason = 28 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of disabledReason at the given index.