Class: Google::Cloud::DiscoveryEngine::V1::Project

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

Overview

Metadata and configurations for a Google Cloud project in the service.

Defined Under Namespace

Classes: ServiceTerms, ServiceTermsMapEntry

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp when this project is created.

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/discoveryengine/v1/project.rb', line 43

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

  # Metadata about the terms of service.
  # @!attribute [rw] id
  #   @return [::String]
  #     The unique identifier of this terms of service.
  #     Available terms:
  #
  #     * `GA_DATA_USE_TERMS`: [Terms for data
  #     use](https://cloud.google.com/retail/data-use-terms). When using this as
  #     `id`, the acceptable
  #     {::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms#version version}
  #     to provide is `2022-11-23`.
  # @!attribute [rw] version
  #   @return [::String]
  #     The version string of the terms of service.
  #     For acceptable values, see the comments for
  #     {::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms#id id} above.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms::State]
  #     Whether the project has accepted/rejected the service terms or it is
  #     still pending.
  # @!attribute [rw] accept_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time when the project agreed to the terms of service.
  # @!attribute [rw] decline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time when the project declined or revoked the agreement to terms
  #     of service.
  class ServiceTerms
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The agreement states this terms of service.
    module State
      # The default value of the enum. This value is not actually used.
      STATE_UNSPECIFIED = 0

      # The project has given consent to the terms of service.
      TERMS_ACCEPTED = 1

      # The project is pending to review and accept the terms of service.
      TERMS_PENDING = 2

      # The project has declined or revoked the agreement to terms of service.
      TERMS_DECLINED = 3
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms]
  class ServiceTermsMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Full resource name of the project, for example projects/{project}. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.

Returns:

  • (::String) —

    Output only. Full resource name of the project, for example projects/{project}. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/discoveryengine/v1/project.rb', line 43

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

  # Metadata about the terms of service.
  # @!attribute [rw] id
  #   @return [::String]
  #     The unique identifier of this terms of service.
  #     Available terms:
  #
  #     * `GA_DATA_USE_TERMS`: [Terms for data
  #     use](https://cloud.google.com/retail/data-use-terms). When using this as
  #     `id`, the acceptable
  #     {::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms#version version}
  #     to provide is `2022-11-23`.
  # @!attribute [rw] version
  #   @return [::String]
  #     The version string of the terms of service.
  #     For acceptable values, see the comments for
  #     {::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms#id id} above.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms::State]
  #     Whether the project has accepted/rejected the service terms or it is
  #     still pending.
  # @!attribute [rw] accept_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time when the project agreed to the terms of service.
  # @!attribute [rw] decline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time when the project declined or revoked the agreement to terms
  #     of service.
  class ServiceTerms
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The agreement states this terms of service.
    module State
      # The default value of the enum. This value is not actually used.
      STATE_UNSPECIFIED = 0

      # The project has given consent to the terms of service.
      TERMS_ACCEPTED = 1

      # The project is pending to review and accept the terms of service.
      TERMS_PENDING = 2

      # The project has declined or revoked the agreement to terms of service.
      TERMS_DECLINED = 3
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms]
  class ServiceTermsMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#provision_completion_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/discoveryengine/v1/project.rb', line 43

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

  # Metadata about the terms of service.
  # @!attribute [rw] id
  #   @return [::String]
  #     The unique identifier of this terms of service.
  #     Available terms:
  #
  #     * `GA_DATA_USE_TERMS`: [Terms for data
  #     use](https://cloud.google.com/retail/data-use-terms). When using this as
  #     `id`, the acceptable
  #     {::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms#version version}
  #     to provide is `2022-11-23`.
  # @!attribute [rw] version
  #   @return [::String]
  #     The version string of the terms of service.
  #     For acceptable values, see the comments for
  #     {::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms#id id} above.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms::State]
  #     Whether the project has accepted/rejected the service terms or it is
  #     still pending.
  # @!attribute [rw] accept_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time when the project agreed to the terms of service.
  # @!attribute [rw] decline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time when the project declined or revoked the agreement to terms
  #     of service.
  class ServiceTerms
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The agreement states this terms of service.
    module State
      # The default value of the enum. This value is not actually used.
      STATE_UNSPECIFIED = 0

      # The project has given consent to the terms of service.
      TERMS_ACCEPTED = 1

      # The project is pending to review and accept the terms of service.
      TERMS_PENDING = 2

      # The project has declined or revoked the agreement to terms of service.
      TERMS_DECLINED = 3
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms]
  class ServiceTermsMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service_terms_map ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms} (readonly)

Returns Output only. A map of terms of services. The key is the id of ServiceTerms.

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'proto_docs/google/cloud/discoveryengine/v1/project.rb', line 43

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

  # Metadata about the terms of service.
  # @!attribute [rw] id
  #   @return [::String]
  #     The unique identifier of this terms of service.
  #     Available terms:
  #
  #     * `GA_DATA_USE_TERMS`: [Terms for data
  #     use](https://cloud.google.com/retail/data-use-terms). When using this as
  #     `id`, the acceptable
  #     {::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms#version version}
  #     to provide is `2022-11-23`.
  # @!attribute [rw] version
  #   @return [::String]
  #     The version string of the terms of service.
  #     For acceptable values, see the comments for
  #     {::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms#id id} above.
  # @!attribute [rw] state
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms::State]
  #     Whether the project has accepted/rejected the service terms or it is
  #     still pending.
  # @!attribute [rw] accept_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time when the project agreed to the terms of service.
  # @!attribute [rw] decline_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The last time when the project declined or revoked the agreement to terms
  #     of service.
  class ServiceTerms
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The agreement states this terms of service.
    module State
      # The default value of the enum. This value is not actually used.
      STATE_UNSPECIFIED = 0

      # The project has given consent to the terms of service.
      TERMS_ACCEPTED = 1

      # The project is pending to review and accept the terms of service.
      TERMS_PENDING = 2

      # The project has declined or revoked the agreement to terms of service.
      TERMS_DECLINED = 3
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms]
  class ServiceTermsMapEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end