Class: Google::Cloud::CloudDMS::V1::DescribeDatabaseEntitiesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/clouddms/v1/clouddms.rb

Overview

Request message for 'DescribeDatabaseEntities' request.

Defined Under Namespace

Modules: DBTreeType

Instance Attribute Summary collapse

Instance Attribute Details

#commit_id ⇒ ::String

Returns Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned.

Returns:

  • (::String) —

    Optional. Request a specific commit ID. If not specified, the entities from the latest commit are returned.



952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms.rb', line 952

class DescribeDatabaseEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of a tree to return
  module DBTreeType
    # Unspecified tree type.
    DB_TREE_TYPE_UNSPECIFIED = 0

    # The source database tree.
    SOURCE_TREE = 1

    # The draft database tree.
    DRAFT_TREE = 2

    # The destination database tree.
    DESTINATION_TREE = 3
  end
end

#conversion_workspace ⇒ ::String

Returns Required. Name of the conversion workspace resource whose database entities are described. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.

Returns:

  • (::String) —

    Required. Name of the conversion workspace resource whose database entities are described. Must be in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.



952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms.rb', line 952

class DescribeDatabaseEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of a tree to return
  module DBTreeType
    # Unspecified tree type.
    DB_TREE_TYPE_UNSPECIFIED = 0

    # The source database tree.
    SOURCE_TREE = 1

    # The draft database tree.
    DRAFT_TREE = 2

    # The destination database tree.
    DESTINATION_TREE = 3
  end
end

#filter ⇒ ::String

Returns Optional. Filter the returned entities based on AIP-160 standard.

Returns:

  • (::String) —

    Optional. Filter the returned entities based on AIP-160 standard.



952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms.rb', line 952

class DescribeDatabaseEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of a tree to return
  module DBTreeType
    # Unspecified tree type.
    DB_TREE_TYPE_UNSPECIFIED = 0

    # The source database tree.
    SOURCE_TREE = 1

    # The draft database tree.
    DRAFT_TREE = 2

    # The destination database tree.
    DESTINATION_TREE = 3
  end
end

#page_size ⇒ ::Integer

Returns Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies.

Returns:

  • (::Integer) —

    Optional. The maximum number of entities to return. The service may return fewer entities than the value specifies.



952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms.rb', line 952

class DescribeDatabaseEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of a tree to return
  module DBTreeType
    # Unspecified tree type.
    DB_TREE_TYPE_UNSPECIFIED = 0

    # The source database tree.
    SOURCE_TREE = 1

    # The draft database tree.
    DRAFT_TREE = 2

    # The destination database tree.
    DESTINATION_TREE = 3
  end
end

#page_token ⇒ ::String

Returns Optional. The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token.

Returns:

  • (::String) —

    Optional. The nextPageToken value received in the previous call to conversionWorkspace.describeDatabaseEntities, used in the subsequent request to retrieve the next page of results. On first call this should be left blank. When paginating, all other parameters provided to conversionWorkspace.describeDatabaseEntities must match the call that provided the page token.



952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms.rb', line 952

class DescribeDatabaseEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of a tree to return
  module DBTreeType
    # Unspecified tree type.
    DB_TREE_TYPE_UNSPECIFIED = 0

    # The source database tree.
    SOURCE_TREE = 1

    # The draft database tree.
    DRAFT_TREE = 2

    # The destination database tree.
    DESTINATION_TREE = 3
  end
end

#tree ⇒ ::Google::Cloud::CloudDMS::V1::DescribeDatabaseEntitiesRequest::DBTreeType

Returns Required. The tree to fetch.

Returns:



952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms.rb', line 952

class DescribeDatabaseEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of a tree to return
  module DBTreeType
    # Unspecified tree type.
    DB_TREE_TYPE_UNSPECIFIED = 0

    # The source database tree.
    SOURCE_TREE = 1

    # The draft database tree.
    DRAFT_TREE = 2

    # The destination database tree.
    DESTINATION_TREE = 3
  end
end

#uncommitted ⇒ ::Boolean

Returns Optional. Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified.

Returns:

  • (::Boolean) —

    Optional. Whether to retrieve the latest committed version of the entities or the latest version. This field is ignored if a specific commit_id is specified.



952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms.rb', line 952

class DescribeDatabaseEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of a tree to return
  module DBTreeType
    # Unspecified tree type.
    DB_TREE_TYPE_UNSPECIFIED = 0

    # The source database tree.
    SOURCE_TREE = 1

    # The draft database tree.
    DRAFT_TREE = 2

    # The destination database tree.
    DESTINATION_TREE = 3
  end
end

#view ⇒ ::Google::Cloud::CloudDMS::V1::DatabaseEntityView

Returns Optional. Results view based on AIP-157.

Returns:



952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
 
# File 'proto_docs/google/cloud/clouddms/v1/clouddms.rb', line 952

class DescribeDatabaseEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of a tree to return
  module DBTreeType
    # Unspecified tree type.
    DB_TREE_TYPE_UNSPECIFIED = 0

    # The source database tree.
    SOURCE_TREE = 1

    # The draft database tree.
    DRAFT_TREE = 2

    # The destination database tree.
    DESTINATION_TREE = 3
  end
end