0
# Entry Metadata Management
1

2
Management of entry overview information, contacts, and starring functionality for organizing and maintaining entry metadata beyond basic properties.
3

4
## Capabilities
5

6
### Entry Overview Management
7

8
Manage high-level overview information for entries including business context and descriptive metadata.
9

10
```python { .api }
11
def modify_entry_overview(
12
    self,
13
    request: ModifyEntryOverviewRequest = None,
14
    *,
15
    name: str = None,
16
    entry_overview: EntryOverview = None,
17
    **kwargs
18
) -> EntryOverview:
19
    """
20
    Modify the overview information of an entry.
21

22
    Args:
23
        request: The request object
24
        name: str - Required. Format: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}
25
        entry_overview: EntryOverview - Required. Updated overview information
26

27
    Returns:
28
        EntryOverview: The updated entry overview
29

30
    Raises:
31
        google.api_core.exceptions.NotFound: Entry not found
32
        google.api_core.exceptions.InvalidArgument: Invalid overview data
33
    """
34
```
35

36
### Entry Contacts Management
37

38
Manage contact information for entries, including individuals and groups responsible for the data asset.
39

40
```python { .api }
41
def modify_entry_contacts(
42
    self,
43
    request: ModifyEntryContactsRequest = None,
44
    *,
45
    name: str = None,
46
    contacts: Contacts = None,
47
    **kwargs
48
) -> Contacts:
49
    """
50
    Modify the contacts of an entry.
51

52
    Args:
53
        request: The request object
54
        name: str - Required. Format: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}
55
        contacts: Contacts - Required. Updated contact information
56

57
    Returns:
58
        Contacts: The updated contacts
59

60
    Raises:
61
        google.api_core.exceptions.NotFound: Entry not found
62
        google.api_core.exceptions.InvalidArgument: Invalid contact data
63
    """
64
```
65

66
### Entry Starring
67

68
Star and unstar entries to mark them as important or frequently accessed resources.
69

70
```python { .api }
71
def star_entry(
72
    self,
73
    request: StarEntryRequest = None,
74
    *,
75
    name: str = None,
76
    **kwargs
77
) -> StarEntryResponse:
78
    """
79
    Mark an entry as starred by the current user.
80

81
    Args:
82
        request: The request object
83
        name: str - Required. Format: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}
84

85
    Returns:
86
        StarEntryResponse: Empty response indicating success
87

88
    Raises:
89
        google.api_core.exceptions.NotFound: Entry not found
90
    """
91

92
def unstar_entry(
93
    self,
94
    request: UnstarEntryRequest = None,
95
    *,
96
    name: str = None,
97
    **kwargs
98
) -> UnstarEntryResponse:
99
    """
100
    Remove a star from an entry.
101

102
    Args:
103
        request: The request object
104
        name: str - Required. Format: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}
105

106
    Returns:
107
        UnstarEntryResponse: Empty response indicating success
108

109
    Raises:
110
        google.api_core.exceptions.NotFound: Entry not found
111
    """
112
```
113

114
**Usage Example:**
115

116
```python
117
from google.cloud import datacatalog_v1
118

119
client = datacatalog_v1.DataCatalogClient()
120

121
entry_name = "projects/my-project/locations/us-central1/entryGroups/customer-data/entries/customer-table"
122

123
# Update entry overview
124
overview = datacatalog_v1.EntryOverview(
125
    overview="This table contains customer master data including contact information, "
126
             "preferences, and account details. Updated daily from the CRM system."
127
)
128

129
modify_overview_request = datacatalog_v1.ModifyEntryOverviewRequest(
130
    name=entry_name,
131
    entry_overview=overview
132
)
133

134
updated_overview = client.modify_entry_overview(request=modify_overview_request)
135

136
# Update entry contacts
137
contacts = datacatalog_v1.Contacts(
138
    people=[
139
        datacatalog_v1.Contacts.Person(
140
            designation="Data Owner",
141
            email="data-owner@company.com"
142
        ),
143
        datacatalog_v1.Contacts.Person(
144
            designation="Data Steward", 
145
            email="data-steward@company.com"
146
        )
147
    ]
148
)
149

150
modify_contacts_request = datacatalog_v1.ModifyEntryContactsRequest(
151
    name=entry_name,
152
    contacts=contacts
153
)
154

155
updated_contacts = client.modify_entry_contacts(request=modify_contacts_request)
156

157
# Star the entry
158
star_request = datacatalog_v1.StarEntryRequest(name=entry_name)
159
client.star_entry(request=star_request)
160

161
print("Entry metadata updated successfully")
162
```
163

164
## Request Types
165

166
```python { .api }
167
class ModifyEntryOverviewRequest:
168
    name: str  # Required entry name
169
    entry_overview: EntryOverview  # Required updated overview
170

171
class ModifyEntryContactsRequest:
172
    name: str  # Required entry name  
173
    contacts: Contacts  # Required updated contacts
174

175
class StarEntryRequest:
176
    name: str  # Required entry name
177

178
class UnstarEntryRequest:
179
    name: str  # Required entry name
180
```
181

182
## Response Types
183

184
```python { .api }
185
class StarEntryResponse:
186
    """Empty response for successful star operation."""
187
    pass
188

189
class UnstarEntryResponse:
190
    """Empty response for successful unstar operation."""
191
    pass
192
```
193

194
## Core Types
195

196
```python { .api }
197
class EntryOverview:
198
    overview: str  # Optional overview text providing business context and description
199

200
class Contacts:
201
    people: Sequence[Person]  # List of contact persons
202

203
    class Person:
204
        designation: str  # Optional role designation (e.g., "Data Owner", "Data Steward")
205
        email: str  # Optional email address
206

207
class BusinessContext:
208
    entry_overview: EntryOverview  # Optional entry overview
209
    contacts: Contacts  # Optional contacts information
210
```